Module org.slf4j

Package org.slf4j.spi

Class DefaultLoggingEventBuilder

java.lang.Object

org.slf4j.spi.DefaultLoggingEventBuilder

All Implemented Interfaces:

CallerBoundaryAware, LoggingEventBuilder

public class DefaultLoggingEventBuilder
extends Object
implements LoggingEventBuilder, CallerBoundaryAware

Default implementation of LoggingEventBuilder.

It is assumed that when

Since:

2.0.0

Field Summary

Fields

Modifier and Type	Field	Description
protected Logger	logger
protected DefaultLoggingEvent	loggingEvent

Constructor Summary

Constructors

Constructor	Description
DefaultLoggingEventBuilder(Logger logger, Level level)

Method Summary

Modifier and Type	Method	Description
LoggingEventBuilder	addArgument(Object p)	Add an argument to the event being built.
LoggingEventBuilder	addArgument(Supplier<?> objectSupplier)	Add an argument supplier to the event being built.
LoggingEventBuilder	addKeyValue(String key, Object value)	Add a key value pair to the event being built.
LoggingEventBuilder	addKeyValue(String key, Supplier<Object> value)	Add a key value pair to the event being built.
LoggingEventBuilder	addMarker(Marker marker)	Add a marker to the current logging event being built.
void	log()	After the logging event is built, performs actual logging.
void	log(String message)	Equivalent to calling LoggingEventBuilder.setMessage(String) followed by LoggingEventBuilder.log();
void	log(String message, Object arg)	Equivalent to calling LoggingEventBuilder.setMessage(String) followed by LoggingEventBuilder.addArgument(Object)} and then LoggingEventBuilder.log()
void	log(String message, Object... args)	Equivalent to calling LoggingEventBuilder.setMessage(String) followed by zero or more calls to LoggingEventBuilder.addArgument(Object) (depending on the size of args array) and then LoggingEventBuilder.log()
void	log(String message, Object arg0, Object arg1)	Equivalent to calling LoggingEventBuilder.setMessage(String) followed by two calls to LoggingEventBuilder.addArgument(Object) and then LoggingEventBuilder.log()
void	log(Supplier<String> messageSupplier)	Equivalent to calling LoggingEventBuilder.setMessage(Supplier) followed by LoggingEventBuilder.log()
protected void	log(LoggingEvent aLoggingEvent)
void	setCallerBoundary(String fqcn)	Add a fqcn (fully qualified class name) to this event, presumed to be the caller boundary.
LoggingEventBuilder	setCause(Throwable t)	Set the cause for the logging event being built.
LoggingEventBuilder	setMessage(String message)	Sets the message of the logging event.
LoggingEventBuilder	setMessage(Supplier<String> messageSupplier)	Sets the message of the event via a message supplier.

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.slf4j.spi.LoggingEventBuilder

arg, arg, arg, arg, arg, arg, arg, arg, arg, arg, kv, kv, kv, kv, kv, kv, kv, kv, kv, kv

Field Details

loggingEvent

protected DefaultLoggingEvent loggingEvent

logger

protected Logger logger

Constructor Details

DefaultLoggingEventBuilder

public DefaultLoggingEventBuilder(Logger logger,
 Level level)

Method Details

addMarker

public LoggingEventBuilder addMarker(Marker marker)

Add a marker to the current logging event being built. It is possible to add multiple markers to the same logging event.

Specified by:

addMarker in interface LoggingEventBuilder

Parameters:

marker - the marker to add

Returns:

a LoggingEventBuilder instance, usually this.

setCause

public LoggingEventBuilder setCause(Throwable t)

Description copied from interface: LoggingEventBuilder

Set the cause for the logging event being built.

Specified by:

setCause in interface LoggingEventBuilder

Parameters:

t - a throwable

Returns:

a LoggingEventBuilder instance, usually this.

addArgument

public LoggingEventBuilder addArgument(Object p)

Description copied from interface: LoggingEventBuilder

Add an argument to the event being built. Synonymous with LoggingEventBuilder.arg(Object) method.

Specified by:

addArgument in interface LoggingEventBuilder

Parameters:

p - an Object to add.

Returns:

a LoggingEventBuilder instance, usually this.

addArgument

public LoggingEventBuilder addArgument(Supplier<?> objectSupplier)

Description copied from interface: LoggingEventBuilder

Add an argument supplier to the event being built. Synonymous with LoggingEventBuilder.arg(Supplier) method.

Specified by:

addArgument in interface LoggingEventBuilder

Parameters:

objectSupplier - an Object supplier to add.

Returns:

a LoggingEventBuilder instance, usually this.

setCallerBoundary

public void setCallerBoundary(String fqcn)

Description copied from interface: CallerBoundaryAware

Add a fqcn (fully qualified class name) to this event, presumed to be the caller boundary.

Specified by:

setCallerBoundary in interface CallerBoundaryAware

Parameters:

fqcn -

log

public void log()

Description copied from interface: LoggingEventBuilder

After the logging event is built, performs actual logging. This method must be called for logging to occur. If the call to LoggingEventBuilder.log() is omitted, a LoggingEvent will be built but no logging will occur.

Specified by:

log in interface LoggingEventBuilder

setMessage

public LoggingEventBuilder setMessage(String message)

Description copied from interface: LoggingEventBuilder

Sets the message of the logging event.

Specified by:

setMessage in interface LoggingEventBuilder

Parameters:

message - the message of the event

Returns:

a LoggingEventBuilder instance, usually this.

setMessage

public LoggingEventBuilder setMessage(Supplier<String> messageSupplier)

Description copied from interface: LoggingEventBuilder

Sets the message of the event via a message supplier.

Specified by:

setMessage in interface LoggingEventBuilder

Parameters:

messageSupplier - supplies a String to be used as the message for the event

Returns:

a LoggingEventBuilder instance, usually this.

log

public void log(String message)

Description copied from interface: LoggingEventBuilder

Equivalent to calling LoggingEventBuilder.setMessage(String) followed by LoggingEventBuilder.log();

Specified by:

log in interface LoggingEventBuilder

Parameters:

message - the message to log

log

public void log(String message,
 Object arg)

Description copied from interface: LoggingEventBuilder

Equivalent to calling LoggingEventBuilder.setMessage(String) followed by LoggingEventBuilder.addArgument(Object)} and then LoggingEventBuilder.log()

Specified by:

log in interface LoggingEventBuilder

Parameters:

message - the message to log

arg - an argument to be used with the message to log

log

public void log(String message,
 Object arg0,
 Object arg1)

Description copied from interface: LoggingEventBuilder

Equivalent to calling LoggingEventBuilder.setMessage(String) followed by two calls to LoggingEventBuilder.addArgument(Object) and then LoggingEventBuilder.log()

Specified by:

log in interface LoggingEventBuilder

Parameters:

message - the message to log

arg0 - first argument to be used with the message to log

arg1 - second argument to be used with the message to log

log

public void log(String message,
 Object... args)

Description copied from interface: LoggingEventBuilder

Equivalent to calling LoggingEventBuilder.setMessage(String) followed by zero or more calls to LoggingEventBuilder.addArgument(Object) (depending on the size of args array) and then LoggingEventBuilder.log()

Specified by:

log in interface LoggingEventBuilder

Parameters:

message - the message to log

args - a list (actually an array) of arguments to be used with the message to log

log

public void log(Supplier<String> messageSupplier)

Description copied from interface: LoggingEventBuilder

Equivalent to calling LoggingEventBuilder.setMessage(Supplier) followed by LoggingEventBuilder.log()

Specified by:

log in interface LoggingEventBuilder

Parameters:

messageSupplier - a Supplier returning a message of type String

log

protected void log(LoggingEvent aLoggingEvent)

addKeyValue

public LoggingEventBuilder addKeyValue(String key,
 Object value)

Description copied from interface: LoggingEventBuilder

Add a key value pair to the event being built.

Specified by:

addKeyValue in interface LoggingEventBuilder

Parameters:

key - the key of the key value pair.

value - the value of the key value pair.

Returns:

a LoggingEventBuilder instance, usually this.

addKeyValue

public LoggingEventBuilder addKeyValue(String key,
 Supplier<Object> value)

Description copied from interface: LoggingEventBuilder

Add a key value pair to the event being built.

Specified by:

addKeyValue in interface LoggingEventBuilder

Parameters:

key - the key of the key value pair.

value - a supplier of a value for the key value pair.

Returns:

a LoggingEventBuilder instance, usually this.