Package org.slf4j.spi

Class NOPLoggingEventBuilder

java.lang.Object

org.slf4j.spi.NOPLoggingEventBuilder

All Implemented Interfaces:

LoggingEventBuilder

public class NOPLoggingEventBuilder
extends java.lang.Object
implements LoggingEventBuilder

A no-operation implementation of LoggingEventBuilder.

As the name indicates, the method in this class do nothing, except when a return value is expected in which case a singleton, i.e. the unique instance of this class is returned.

Since:

2.0.0

Author:

Ceki Gülcü

Method Summary

Modifier and Type	Method	Description
LoggingEventBuilder	addArgument(java.lang.Object p)	Add an argument to the event being built.
LoggingEventBuilder	addArgument(java.util.function.Supplier<?> objectSupplier)	Add an argument supplier to the event being built.
LoggingEventBuilder	addKeyValue(java.lang.String key, java.lang.Object value)	Add a key value pair to the event being built.
LoggingEventBuilder	addKeyValue(java.lang.String key, java.util.function.Supplier<java.lang.Object> value)	Add a key value pair to the event being built.
LoggingEventBuilder	addMarker(Marker marker)	A marker to the event being built.
void	log()	After the logging event is built, performs actual logging.
void	log(java.lang.String message)	Equivalent to calling LoggingEventBuilder.setMessage(String) followed by LoggingEventBuilder.log();
void	log(java.lang.String message, java.lang.Object arg)	Equivalent to calling LoggingEventBuilder.setMessage(String) followed by LoggingEventBuilder.addArgument(Object)} and then LoggingEventBuilder.log()
void	log(java.lang.String message, java.lang.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(java.lang.String message, java.lang.Object arg0, java.lang.Object arg1)	Equivalent to calling LoggingEventBuilder.setMessage(String) followed by two calls to LoggingEventBuilder.addArgument(Object) and then LoggingEventBuilder.log()
void	log(java.util.function.Supplier<java.lang.String> messageSupplier)	Equivalent to calling LoggingEventBuilder.setMessage(Supplier) followed by LoggingEventBuilder.log()
LoggingEventBuilder	setCause(java.lang.Throwable cause)	Set the cause for the logging event being built.
LoggingEventBuilder	setMessage(java.lang.String message)	Sets the message of the logging event.
LoggingEventBuilder	setMessage(java.util.function.Supplier<java.lang.String> messageSupplier)	Sets the message of the event via a message supplier.
static LoggingEventBuilder	singleton()	Returns the singleton instance of this class.

Methods inherited from class java.lang.Object

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

Method Detail

singleton

public static LoggingEventBuilder singleton()

Returns the singleton instance of this class. Used by makeLoggingEventBuilder(Level).

Returns:

the singleton instance of this class

addMarker

public LoggingEventBuilder addMarker(Marker marker)

Description copied from interface: LoggingEventBuilder

A marker to the event being built.

Specified by:

addMarker in interface LoggingEventBuilder

Parameters:

marker - a Marker instance to add.

Returns:

a LoggingEventBuilder, usually this.

addArgument

public LoggingEventBuilder addArgument(java.lang.Object p)

Description copied from interface: LoggingEventBuilder

Add an argument to the event being built.

Specified by:

addArgument in interface LoggingEventBuilder

Parameters:

p - an Object to add.

Returns:

a LoggingEventBuilder, usually this.

addArgument

public LoggingEventBuilder addArgument(java.util.function.Supplier<?> objectSupplier)

Description copied from interface: LoggingEventBuilder

Add an argument supplier to the event being built.

Specified by:

addArgument in interface LoggingEventBuilder

Parameters:

objectSupplier - an Object supplier to add.

Returns:

a LoggingEventBuilder, usually this.

addKeyValue

public LoggingEventBuilder addKeyValue(java.lang.String key,
                                       java.lang.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, usually this.

addKeyValue

public LoggingEventBuilder addKeyValue(java.lang.String key,
                                       java.util.function.Supplier<java.lang.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, usually this.

setCause

public LoggingEventBuilder setCause(java.lang.Throwable cause)

Description copied from interface: LoggingEventBuilder

Set the cause for the logging event being built.

Specified by:

setCause in interface LoggingEventBuilder

Parameters:

cause - a throwable

Returns:

a LoggingEventBuilder, usually this.

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(java.lang.String message)

Description copied from interface: LoggingEventBuilder

Sets the message of the logging event.

Specified by:

setMessage in interface LoggingEventBuilder

setMessage

public LoggingEventBuilder setMessage(java.util.function.Supplier<java.lang.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

log

public void log(java.lang.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(java.util.function.Supplier<java.lang.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

public void log(java.lang.String message,
                java.lang.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(java.lang.String message,
                java.lang.Object arg0,
                java.lang.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(java.lang.String message,
                java.lang.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