de.holisticon.util.tracee.contextlogger.builder.ConfigBuilder Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of tracee-context-logger-impl Show documentation

Please refer to https://github.com/holisticon/tracee.

The newest version!

package de.holisticon.util.tracee.contextlogger.builder;

import de.holisticon.util.tracee.contextlogger.profile.Profile;

/**
 * Interface for manual overrides. (Enabling / Disabling of certain logger context data)
 * Used to enable fluent API.
 * Created by Tobias Gindler on 28.03.14.
 */
public interface ConfigBuilder {

    /**
     * Enforces profile for a single log statement.
     * @param profile the profile to use
     * @return this instance
     */
    ConfigBuilder enforceProfile(Profile profile);

    /**
     * Manually enables context data output for a single log statement.
     * @param contexts The context data to be enabled.
     * @return This instance
     */
    ConfigBuilder enable(String... contexts);

    /**
     * Manually disables context data output for a single log statement.
     * @param contexts The context data to be disabled.
     * @return This instance
     */
    ConfigBuilder disable(String... contexts);

    /**
     * Closes configuration.
     * @return This instance cast as a ContextLoggerBuilder.
     */
    ContextLoggerBuilder apply();

}