org.tinylog.provider

Class NopLoggingProvider

java.lang.Object

org.tinylog.provider.NopLoggingProvider

All Implemented Interfaces:

LoggingProvider

public final class NopLoggingProvider
extends Object
implements LoggingProvider

Logging provider implementation that does nothing. All log entries will be ignored.

Constructor Summary

Constructors

Constructor and Description
NopLoggingProvider()

Method Summary

Modifier and Type	Method and Description
ContextProvider	getContextProvider() Returns the corresponding context provider.
Level	getMinimumLevel() Gets the lowest activated severity level for all tags.
Level	getMinimumLevel(String tag) Gets the lowest activated severity level for a tag.
boolean	isEnabled(int depth, String tag, Level level) Checks whether log entries with given tag and severity level will be output.
boolean	isEnabled(String loggerClassName, String tag, Level level) Checks whether log entries, issued by the caller of the given logger class, with given tag and severity level will be output.
void	log(int depth, String tag, Level level, Throwable exception, MessageFormatter formatter, Object obj, Object... arguments) Provides a regular log entry.
void	log(String loggerClassName, String tag, Level level, Throwable exception, MessageFormatter formatter, Object obj, Object... arguments) Provides a regular log entry.
void	shutdown() Shuts down the logging provider and frees all allocated resources.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NopLoggingProvider

public NopLoggingProvider()

Method Detail

getContextProvider

public ContextProvider getContextProvider()

Description copied from interface: LoggingProvider

Returns the corresponding context provider.

Specified by:

getContextProvider in interface LoggingProvider

Returns:

Corresponding context provider

getMinimumLevel

public Level getMinimumLevel()

Description copied from interface: LoggingProvider

Gets the lowest activated severity level for all tags.

The result of this method is cacheable and can be used to stop processing log entries at an early stage, before doing any expensive operations. All lower severity levels than the returned level will be never output. But it is not guaranteed the returned severity level or higher will be really output (for example if output depends on package or class name).

Specified by:

getMinimumLevel in interface LoggingProvider

Returns:

Lowest activated severity level

getMinimumLevel

public Level getMinimumLevel(String tag)

Description copied from interface: LoggingProvider

Gets the lowest activated severity level for a tag.

The result of this method is cacheable and can be used to stop processing log entries at an early stage, before doing any expensive operations. All lower severity levels than the returned level will be never output. But it is not guaranteed the returned severity level or higher will be really output (for example if output depends on package or class name).

Specified by:

getMinimumLevel in interface LoggingProvider

Parameters:

tag - Tag to check (can be null)

Returns:

Lowest activated severity level

isEnabled

public boolean isEnabled(int depth,
                         String tag,
                         Level level)

Description copied from interface: LoggingProvider

Checks whether log entries with given tag and severity level will be output.

Specified by:

isEnabled in interface LoggingProvider

Parameters:

depth - Depth of caller in stack trace (e.g. '1' if there is only one method between caller and this method in the stack trace)

tag - Tag to check (can be null)

level - Severity level to check

Returns:

true if given severity level is enabled, false if disabled

isEnabled

public boolean isEnabled(String loggerClassName,
                         String tag,
                         Level level)

Description copied from interface: LoggingProvider

Checks whether log entries, issued by the caller of the given logger class, with given tag and severity level will be output.

Specified by:

isEnabled in interface LoggingProvider

Parameters:

loggerClassName - Fully-qualified class name of the logger instance

tag - Tag to check (can be null)

level - Severity level to check

Returns:

true if given severity level is enabled, false if disabled

log

public void log(int depth,
                String tag,
                Level level,
                Throwable exception,
                MessageFormatter formatter,
                Object obj,
                Object... arguments)

Description copied from interface: LoggingProvider

Provides a regular log entry.

Specified by:

log in interface LoggingProvider

Parameters:

depth - Depth of caller in stack trace (e.g. '1' if there is only one method between caller and this method in the stack trace)

tag - Tag of log entry or null if untagged

level - Severity level of log entry

exception - Exception to log or null

formatter - Formatter for text message, only required if there are any arguments to insert

obj - Message to log or null

arguments - Arguments for message or null

log

public void log(String loggerClassName,
                String tag,
                Level level,
                Throwable exception,
                MessageFormatter formatter,
                Object obj,
                Object... arguments)

Description copied from interface: LoggingProvider

Provides a regular log entry.

Specified by:

log in interface LoggingProvider

Parameters:

loggerClassName - Fully-qualified class name of the logger instance

tag - Tag of log entry or null if untagged

level - Severity level of log entry

exception - Exception to log or null

formatter - Formatter for text message, only required if there are any arguments to insert

obj - Message to log or null

arguments - Arguments for message or null

shutdown

public void shutdown()

Description copied from interface: LoggingProvider

Shuts down the logging provider and frees all allocated resources. This method should be called only if auto shutdown is explicitly disabled.

Specified by:

shutdown in interface LoggingProvider