com.github.valfirst.slf4jtest

Class TestLoggingEventBuilder

java.lang.Object

org.slf4j.spi.DefaultLoggingEventBuilder

com.github.valfirst.slf4jtest.TestLoggingEventBuilder

All Implemented Interfaces:

org.slf4j.spi.CallerBoundaryAware, org.slf4j.spi.LoggingEventBuilder

public class TestLoggingEventBuilder
extends org.slf4j.spi.DefaultLoggingEventBuilder

A LoggingEventBuilder which changes the following compared to DefaultLoggingEventBuilder:

• The toLoggingEvent() method is added to build the event without logging it.
• The return type of the fluent methods is TestLoggingEventBuilder. This allows toLoggingEvent() to be used in a fluent manner.
• The KeyValuePair implementation overrides the Object.equals(java.lang.Object) and Object.hashCode() methods. This allows tests for equality in test assertions.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TestLoggingEventBuilder.TestKeyValuePair Extension of KeyValuePair with overridden Object.equals(java.lang.Object) and Object.hashCode() methods.

Field Summary

Fields inherited from class org.slf4j.spi.DefaultLoggingEventBuilder

logger, loggingEvent

Constructor Summary

Constructors

Constructor and Description
TestLoggingEventBuilder(org.slf4j.Logger logger, org.slf4j.event.Level level)

Method Summary

Modifier and Type	Method and Description
TestLoggingEventBuilder	addArgument(Object p)
TestLoggingEventBuilder	addArgument(Supplier<?> objectSupplier)
TestLoggingEventBuilder	addKeyValue(String key, Object value)
TestLoggingEventBuilder	addKeyValue(String key, Supplier<Object> valueSupplier)
TestLoggingEventBuilder	addMarker(org.slf4j.Marker marker)
TestLoggingEventBuilder	setCause(Throwable cause)
TestLoggingEventBuilder	setMessage(String message)
TestLoggingEventBuilder	setMessage(Supplier<String> messageSupplier)
org.slf4j.event.LoggingEvent	toLoggingEvent() Build the event, without logging it.

Methods inherited from class org.slf4j.spi.DefaultLoggingEventBuilder

log, log, log, log, log, log, log, setCallerBoundary

Methods inherited from class java.lang.Object

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

Constructor Detail

TestLoggingEventBuilder

public TestLoggingEventBuilder(org.slf4j.Logger logger,
                               org.slf4j.event.Level level)

Method Detail

toLoggingEvent

public org.slf4j.event.LoggingEvent toLoggingEvent()

Build the event, without logging it.

setCause

@CheckReturnValue
public TestLoggingEventBuilder setCause(Throwable cause)

Specified by:

setCause in interface org.slf4j.spi.LoggingEventBuilder

Overrides:

setCause in class org.slf4j.spi.DefaultLoggingEventBuilder

addMarker

@CheckReturnValue
public TestLoggingEventBuilder addMarker(org.slf4j.Marker marker)

Specified by:

addMarker in interface org.slf4j.spi.LoggingEventBuilder

Overrides:

addMarker in class org.slf4j.spi.DefaultLoggingEventBuilder

addArgument

@CheckReturnValue
public TestLoggingEventBuilder addArgument(Object p)

Specified by:

addArgument in interface org.slf4j.spi.LoggingEventBuilder

Overrides:

addArgument in class org.slf4j.spi.DefaultLoggingEventBuilder

addArgument

@CheckReturnValue
public TestLoggingEventBuilder addArgument(Supplier<?> objectSupplier)

Specified by:

addArgument in interface org.slf4j.spi.LoggingEventBuilder

Overrides:

addArgument in class org.slf4j.spi.DefaultLoggingEventBuilder

addKeyValue

@CheckReturnValue
public TestLoggingEventBuilder addKeyValue(String key,
                                                             Object value)

Specified by:

addKeyValue in interface org.slf4j.spi.LoggingEventBuilder

Overrides:

addKeyValue in class org.slf4j.spi.DefaultLoggingEventBuilder

addKeyValue

@CheckReturnValue
public TestLoggingEventBuilder addKeyValue(String key,
                                                             Supplier<Object> valueSupplier)

Specified by:

addKeyValue in interface org.slf4j.spi.LoggingEventBuilder

Overrides:

addKeyValue in class org.slf4j.spi.DefaultLoggingEventBuilder

setMessage

@CheckReturnValue
public TestLoggingEventBuilder setMessage(String message)

Specified by:

setMessage in interface org.slf4j.spi.LoggingEventBuilder

Overrides:

setMessage in class org.slf4j.spi.DefaultLoggingEventBuilder

setMessage

@CheckReturnValue
public TestLoggingEventBuilder setMessage(Supplier<String> messageSupplier)

Specified by:

setMessage in interface org.slf4j.spi.LoggingEventBuilder

Overrides:

setMessage in class org.slf4j.spi.DefaultLoggingEventBuilder