org.pfsw.logging

Interface Logger

All Known Implementing Classes:

AbstractLogger, DeferredInitializationLoggerAdapter, InMemoryLogger, Logger2Logger, NilLogger, PrintStreamLogger

public interface Logger

A simple interface for all necessary logging functions. Different kinds of logging components like log4j or JLog or java.util.logging can be wrapped in an implementation that supports this interface. So programming against this interface means, to stay independent of the underlying logging component.

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	ANONYMOUS_LOGGER_NAME
static java.lang.String	LL_DEBUG This is the log level string representation for DEBUG
static java.lang.String	LL_ERROR This is the log level string representation for ERROR
static java.lang.String	LL_INFO This is the log level string representation for INFO
static java.lang.String	LL_NONE This is the log level string representation for NONE
static java.lang.String	LL_WARNING This is the log level string representation for WARNING

Method Summary

Modifier and Type	Method and Description
java.lang.String	getName() Returns the name of this logger.
void	initialize(java.util.Properties properties) Initialize the logger from the given properties settings.
boolean	isLoggingDebugs() Returns true, if debug messages will be written to the output device(s).
boolean	isLoggingErrors() Returns true, if errors will be written to the output device(s).
boolean	isLoggingInfos() Returns true, if info messages will be written to the output device(s).
boolean	isLoggingWarnings() Returns true, if warnings will be written to the output device(s).
void	logDebug(java.lang.String message, java.lang.Object... params) If the logging level is DEBUG the given message will be written to the log output device(s).
void	logError(java.lang.String message, java.lang.Object... params) If the logging level is DEBUG, INFO, WARNING or ERROR the given message will be written to the log output device(s).
void	logError(java.lang.String message, java.lang.Throwable exception) If the logging level is DEBUG, INFO, WARNING or ERROR the given message and the exception will be written to the log output device(s).
void	logException(java.lang.Throwable ex) Writes the given exception to the log output device(s).
void	logInfo(java.lang.String message, java.lang.Object... params) If the logging level is INFO or DEBUG the given message will be written to the log output device(s).
void	logWarning(java.lang.String message, java.lang.Object... params) If the logging level is DEBUG, INFO or WARNING the given message will be written to the log output device(s).
void	logWarning(java.lang.String message, java.lang.Throwable exception) If the logging level is DEBUG, INFO or WARNING the given message and the exception will be written to the log output device(s).
boolean	setLogLevel(java.lang.String logLevel) Changes the log level to the specified level.

Field Detail

ANONYMOUS_LOGGER_NAME

static final java.lang.String ANONYMOUS_LOGGER_NAME

See Also:

Constant Field Values

LL_NONE

static final java.lang.String LL_NONE

This is the log level string representation for NONE

See Also:

Constant Field Values

LL_ERROR

static final java.lang.String LL_ERROR

This is the log level string representation for ERROR

See Also:

Constant Field Values

LL_WARNING

static final java.lang.String LL_WARNING

This is the log level string representation for WARNING

See Also:

Constant Field Values

LL_INFO

static final java.lang.String LL_INFO

This is the log level string representation for INFO

See Also:

Constant Field Values

LL_DEBUG

static final java.lang.String LL_DEBUG

This is the log level string representation for DEBUG

See Also:

Constant Field Values

Method Detail

getName

java.lang.String getName()

Returns the name of this logger. The returned name might be an empty string, but never null.

initialize

void initialize(java.util.Properties properties)

Initialize the logger from the given properties settings.

logException

void logException(java.lang.Throwable ex)

Writes the given exception to the log output device(s). The log level will be ignored.

logDebug

void logDebug(java.lang.String message,
              java.lang.Object... params)

If the logging level is DEBUG the given message will be written to the log output device(s).

Parameters:

message - The message to log. It may contain placeholders like {0}, {1} etc.

params - Optional parameters to be used for replacing placeholders in the message text.

logInfo

void logInfo(java.lang.String message,
             java.lang.Object... params)

If the logging level is INFO or DEBUG the given message will be written to the log output device(s).

Parameters:

message - The message to log. It may contain placeholders like {0}, {1} etc.

params - Optional parameters to be used for replacing placeholders in the message text.

logWarning

void logWarning(java.lang.String message,
                java.lang.Object... params)

If the logging level is DEBUG, INFO or WARNING the given message will be written to the log output device(s).

Parameters:

message - The message to log. It may contain placeholders like {0}, {1} etc.

params - Optional parameters to be used for replacing placeholders in the message text.

logError

void logError(java.lang.String message,
              java.lang.Object... params)

If the logging level is DEBUG, INFO, WARNING or ERROR the given message will be written to the log output device(s).

Parameters:

message - The message to log. It may contain placeholders like {0}, {1} etc.

params - Optional parameters to be used for replacing placeholders in the message text.

logWarning

void logWarning(java.lang.String message,
                java.lang.Throwable exception)

If the logging level is DEBUG, INFO or WARNING the given message and the exception will be written to the log output device(s).

logError

void logError(java.lang.String message,
              java.lang.Throwable exception)

If the logging level is DEBUG, INFO, WARNING or ERROR the given message and the exception will be written to the log output device(s).

isLoggingDebugs

boolean isLoggingDebugs()

Returns true, if debug messages will be written to the output device(s).

isLoggingInfos

boolean isLoggingInfos()

Returns true, if info messages will be written to the output device(s).

isLoggingWarnings

boolean isLoggingWarnings()

Returns true, if warnings will be written to the output device(s).

isLoggingErrors

boolean isLoggingErrors()

Returns true, if errors will be written to the output device(s).

setLogLevel

boolean setLogLevel(java.lang.String logLevel)

Changes the log level to the specified level. Returns true if the level is supported and was set, otherwise false.

Parameters:

logLevel - One of the LL_ constants defined in this interface (e.g. LL_ERROR).