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()
• getMarkers()
• getKeyValuePairs()
• 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 and Description
LoggingEvent(org.slf4j.event.Level level, Map<String,String> mdc, org.slf4j.Marker marker, String message, Object... arguments)
LoggingEvent(org.slf4j.event.Level level, Map<String,String> mdc, org.slf4j.Marker marker, Throwable throwable, String message, Object... arguments)
LoggingEvent(org.slf4j.event.Level level, Map<String,String> mdc, String message, Object... arguments)
LoggingEvent(org.slf4j.event.Level level, Map<String,String> mdc, Throwable throwable, String message, Object... arguments)
LoggingEvent(org.slf4j.event.Level level, org.slf4j.Marker marker, String message, Object... arguments)
LoggingEvent(org.slf4j.event.Level level, org.slf4j.Marker marker, Throwable throwable, String message, Object... arguments)
LoggingEvent(org.slf4j.event.Level level, String message, Object... arguments)
LoggingEvent(org.slf4j.event.Level level, Throwable throwable, String message, Object... arguments)

Method Summary

Modifier and Type	Method and Description
static LoggingEvent	debug(Map<String,String> mdc, org.slf4j.Marker marker, String message, Object... arguments)
static LoggingEvent	debug(Map<String,String> mdc, org.slf4j.Marker marker, 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(org.slf4j.Marker marker, String message, Object... arguments)
static LoggingEvent	debug(org.slf4j.Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	debug(String message, Object... arguments)
static LoggingEvent	debug(Throwable throwable, String message, Object... arguments)
boolean	equals(Object o)
static LoggingEvent	error(Map<String,String> mdc, org.slf4j.Marker marker, String message, Object... arguments)
static LoggingEvent	error(Map<String,String> mdc, org.slf4j.Marker marker, 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(org.slf4j.Marker marker, String message, Object... arguments)
static LoggingEvent	error(org.slf4j.Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	error(String message, Object... arguments)
static LoggingEvent	error(Throwable throwable, String message, Object... arguments)
static LoggingEvent	fromSlf4jEvent(org.slf4j.event.LoggingEvent event) Create a LoggingEvent from an SLF4J LoggingEvent.
static LoggingEvent	fromSlf4jEvent(org.slf4j.event.LoggingEvent event, Map<String,String> mdc) Create a LoggingEvent with an MDC from an SLF4J LoggingEvent.
List<Object>	getArguments() Get the arguments to the event.
TestLogger	getCreatingLogger()
String	getFormattedMessage()
List<org.slf4j.event.KeyValuePair>	getKeyValuePairs() Get the key/value pairs of the event.
org.slf4j.event.Level	getLevel()
Optional<org.slf4j.Marker>	getMarker() Deprecated. As events created using the SLF4J fluent API can contain multiple markers, this method is deprecated in favor of getMarkers().
List<org.slf4j.Marker>	getMarkers() Get the markers of the event.
SortedMap<String,String>	getMdc() Get the MDC of the event.
String	getMessage()
ClassLoader	getThreadContextClassLoader()
String	getThreadName()
Optional<Throwable>	getThrowable()
Instant	getTimestamp()
int	hashCode()
static LoggingEvent	info(Map<String,String> mdc, org.slf4j.Marker marker, String message, Object... arguments)
static LoggingEvent	info(Map<String,String> mdc, org.slf4j.Marker marker, 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(org.slf4j.Marker marker, String message, Object... arguments)
static LoggingEvent	info(org.slf4j.Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	info(String message, Object... arguments)
static LoggingEvent	info(Throwable throwable, String message, Object... arguments)
String	toString()
static LoggingEvent	trace(Map<String,String> mdc, org.slf4j.Marker marker, String message, Object... arguments)
static LoggingEvent	trace(Map<String,String> mdc, org.slf4j.Marker marker, 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(org.slf4j.Marker marker, String message, Object... arguments)
static LoggingEvent	trace(org.slf4j.Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	trace(String message, Object... arguments)
static LoggingEvent	trace(Throwable throwable, String message, Object... arguments)
static LoggingEvent	warn(Map<String,String> mdc, org.slf4j.Marker marker, String message, Object... arguments)
static LoggingEvent	warn(Map<String,String> mdc, org.slf4j.Marker marker, 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(org.slf4j.Marker marker, String message, Object... arguments)
static LoggingEvent	warn(org.slf4j.Marker marker, Throwable throwable, String message, Object... arguments)
static LoggingEvent	warn(String message, Object... arguments)
static LoggingEvent	warn(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(org.slf4j.event.Level level,
                    String message,
                    Object... arguments)

LoggingEvent

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

LoggingEvent

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

LoggingEvent

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

LoggingEvent

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

LoggingEvent

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

LoggingEvent

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

LoggingEvent

public LoggingEvent(org.slf4j.event.Level level,
                    Map<String,String> mdc,
                    org.slf4j.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(org.slf4j.Marker marker,
                                 String message,
                                 Object... arguments)

trace

public static LoggingEvent trace(org.slf4j.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,
                                 org.slf4j.Marker marker,
                                 String message,
                                 Object... arguments)

trace

public static LoggingEvent trace(Map<String,String> mdc,
                                 org.slf4j.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(org.slf4j.Marker marker,
                                 String message,
                                 Object... arguments)

debug

public static LoggingEvent debug(org.slf4j.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,
                                 org.slf4j.Marker marker,
                                 String message,
                                 Object... arguments)

debug

public static LoggingEvent debug(Map<String,String> mdc,
                                 org.slf4j.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(org.slf4j.Marker marker,
                                String message,
                                Object... arguments)

info

public static LoggingEvent info(org.slf4j.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,
                                org.slf4j.Marker marker,
                                String message,
                                Object... arguments)

info

public static LoggingEvent info(Map<String,String> mdc,
                                org.slf4j.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(org.slf4j.Marker marker,
                                String message,
                                Object... arguments)

warn

public static LoggingEvent warn(org.slf4j.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,
                                org.slf4j.Marker marker,
                                String message,
                                Object... arguments)

warn

public static LoggingEvent warn(Map<String,String> mdc,
                                org.slf4j.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(org.slf4j.Marker marker,
                                 String message,
                                 Object... arguments)

error

public static LoggingEvent error(org.slf4j.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,
                                 org.slf4j.Marker marker,
                                 String message,
                                 Object... arguments)

error

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

fromSlf4jEvent

public static LoggingEvent fromSlf4jEvent(org.slf4j.event.LoggingEvent event)

Create a LoggingEvent from an SLF4J LoggingEvent.

Since:

3.0.0

fromSlf4jEvent

public static LoggingEvent fromSlf4jEvent(org.slf4j.event.LoggingEvent event,
                                          Map<String,String> mdc)

Create a LoggingEvent with an MDC from an SLF4J LoggingEvent.

Since:

3.0.0

getLevel

public org.slf4j.event.Level getLevel()

getMdc

public SortedMap<String,String> getMdc()

Get the MDC of the event. For events created by TestLogger, this is an unmodifiable copy of the MDC of the thread when the event was created. For events constructed directly, this is unmodifiable copy of the MDC passed to the constructor, if any. If no MDC was used for construction, the copy is an empty map. The copy is a SortedMap, in order to make it easier to spot discrepancies in case an assertion fails. Natural ordering of the keys is used.

getMarker

@Deprecated
public Optional<org.slf4j.Marker> getMarker()

Deprecated. As events created using the SLF4J fluent API can contain multiple markers, this method is deprecated in favor of getMarkers().

Get the marker of the event.

Throws:

IllegalStateException - if the event has more than one marker.

getMarkers

public List<org.slf4j.Marker> getMarkers()

Get the markers of the event. If the event has no markers, an empty list is returned.

Returns:

an unmodifiable copy of the markers when the event was created.

Since:

3.0.0

getKeyValuePairs

public List<org.slf4j.event.KeyValuePair> getKeyValuePairs()

Get the key/value pairs of the event. If the event has no key/value pairs, an empty list is returned.

Returns:

an unmodifiable copy of the key/value pairs when the event was created.

Since:

3.0.0

getMessage

public String getMessage()

getArguments

public List<Object> getArguments()

Get the arguments to the event.

Returns:

an unmodifiable copy of the arguments when the event was created.

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