Class LoggerConfiguration

java.lang.Object

org.springframework.boot.logging.LoggerConfiguration

public final class LoggerConfiguration
extends Object

Immutable class that represents the configuration of a LoggingSystem's logger.

Since:

1.5.0

Author:

Ben Hale, Phillip Webb

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	LoggerConfiguration.ConfigurationScope	Supported logger configuration scopes.
static final class	LoggerConfiguration.LevelConfiguration	Logger level configuration.

Constructor Summary

Constructors

Constructor	Description
LoggerConfiguration(String name, @Nullable LogLevel configuredLevel, LogLevel effectiveLevel)	Create a new instance.
LoggerConfiguration(String name, @Nullable LoggerConfiguration.LevelConfiguration levelConfiguration, LoggerConfiguration.LevelConfiguration inheritedLevelConfiguration)	Create a new instance.

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object obj)
@Nullable LogLevel	getConfiguredLevel()	Returns the configured level of the logger.
LogLevel	getEffectiveLevel()	Returns the effective level of the logger.
LoggerConfiguration.LevelConfiguration	getLevelConfiguration()	Return the level configuration, considering inherited loggers.
@Nullable LoggerConfiguration.LevelConfiguration	getLevelConfiguration(LoggerConfiguration.ConfigurationScope scope)	Return the level configuration for the given scope.
String	getName()	Returns the name of the logger.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Details

LoggerConfiguration

public LoggerConfiguration(String name,
 @Nullable LogLevel configuredLevel,
 LogLevel effectiveLevel)

Create a new instance.

Parameters:

name - the name of the logger

configuredLevel - the configured level of the logger

effectiveLevel - the effective level of the logger

LoggerConfiguration

public LoggerConfiguration(String name,
 @Nullable LoggerConfiguration.LevelConfiguration levelConfiguration,
 LoggerConfiguration.LevelConfiguration inheritedLevelConfiguration)

Create a new instance.

Parameters:

name - the name of the logger

levelConfiguration - the level configuration

inheritedLevelConfiguration - the inherited level configuration

Since:

2.7.13

Method Details

getName

public String getName()

Returns the name of the logger.

Returns:

the name of the logger

getConfiguredLevel

public @Nullable LogLevel getConfiguredLevel()

Returns the configured level of the logger.

Returns:

the configured level of the logger

See Also:

• getLevelConfiguration(ConfigurationScope)

getEffectiveLevel

public LogLevel getEffectiveLevel()

Returns the effective level of the logger.

Returns:

the effective level of the logger

See Also:

• getLevelConfiguration(ConfigurationScope)

getLevelConfiguration

public LoggerConfiguration.LevelConfiguration getLevelConfiguration()

Return the level configuration, considering inherited loggers.

Returns:

the level configuration

Since:

2.7.13

getLevelConfiguration

public @Nullable LoggerConfiguration.LevelConfiguration getLevelConfiguration(LoggerConfiguration.ConfigurationScope scope)

Return the level configuration for the given scope.

Parameters:

scope - the configuration scope

Returns:

the level configuration or null for direct scope results without applied configuration

Since:

2.7.13

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object