io.clogr

Interface LoggingConcern

All Superinterfaces:

io.csar.Concern

public interface LoggingConcern
extends io.csar.Concern

The concern for retrieving loggers.

Author:

Garret Wilson

See Also:

Csar

Field Summary

Fields

Modifier and Type	Field and Description
static LoggingConcern	DEFAULT Default logging concern that essentially does nothing more than delegate to the default SLF4J configuration.

Method Summary

Modifier and Type	Method and Description
default Class<LoggingConcern>	getConcernType()
default org.slf4j.Logger	getLogger(Class<?> contextClass) Returns an appropriate logger for the given context.
org.slf4j.ILoggerFactory	getLoggerFactory()
default org.slf4j.Logger	getRootLogger() Retrieves root logger of the underlying logging system.
default void	setLogLevel(org.slf4j.event.Level level) Sets the log level of the root logger.
void	setLogLevel(org.slf4j.Logger logger, org.slf4j.event.Level level) Sets the log level of a particular logger.

Field Detail

DEFAULT

static final LoggingConcern DEFAULT

Default logging concern that essentially does nothing more than delegate to the default SLF4J configuration.

Retrieving a logger from this logger concern's getLogger(Class) is equivalent to calling LoggerFactory.getLogger(Class).

This logging concern does not support setting the log level.

See Also:

LoggerFactory.getILoggerFactory()

Method Detail

getConcernType

default Class<LoggingConcern> getConcernType()

Specified by:

getConcernType in interface io.csar.Concern

getLoggerFactory

@Nonnull
org.slf4j.ILoggerFactory getLoggerFactory()

Returns:

The logger factory configured for this logging concern.

getLogger

@Nonnull
default org.slf4j.Logger getLogger(@Nonnull
                                             Class<?> contextClass)

Returns an appropriate logger for the given context.

The default implementation delegates to ILoggerFactory.getLogger(String) using the name of the context class as the logger name.

Parameters:

contextClass - The context for which logging is to be performed.

Returns:

A logger instance to use with the given context class.

Throws:

NullPointerException - if the given context class is null.

See Also:

getLoggerFactory()

getRootLogger

@Nonnull
default org.slf4j.Logger getRootLogger()

Retrieves root logger of the underlying logging system.

Returns:

The root logger.

See Also:

getLoggerFactory(), Logger.ROOT_LOGGER_NAME

setLogLevel

void setLogLevel(@Nonnull
                 org.slf4j.Logger logger,
                 @Nonnull
                 org.slf4j.event.Level level)

Sets the log level of a particular logger.

Parameters:

logger - The logger for which the log level should be set.

level - The minimum logging level for which messages should be logged.

setLogLevel

default void setLogLevel(@Nonnull
                         org.slf4j.event.Level level)

Sets the log level of the root logger.

Parameters:

level - The minimum logging level for which messages should be logged.

See Also:

getRootLogger(), setLogLevel(Logger, Level)