SLF4J API Module 2.0.17 · org.slf4j.spi.LoggingEventBuilder

Method Summary

Modifier and Type	Method and Description
public LoggingEventBuilder	Returns: a LoggingEventBuilder, usually this. addArgument(Object an Object to add. p) Add an argument to the event being built.
public LoggingEventBuilder	Returns: a LoggingEventBuilder, usually this. addArgument(Supplier<?> an Object supplier to add. objectSupplier) Add an argument supplier to the event being built.
public LoggingEventBuilder	Returns: a LoggingEventBuilder, usually this. addKeyValue(String the key of the key value pair. key, Object the value of the key value pair. value) Add a `key value pair` to the event being built.
public LoggingEventBuilder	Returns: a LoggingEventBuilder, usually this. addKeyValue(String the key of the key value pair. key, Supplier<Object> a supplier of a value for the key value pair. valueSupplier) Add a `key value pair` to the event being built.
public LoggingEventBuilder	Returns: a LoggingEventBuilder, usually this. addMarker(Marker a Marker instance to add. marker) A `marker` to the event being built.
public void	log() After the logging event is built, performs actual logging.
public void	log(String the message to log message) Equivalent to calling `setMessage(String)` followed by `log()`;
public void	log(String the message to log message, Object an argument to be used with the message to log arg) Equivalent to calling `setMessage(String)` followed by `addArgument(Object)`} and then `log()`
public void	log(String the message to log message, Object first argument to be used with the message to log arg0, Object second argument to be used with the message to log arg1) Equivalent to calling `setMessage(String)` followed by two calls to `addArgument(Object)` and then `log()`
public void	log(String the message to log message, Object... a list (actually an array) of arguments to be used with the message to log args) Equivalent to calling `setMessage(String)` followed by zero or more calls to `addArgument(Object)` (depending on the size of args array) and then `log()`
public void	log(Supplier<String> a Supplier returning a message of type String messageSupplier) Equivalent to calling `setMessage(Supplier)` followed by `log()`
public LoggingEventBuilder	Returns: a LoggingEventBuilder, usually this. setCause(Throwable a throwable cause) Set the cause for the logging event being built.
public LoggingEventBuilder	setMessage(String message) Sets the message of the logging event.
public LoggingEventBuilder	setMessage(Supplier<String> supplies a String to be used as the message for the event messageSupplier) Sets the message of the event via a message supplier.

Method Detail

addArgument	back to summary
public LoggingEventBuilder addArgument(Object p) Add an argument to the event being built. Parameters p:Object an Object to add. Returns:LoggingEventBuilder a LoggingEventBuilder, usually this. Annotations @CheckReturnValue

addArgument

back to summary

public LoggingEventBuilder addArgument(Object p)

Add an argument to the event being built.

Parameters

p:Object: an Object to add.

Returns:LoggingEventBuilder

a LoggingEventBuilder, usually this.

Annotations

@CheckReturnValue

addArgument	back to summary
public LoggingEventBuilder addArgument(Supplier<?> objectSupplier) Add an argument supplier to the event being built. Parameters objectSupplier:Supplier<?> an Object supplier to add. Returns:LoggingEventBuilder a LoggingEventBuilder, usually this. Annotations @CheckReturnValue

addArgument

back to summary

public LoggingEventBuilder addArgument(Supplier<?> objectSupplier)

Add an argument supplier to the event being built.

Parameters

objectSupplier:Supplier<?>: an Object supplier to add.

Returns:LoggingEventBuilder

a LoggingEventBuilder, usually this.

Annotations

@CheckReturnValue

addKeyValue back to summary

addKeyValue	back to summary
public LoggingEventBuilder addKeyValue(String key, Object value) Add a `key value pair` to the event being built. Parameters key:String the key of the key value pair. value:Object the value of the key value pair. Returns:LoggingEventBuilder a LoggingEventBuilder, usually this. Annotations @CheckReturnValue

public LoggingEventBuilder addKeyValue(String key, Object value)

Add a key value pair to the event being built.

Parameters

key:String: the key of the key value pair.
value:Object: the value of the key value pair.

Returns:LoggingEventBuilder

a LoggingEventBuilder, usually this.

Annotations

@CheckReturnValue

addKeyValue back to summary

addKeyValue	back to summary
public LoggingEventBuilder addKeyValue(String key, Supplier<Object> valueSupplier) Add a `key value pair` to the event being built. Parameters key:String the key of the key value pair. valueSupplier:Supplier<Object> a supplier of a value for the key value pair. Returns:LoggingEventBuilder a LoggingEventBuilder, usually this. Annotations @CheckReturnValue

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

Add a key value pair to the event being built.

Parameters

key:String: the key of the key value pair.
valueSupplier:Supplier<Object>: a supplier of a value for the key value pair.

Returns:LoggingEventBuilder

a LoggingEventBuilder, usually this.

Annotations

@CheckReturnValue

addMarker back to summary

addMarker	back to summary
public LoggingEventBuilder addMarker(Marker marker) A `marker` to the event being built. Parameters marker:Marker a Marker instance to add. Returns:LoggingEventBuilder a LoggingEventBuilder, usually this. Annotations @CheckReturnValue

public LoggingEventBuilder addMarker(Marker marker)

A marker to the event being built.

Parameters

marker:Marker: a Marker instance to add.

Returns:LoggingEventBuilder

a LoggingEventBuilder, usually this.

Annotations

@CheckReturnValue

log back to summary

log	back to summary
public void log() After the logging event is built, performs actual logging. This method must be called for logging to occur. If the call to `log()` is omitted, a `LoggingEvent` will be built but no logging will occur. Since 2.0.0-beta0

public void log()

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

Since: 2.0.0-beta0

log back to summary

log	back to summary
public void log(String message) Equivalent to calling `setMessage(String)` followed by `log()`; Parameters message:String the message to log

public void log(String message)

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

Parameters

message:String: the message to log

log back to summary

log	back to summary
public void log(String message, Object arg) Equivalent to calling `setMessage(String)` followed by `addArgument(Object)`} and then `log()` Parameters message:String the message to log arg:Object an argument to be used with the message to log

public void log(String message, Object arg)

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

Parameters

message:String: the message to log
arg:Object: an argument to be used with the message to log

log back to summary

log	back to summary
public void log(String message, Object arg0, Object arg1) Equivalent to calling `setMessage(String)` followed by two calls to `addArgument(Object)` and then `log()` Parameters message:String the message to log arg0:Object first argument to be used with the message to log arg1:Object second argument to be used with the message to log

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

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

Parameters

message:String: the message to log
arg0:Object: first argument to be used with the message to log
arg1:Object: second argument to be used with the message to log

log back to summary

log	back to summary
public void log(String message, Object... args) Equivalent to calling `setMessage(String)` followed by zero or more calls to `addArgument(Object)` (depending on the size of args array) and then `log()` Parameters message:String the message to log args:Object[] a list (actually an array) of arguments to be used with the message to log

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

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

Parameters

message:String: the message to log
args:Object[]: a list (actually an array) of arguments to be used with the message to log

log back to summary

log	back to summary
public void log(Supplier<String> messageSupplier) Equivalent to calling `setMessage(Supplier)` followed by `log()` Parameters messageSupplier:Supplier<String> a Supplier returning a message of type String

public void log(Supplier<String> messageSupplier)

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

Parameters

messageSupplier:Supplier<String>: a Supplier returning a message of type String

setCause	back to summary
public LoggingEventBuilder setCause(Throwable cause) Set the cause for the logging event being built. Parameters cause:Throwable a throwable Returns:LoggingEventBuilder a LoggingEventBuilder, usually this. Annotations @CheckReturnValue

setCause

back to summary

public LoggingEventBuilder setCause(Throwable cause)

Set the cause for the logging event being built.

Parameters

cause:Throwable: a throwable

Returns:LoggingEventBuilder

a LoggingEventBuilder, usually this.

Annotations

@CheckReturnValue

setMessage	back to summary
public LoggingEventBuilder setMessage(String message) Sets the message of the logging event. Annotations @CheckReturnValue Since 2.0.0-beta0

setMessage

back to summary

public LoggingEventBuilder setMessage(String message)

Sets the message of the logging event.

Annotations

@CheckReturnValue

Since

2.0.0-beta0

setMessage	back to summary
public LoggingEventBuilder setMessage(Supplier<String> messageSupplier) Sets the message of the event via a message supplier. Parameters messageSupplier:Supplier<String> supplies a String to be used as the message for the event Annotations @CheckReturnValue Since 2.0.0-beta0

setMessage

back to summary

public LoggingEventBuilder setMessage(Supplier<String> messageSupplier)

Sets the message of the event via a message supplier.

Parameters

messageSupplier:Supplier<String>: supplies a String to be used as the message for the event

Annotations

@CheckReturnValue

Since

2.0.0-beta0

public Interface LoggingEventBuilder

Method Summary

Method Detail