Package com.github.valfirst.slf4jtest

Class LoggingEvent

java.lang.Object

com.github.valfirst.slf4jtest.LoggingEvent

public class LoggingEvent
extends Object

Representation of a call to a logger for test assertion purposes. The contract of equals(Object) and hashCode() is that they compare the results of:

• getLevel()
• getMdc()
• getMarker()
• getThrowable()
• getMessage()
• getArguments()

They do NOT compare the results of getTimestamp(), getCreatingLogger() or getThreadContextClassLoader() as this would render it impractical to create appropriate expected LoggingEvents to compare against.

Constructors and convenient static factory methods exist to create LoggingEvents with appropriate defaults. These are not documented further as they should be self-evident.

Constructor Summary

Constructors

Constructor	Description
LoggingEvent(Level level, String message, Object... arguments)
LoggingEvent(Level level, Throwable throwable, String message, Object... arguments)
LoggingEvent(Level level, Map<String,String> mdc, String message, Object... arguments)
LoggingEvent(Level level, Map<String,String> mdc, Throwable throwable, String message, Object... arguments)
LoggingEvent(Level level, Map<String,String> mdc, Marker marker, String message, Object... arguments)
LoggingEvent(Level level, Map<String,String> mdc, Marker marker, Throwable throwable, String message, Object... arguments)
LoggingEvent(Level level, Marker marker, String message, Object... arguments)
LoggingEvent(Level level, Marker marker, Throwable throwable, String message, Object... arguments)

Method Summary

Modifier and Type	Method	Description
static LoggingEvent	debug(String message, Object... arguments)
static LoggingEvent	debug(Throwable throwable, String message, Object... arguments)
static LoggingEvent	debug(Map<String,String> mdc, String message, Object... arguments)
static LoggingEvent	debug(Map<String,String> mdc, Throwable throwable, String message, Object... arguments)
static LoggingEvent	debug(Map<String,String> mdc, Marker marker, String message, Object... arguments)
static LoggingEvent	debug(Map<String,String> mdc, Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	debug(Marker marker, String message, Object... arguments)
static LoggingEvent	debug(Marker marker, Throwable throwable, String message, Object... arguments)
boolean	equals(Object o)
static LoggingEvent	error(String message, Object... arguments)
static LoggingEvent	error(Throwable throwable, String message, Object... arguments)
static LoggingEvent	error(Map<String,String> mdc, String message, Object... arguments)
static LoggingEvent	error(Map<String,String> mdc, Throwable throwable, String message, Object... arguments)
static LoggingEvent	error(Map<String,String> mdc, Marker marker, String message, Object... arguments)
static LoggingEvent	error(Map<String,String> mdc, Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	error(Marker marker, String message, Object... arguments)
static LoggingEvent	error(Marker marker, Throwable throwable, String message, Object... arguments)
com.google.common.collect.ImmutableList<Object>	getArguments()
TestLogger	getCreatingLogger()
String	getFormattedMessage()
Level	getLevel()
Optional<Marker>	getMarker()
com.google.common.collect.ImmutableMap<String,String>	getMdc()
String	getMessage()
ClassLoader	getThreadContextClassLoader()
String	getThreadName()
Optional<Throwable>	getThrowable()
org.joda.time.Instant	getTimestamp()
int	hashCode()
static LoggingEvent	info(String message, Object... arguments)
static LoggingEvent	info(Throwable throwable, String message, Object... arguments)
static LoggingEvent	info(Map<String,String> mdc, String message, Object... arguments)
static LoggingEvent	info(Map<String,String> mdc, Throwable throwable, String message, Object... arguments)
static LoggingEvent	info(Map<String,String> mdc, Marker marker, String message, Object... arguments)
static LoggingEvent	info(Map<String,String> mdc, Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	info(Marker marker, String message, Object... arguments)
static LoggingEvent	info(Marker marker, Throwable throwable, String message, Object... arguments)
String	toString()
static LoggingEvent	trace(String message, Object... arguments)
static LoggingEvent	trace(Throwable throwable, String message, Object... arguments)
static LoggingEvent	trace(Map<String,String> mdc, String message, Object... arguments)
static LoggingEvent	trace(Map<String,String> mdc, Throwable throwable, String message, Object... arguments)
static LoggingEvent	trace(Map<String,String> mdc, Marker marker, String message, Object... arguments)
static LoggingEvent	trace(Map<String,String> mdc, Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	trace(Marker marker, String message, Object... arguments)
static LoggingEvent	trace(Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	warn(String message, Object... arguments)
static LoggingEvent	warn(Throwable throwable, String message, Object... arguments)
static LoggingEvent	warn(Map<String,String> mdc, String message, Object... arguments)
static LoggingEvent	warn(Map<String,String> mdc, Throwable throwable, String message, Object... arguments)
static LoggingEvent	warn(Map<String,String> mdc, Marker marker, String message, Object... arguments)
static LoggingEvent	warn(Map<String,String> mdc, Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	warn(Marker marker, String message, Object... arguments)
static LoggingEvent	warn(Marker marker, Throwable throwable, String message, Object... arguments)

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

LoggingEvent

public LoggingEvent(Level level,
                    String message,
                    Object... arguments)

LoggingEvent

public LoggingEvent(Level level,
                    Throwable throwable,
                    String message,
                    Object... arguments)

LoggingEvent

public LoggingEvent(Level level,
                    Marker marker,
                    String message,
                    Object... arguments)

LoggingEvent

public LoggingEvent(Level level,
                    Marker marker,
                    Throwable throwable,
                    String message,
                    Object... arguments)

LoggingEvent

public LoggingEvent(Level level,
                    Map<String,String> mdc,
                    String message,
                    Object... arguments)

LoggingEvent

public LoggingEvent(Level level,
                    Map<String,String> mdc,
                    Throwable throwable,
                    String message,
                    Object... arguments)

LoggingEvent

public LoggingEvent(Level level,
                    Map<String,String> mdc,
                    Marker marker,
                    String message,
                    Object... arguments)

LoggingEvent

public LoggingEvent(Level level,
                    Map<String,String> mdc,
                    Marker marker,
                    Throwable throwable,
                    String message,
                    Object... arguments)

Method Detail

trace

public static LoggingEvent trace(String message,
                                 Object... arguments)

trace

public static LoggingEvent trace(Throwable throwable,
                                 String message,
                                 Object... arguments)

trace

public static LoggingEvent trace(Marker marker,
                                 String message,
                                 Object... arguments)

trace

public static LoggingEvent trace(Marker marker,
                                 Throwable throwable,
                                 String message,
                                 Object... arguments)

trace

public static LoggingEvent trace(Map<String,String> mdc,
                                 String message,
                                 Object... arguments)

trace

public static LoggingEvent trace(Map<String,String> mdc,
                                 Throwable throwable,
                                 String message,
                                 Object... arguments)

trace

public static LoggingEvent trace(Map<String,String> mdc,
                                 Marker marker,
                                 String message,
                                 Object... arguments)

trace

public static LoggingEvent trace(Map<String,String> mdc,
                                 Marker marker,
                                 Throwable throwable,
                                 String message,
                                 Object... arguments)

debug

public static LoggingEvent debug(String message,
                                 Object... arguments)

debug

public static LoggingEvent debug(Throwable throwable,
                                 String message,
                                 Object... arguments)

debug

public static LoggingEvent debug(Marker marker,
                                 String message,
                                 Object... arguments)

debug

public static LoggingEvent debug(Marker marker,
                                 Throwable throwable,
                                 String message,
                                 Object... arguments)

debug

public static LoggingEvent debug(Map<String,String> mdc,
                                 String message,
                                 Object... arguments)

debug

public static LoggingEvent debug(Map<String,String> mdc,
                                 Throwable throwable,
                                 String message,
                                 Object... arguments)

debug

public static LoggingEvent debug(Map<String,String> mdc,
                                 Marker marker,
                                 String message,
                                 Object... arguments)

debug

public static LoggingEvent debug(Map<String,String> mdc,
                                 Marker marker,
                                 Throwable throwable,
                                 String message,
                                 Object... arguments)

info

public static LoggingEvent info(String message,
                                Object... arguments)

info

public static LoggingEvent info(Throwable throwable,
                                String message,
                                Object... arguments)

info

public static LoggingEvent info(Marker marker,
                                String message,
                                Object... arguments)

info

public static LoggingEvent info(Marker marker,
                                Throwable throwable,
                                String message,
                                Object... arguments)

info

public static LoggingEvent info(Map<String,String> mdc,
                                String message,
                                Object... arguments)

info

public static LoggingEvent info(Map<String,String> mdc,
                                Throwable throwable,
                                String message,
                                Object... arguments)

info

public static LoggingEvent info(Map<String,String> mdc,
                                Marker marker,
                                String message,
                                Object... arguments)

info

public static LoggingEvent info(Map<String,String> mdc,
                                Marker marker,
                                Throwable throwable,
                                String message,
                                Object... arguments)

warn

public static LoggingEvent warn(String message,
                                Object... arguments)

warn

public static LoggingEvent warn(Throwable throwable,
                                String message,
                                Object... arguments)

warn

public static LoggingEvent warn(Marker marker,
                                String message,
                                Object... arguments)

warn

public static LoggingEvent warn(Marker marker,
                                Throwable throwable,
                                String message,
                                Object... arguments)

warn

public static LoggingEvent warn(Map<String,String> mdc,
                                String message,
                                Object... arguments)

warn

public static LoggingEvent warn(Map<String,String> mdc,
                                Throwable throwable,
                                String message,
                                Object... arguments)

warn

public static LoggingEvent warn(Map<String,String> mdc,
                                Marker marker,
                                String message,
                                Object... arguments)

warn

public static LoggingEvent warn(Map<String,String> mdc,
                                Marker marker,
                                Throwable throwable,
                                String message,
                                Object... arguments)

error

public static LoggingEvent error(String message,
                                 Object... arguments)

error

public static LoggingEvent error(Throwable throwable,
                                 String message,
                                 Object... arguments)

error

public static LoggingEvent error(Marker marker,
                                 String message,
                                 Object... arguments)

error

public static LoggingEvent error(Marker marker,
                                 Throwable throwable,
                                 String message,
                                 Object... arguments)

error

public static LoggingEvent error(Map<String,String> mdc,
                                 String message,
                                 Object... arguments)

error

public static LoggingEvent error(Map<String,String> mdc,
                                 Throwable throwable,
                                 String message,
                                 Object... arguments)

error

public static LoggingEvent error(Map<String,String> mdc,
                                 Marker marker,
                                 String message,
                                 Object... arguments)

error

public static LoggingEvent error(Map<String,String> mdc,
                                 Marker marker,
                                 Throwable throwable,
                                 String message,
                                 Object... arguments)

getLevel

public Level getLevel()

getMdc

public com.google.common.collect.ImmutableMap<String,String> getMdc()

getMarker

public Optional<Marker> getMarker()

getMessage

public String getMessage()

getArguments

public com.google.common.collect.ImmutableList<Object> getArguments()

getThrowable

public Optional<Throwable> getThrowable()

getCreatingLogger

public TestLogger getCreatingLogger()

Returns:

the logger that created this logging event.

Throws:

IllegalStateException - if this logging event was not created by a logger

getTimestamp

public org.joda.time.Instant getTimestamp()

Returns:

the time at which this logging event was created

getThreadName

public String getThreadName()

Returns:

the name of the thread that created this logging event

getThreadContextClassLoader

public ClassLoader getThreadContextClassLoader()

Returns:

the Thread Context Classloader used when this logging event was created

getFormattedMessage

public String getFormattedMessage()

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object