com.github.valfirst.slf4jtest

Class TestLogger

java.lang.Object

com.github.valfirst.slf4jtest.TestLogger

All Implemented Interfaces:

org.slf4j.Logger, org.slf4j.spi.LoggingEventAware

public class TestLogger
extends Object
implements org.slf4j.Logger, org.slf4j.spi.LoggingEventAware

Implementation of Logger which stores LoggingEvents in memory and provides methods to access and remove them in order to facilitate writing tests that assert particular logging calls were made.

LoggingEvents are stored in both an ThreadLocal and a normal List. The getLoggingEvents() and clear() methods reference the ThreadLocal events. The getAllLoggingEvents() and clearAll() methods reference all events logged on this Logger. This is in order to facilitate parallelising tests - tests that use the thread local methods can be parallelised.

By default all Levels are enabled. It is important to note that the conventional hierarchical notion of Levels, where info being enabled implies warn and error being enabled, is not a requirement of the SLF4J API, so the setEnabledLevels(Collection), setEnabledLevels(Level...), setEnabledLevelsForAllThreads(Collection), setEnabledLevelsForAllThreads(Level...) and the various isXxxxxEnabled() methods make no assumptions about this hierarchy.

Field Summary

Fields inherited from interface org.slf4j.Logger

ROOT_LOGGER_NAME

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all LoggingEvents logged by this thread and resets the enabled levels of the logger to all levels for this thread.
void	clearAll() Removes ALL LoggingEvents logged on this logger, regardless of thread, and resets the enabled levels of the logger to all levels for ALL threads.
void	debug(org.slf4j.Marker marker, String msg)
void	debug(org.slf4j.Marker marker, String format, Object... args)
void	debug(org.slf4j.Marker marker, String format, Object arg)
void	debug(org.slf4j.Marker marker, String format, Object arg1, Object arg2)
void	debug(org.slf4j.Marker marker, String msg, Throwable throwable)
void	debug(String message)
void	debug(String format, Object... args)
void	debug(String format, Object arg)
void	debug(String format, Object arg1, Object arg2)
void	debug(String msg, Throwable throwable)
void	error(org.slf4j.Marker marker, String msg)
void	error(org.slf4j.Marker marker, String format, Object... args)
void	error(org.slf4j.Marker marker, String format, Object arg)
void	error(org.slf4j.Marker marker, String format, Object arg1, Object arg2)
void	error(org.slf4j.Marker marker, String msg, Throwable throwable)
void	error(String message)
void	error(String format, Object... args)
void	error(String format, Object arg)
void	error(String format, Object arg1, Object arg2)
void	error(String msg, Throwable throwable)
List<LoggingEvent>	getAllLoggingEvents() Get all LoggingEvents logged on this logger by ANY thread.
Set<org.slf4j.event.Level>	getEnabledLevels() Get the levels enabled for this logger on this thread.
List<LoggingEvent>	getLoggingEvents() Get all LoggingEvents logged on this logger by this thread.
String	getName()
void	info(org.slf4j.Marker marker, String msg)
void	info(org.slf4j.Marker marker, String format, Object... args)
void	info(org.slf4j.Marker marker, String format, Object arg)
void	info(org.slf4j.Marker marker, String format, Object arg1, Object arg2)
void	info(org.slf4j.Marker marker, String msg, Throwable throwable)
void	info(String message)
void	info(String format, Object... args)
void	info(String format, Object arg)
void	info(String format, Object arg1, Object arg2)
void	info(String msg, Throwable throwable)
boolean	isDebugEnabled()
boolean	isDebugEnabled(org.slf4j.Marker marker)
boolean	isErrorEnabled()
boolean	isErrorEnabled(org.slf4j.Marker marker)
boolean	isInfoEnabled()
boolean	isInfoEnabled(org.slf4j.Marker marker)
boolean	isTraceEnabled()
boolean	isTraceEnabled(org.slf4j.Marker marker)
boolean	isWarnEnabled()
boolean	isWarnEnabled(org.slf4j.Marker marker)
void	log(org.slf4j.event.LoggingEvent event)
org.slf4j.spi.LoggingEventBuilder	makeLoggingEventBuilder(org.slf4j.event.Level level) Make a TestLoggingEventBuilder.
void	setEnabledLevels(Collection<org.slf4j.event.Level> enabledLevels) The conventional hierarchical notion of Levels, where info being enabled implies warn and error being enabled, is not a requirement of the SLF4J API, so all levels you wish to enable must be passed explicitly to this method.
void	setEnabledLevels(org.slf4j.event.Level... enabledLevels) The conventional hierarchical notion of Levels, where info being enabled implies warn and error being enabled, is not a requirement of the SLF4J API, so all levels you wish to enable must be passed explicitly to this method.
void	setEnabledLevelsForAllThreads(Collection<org.slf4j.event.Level> enabledLevelsForAllThreads) The conventional hierarchical notion of Levels, where info being enabled implies warn and error being enabled, is not a requirement of the SLF4J API, so all levels you wish to enable must be passed explicitly to this method.
void	setEnabledLevelsForAllThreads(org.slf4j.event.Level... enabledLevelsForAllThreads) The conventional hierarchical notion of Levels, where info being enabled implies warn and error being enabled, is not a requirement of the SLF4J API, so all levels you wish to enable must be passed explicitly to this method.
void	trace(org.slf4j.Marker marker, String msg)
void	trace(org.slf4j.Marker marker, String format, Object... args)
void	trace(org.slf4j.Marker marker, String format, Object arg)
void	trace(org.slf4j.Marker marker, String format, Object arg1, Object arg2)
void	trace(org.slf4j.Marker marker, String msg, Throwable throwable)
void	trace(String message)
void	trace(String format, Object... args)
void	trace(String format, Object arg)
void	trace(String format, Object arg1, Object arg2)
void	trace(String msg, Throwable throwable)
void	warn(org.slf4j.Marker marker, String msg)
void	warn(org.slf4j.Marker marker, String format, Object... args)
void	warn(org.slf4j.Marker marker, String format, Object arg)
void	warn(org.slf4j.Marker marker, String format, Object arg1, Object arg2)
void	warn(org.slf4j.Marker marker, String msg, Throwable throwable)
void	warn(String message)
void	warn(String format, Object... args)
void	warn(String format, Object arg)
void	warn(String format, Object arg1, Object arg2)
void	warn(String msg, Throwable throwable)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.slf4j.Logger

atDebug, atError, atInfo, atLevel, atTrace, atWarn, isEnabledForLevel

Method Detail

getName

public String getName()

Specified by:

getName in interface org.slf4j.Logger

makeLoggingEventBuilder

public org.slf4j.spi.LoggingEventBuilder makeLoggingEventBuilder(org.slf4j.event.Level level)

Make a TestLoggingEventBuilder.

Specified by:

makeLoggingEventBuilder in interface org.slf4j.Logger

clear

public void clear()

Removes all LoggingEvents logged by this thread and resets the enabled levels of the logger to all levels for this thread.

clearAll

public void clearAll()

Removes ALL LoggingEvents logged on this logger, regardless of thread, and resets the enabled levels of the logger to all levels for ALL threads.

getLoggingEvents

public List<LoggingEvent> getLoggingEvents()

Get all LoggingEvents logged on this logger by this thread.

Returns:

the LoggingEvents as an unmodifiable List.

getAllLoggingEvents

public List<LoggingEvent> getAllLoggingEvents()

Get all LoggingEvents logged on this logger by ANY thread.

Returns:

the LoggingEvents as an unmodifiable List.

isTraceEnabled

public boolean isTraceEnabled()

Specified by:

isTraceEnabled in interface org.slf4j.Logger

Returns:

whether this logger is trace enabled in this thread

trace

public void trace(String message)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(String format,
                  Object arg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(String format,
                  Object arg1,
                  Object arg2)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(String format,
                  Object... args)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(String msg,
                  Throwable throwable)

Specified by:

trace in interface org.slf4j.Logger

isTraceEnabled

public boolean isTraceEnabled(org.slf4j.Marker marker)

Specified by:

isTraceEnabled in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  String msg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  String format,
                  Object arg)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  String format,
                  Object arg1,
                  Object arg2)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  String format,
                  Object... args)

Specified by:

trace in interface org.slf4j.Logger

trace

public void trace(org.slf4j.Marker marker,
                  String msg,
                  Throwable throwable)

Specified by:

trace in interface org.slf4j.Logger

isDebugEnabled

public boolean isDebugEnabled()

Specified by:

isDebugEnabled in interface org.slf4j.Logger

Returns:

whether this logger is debug enabled in this thread

debug

public void debug(String message)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(String format,
                  Object arg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(String format,
                  Object arg1,
                  Object arg2)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(String format,
                  Object... args)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(String msg,
                  Throwable throwable)

Specified by:

debug in interface org.slf4j.Logger

isDebugEnabled

public boolean isDebugEnabled(org.slf4j.Marker marker)

Specified by:

isDebugEnabled in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  String msg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  String format,
                  Object arg)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  String format,
                  Object arg1,
                  Object arg2)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  String format,
                  Object... args)

Specified by:

debug in interface org.slf4j.Logger

debug

public void debug(org.slf4j.Marker marker,
                  String msg,
                  Throwable throwable)

Specified by:

debug in interface org.slf4j.Logger

isInfoEnabled

public boolean isInfoEnabled()

Specified by:

isInfoEnabled in interface org.slf4j.Logger

Returns:

whether this logger is info enabled in this thread

info

public void info(String message)

Specified by:

info in interface org.slf4j.Logger

info

public void info(String format,
                 Object arg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(String format,
                 Object arg1,
                 Object arg2)

Specified by:

info in interface org.slf4j.Logger

info

public void info(String format,
                 Object... args)

Specified by:

info in interface org.slf4j.Logger

info

public void info(String msg,
                 Throwable throwable)

Specified by:

info in interface org.slf4j.Logger

isInfoEnabled

public boolean isInfoEnabled(org.slf4j.Marker marker)

Specified by:

isInfoEnabled in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 String msg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 String format,
                 Object arg)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 String format,
                 Object arg1,
                 Object arg2)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 String format,
                 Object... args)

Specified by:

info in interface org.slf4j.Logger

info

public void info(org.slf4j.Marker marker,
                 String msg,
                 Throwable throwable)

Specified by:

info in interface org.slf4j.Logger

isWarnEnabled

public boolean isWarnEnabled()

Specified by:

isWarnEnabled in interface org.slf4j.Logger

Returns:

whether this logger is warn enabled in this thread

warn

public void warn(String message)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(String format,
                 Object arg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(String format,
                 Object arg1,
                 Object arg2)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(String format,
                 Object... args)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(String msg,
                 Throwable throwable)

Specified by:

warn in interface org.slf4j.Logger

isWarnEnabled

public boolean isWarnEnabled(org.slf4j.Marker marker)

Specified by:

isWarnEnabled in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 String msg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 String format,
                 Object arg)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 String format,
                 Object arg1,
                 Object arg2)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 String format,
                 Object... args)

Specified by:

warn in interface org.slf4j.Logger

warn

public void warn(org.slf4j.Marker marker,
                 String msg,
                 Throwable throwable)

Specified by:

warn in interface org.slf4j.Logger

isErrorEnabled

public boolean isErrorEnabled()

Specified by:

isErrorEnabled in interface org.slf4j.Logger

Returns:

whether this logger is error enabled in this thread

error

public void error(String message)

Specified by:

error in interface org.slf4j.Logger

error

public void error(String format,
                  Object arg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(String format,
                  Object arg1,
                  Object arg2)

Specified by:

error in interface org.slf4j.Logger

error

public void error(String format,
                  Object... args)

Specified by:

error in interface org.slf4j.Logger

error

public void error(String msg,
                  Throwable throwable)

Specified by:

error in interface org.slf4j.Logger

isErrorEnabled

public boolean isErrorEnabled(org.slf4j.Marker marker)

Specified by:

isErrorEnabled in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  String msg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  String format,
                  Object arg)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  String format,
                  Object arg1,
                  Object arg2)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  String format,
                  Object... args)

Specified by:

error in interface org.slf4j.Logger

error

public void error(org.slf4j.Marker marker,
                  String msg,
                  Throwable throwable)

Specified by:

error in interface org.slf4j.Logger

log

public void log(org.slf4j.event.LoggingEvent event)

Specified by:

log in interface org.slf4j.spi.LoggingEventAware

getEnabledLevels

public Set<org.slf4j.event.Level> getEnabledLevels()

Get the levels enabled for this logger on this thread.

Returns:

the set of levels as an unmodifiable Set.

setEnabledLevels

public void setEnabledLevels(Collection<org.slf4j.event.Level> enabledLevels)

The conventional hierarchical notion of Levels, where info being enabled implies warn and error being enabled, is not a requirement of the SLF4J API, so all levels you wish to enable must be passed explicitly to this method.

Parameters:

enabledLevels - levels which will be considered enabled for this logger IN THIS THREAD; does not affect enabled levels for this logger in other threads

setEnabledLevels

public void setEnabledLevels(org.slf4j.event.Level... enabledLevels)

The conventional hierarchical notion of Levels, where info being enabled implies warn and error being enabled, is not a requirement of the SLF4J API, so all levels you wish to enable must be passed explicitly to this method.

Parameters:

enabledLevels - levels which will be considered enabled for this logger IN THIS THREAD; does not affect enabled levels for this logger in other threads

setEnabledLevelsForAllThreads

public void setEnabledLevelsForAllThreads(Collection<org.slf4j.event.Level> enabledLevelsForAllThreads)

The conventional hierarchical notion of Levels, where info being enabled implies warn and error being enabled, is not a requirement of the SLF4J API, so all levels you wish to enable must be passed explicitly to this method.

Parameters:

enabledLevelsForAllThreads - levels which will be considered enabled for this logger IN ALL THREADS

setEnabledLevelsForAllThreads

public void setEnabledLevelsForAllThreads(org.slf4j.event.Level... enabledLevelsForAllThreads)

The conventional hierarchical notion of Levels, where info being enabled implies warn and error being enabled, is not a requirement of the SLF4J API, so all levels you wish to enable must be passed explicitly to this method.

Parameters:

enabledLevelsForAllThreads - levels which will be considered enabled for this logger IN ALL THREADS