org.pfsw.logging.memory

Class InMemoryLogger

java.lang.Object

org.pfsw.logging.internal.AbstractLogger

org.pfsw.logging.memory.InMemoryLogger

All Implemented Interfaces:

Logger

public class InMemoryLogger
extends AbstractLogger

This logger keeps all log output in an internal list on the heap.

This of course is not reasonable for a production system, but could be helpful for unit testing.

Field Summary

Fields inherited from interface org.pfsw.logging.Logger

ANONYMOUS_LOGGER_NAME, LL_DEBUG, LL_ERROR, LL_INFO, LL_NONE, LL_WARNING

Constructor Summary

Constructors

Constructor and Description
InMemoryLogger(java.lang.String loggerName)

Method Summary

Modifier and Type	Method and Description
protected void	add(LogLevel level, java.lang.String message, java.lang.Object... params)
protected void	add(LogLevel level, java.lang.Throwable exception, java.lang.String message, java.lang.Object... params)
void	clear()
java.util.List<LogRecord>	findEntriesContaining(java.lang.String text) Returns a list of all log records with a message that contains the given text.
java.util.List<LogRecord>	getLogEntries()
protected LogLevel	getLogLevel()
void	initialize(java.util.Properties properties) Initialize the logger from the given properties settings.
boolean	isEmpty()
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 exception) 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).
protected void	setLogLevel(LogLevel logLevel)
boolean	setLogLevel(java.lang.String level) Changes the log level to the specified level.
int	size()

Methods inherited from class org.pfsw.logging.internal.AbstractLogger

getLoggerName, getName, isNullOrBlank, isNullOrEmpty, replacePlaceholders, setLoggerName

Methods inherited from class java.lang.Object

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

Constructor Detail

InMemoryLogger

public InMemoryLogger(java.lang.String loggerName)

Method Detail

initialize

public void initialize(java.util.Properties properties)

Description copied from interface: Logger

Initialize the logger from the given properties settings.

isLoggingDebugs

public boolean isLoggingDebugs()

Description copied from interface: Logger

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

isLoggingInfos

public boolean isLoggingInfos()

Description copied from interface: Logger

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

isLoggingWarnings

public boolean isLoggingWarnings()

Description copied from interface: Logger

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

isLoggingErrors

public boolean isLoggingErrors()

Description copied from interface: Logger

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

logDebug

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

Description copied from interface: Logger

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

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

Description copied from interface: Logger

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

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

Description copied from interface: Logger

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.

logWarning

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

Description copied from interface: Logger

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

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

Description copied from interface: Logger

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.

logError

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

Description copied from interface: Logger

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

logException

public void logException(java.lang.Throwable exception)

Description copied from interface: Logger

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

setLogLevel

public boolean setLogLevel(java.lang.String level)

Description copied from interface: Logger

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

Parameters:

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

size

public int size()

isEmpty

public boolean isEmpty()

clear

public void clear()

findEntriesContaining

public java.util.List<LogRecord> findEntriesContaining(java.lang.String text)

Returns a list of all log records with a message that contains the given text.

Parameters:

text - The text to search for (must not be null).

Returns:

A list of found records (never null).

getLogEntries

public java.util.List<LogRecord> getLogEntries()

add

protected void add(LogLevel level,
                   java.lang.String message,
                   java.lang.Object... params)

add

protected void add(LogLevel level,
                   java.lang.Throwable exception,
                   java.lang.String message,
                   java.lang.Object... params)

getLogLevel

protected LogLevel getLogLevel()

setLogLevel

protected void setLogLevel(LogLevel logLevel)