org.tinylog.provider

Interface LoggingProvider

All Known Implementing Classes:

BundleLoggingProvider, NopLoggingProvider

public interface LoggingProvider

API for providing log entries to a concrete logging framework implementation.

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.

Method Detail

getContextProvider

ContextProvider getContextProvider()

Returns the corresponding context provider.

Returns:

Corresponding context provider

getMinimumLevel

Level getMinimumLevel()

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).

Returns:

Lowest activated severity level

getMinimumLevel

Level getMinimumLevel(String tag)

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).

Parameters:

tag - Tag to check (can be null)

Returns:

Lowest activated severity level

isEnabled

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

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

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

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.

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

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

Provides a regular log entry.

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

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

Provides a regular log entry.

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

void shutdown()
       throws InterruptedException

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

Throws:

InterruptedException - Interrupted while waiting for complete shutdown