Class DefaultLogBuilder
- java.lang.Object
-
- org.apache.logging.log4j.internal.DefaultLogBuilder
-
- All Implemented Interfaces:
LogBuilder
public class DefaultLogBuilder extends Object implements LogBuilder
Collects data for a log event and then logs it. This class should be considered private.
-
-
Field Summary
-
Fields inherited from interface org.apache.logging.log4j.LogBuilder
NOOP
-
-
Constructor Summary
Constructors Constructor Description DefaultLogBuilder(Logger logger)
DefaultLogBuilder(Logger logger, Level level)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
isInUse()
void
log()
Causes all the data collected to be logged.void
log(CharSequence message)
Causes all the data collected to be logged along with the message.void
log(Object message)
Causes all the data collected to be logged along with the message.void
log(String message)
Causes all the data collected to be logged along with the message.void
log(String message, Object p0)
Logs a message with parameters.void
log(String message, Object... params)
Logs a message with parameters.void
log(String message, Object p0, Object p1)
Logs a message with parameters.void
log(String message, Object p0, Object p1, Object p2)
Logs a message with parameters.void
log(String message, Object p0, Object p1, Object p2, Object p3)
Logs a message with parameters.void
log(String message, Object p0, Object p1, Object p2, Object p3, Object p4)
Logs a message with parameters.void
log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)
Logs a message with parameters.void
log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)
Logs a message with parameters.void
log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)
Logs a message with parameters.void
log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)
Logs a message with parameters.void
log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)
Logs a message with parameters.void
log(String message, Supplier<?>... params)
Causes all the data collected to be logged along with the message and parameters.void
log(Message message)
Causes all the data collected to be logged along with the message.void
log(Supplier<Message> messageSupplier)
Causes all the data collected to be logged along with the message.LogBuilder
reset(Level level)
This method should be considered internal.LogBuilder
withLocation()
An implementation will calculate the caller's stack frame and include it in the log event.LogBuilder
withLocation(StackTraceElement location)
Adds the specified stack trace element to the log event.LogBuilder
withMarker(Marker marker)
Includes a Marker in the log event.LogBuilder
withThrowable(Throwable throwable)
Includes a Throwable in the log event.
-
-
-
Method Detail
-
reset
public LogBuilder reset(Level level)
This method should be considered internal. It is used to reset the LogBuilder for a new log message.- Parameters:
level
- The logging level for this event.- Returns:
- This LogBuilder instance.
-
withMarker
public LogBuilder withMarker(Marker marker)
Description copied from interface:LogBuilder
Includes a Marker in the log event. Interface default method does nothing.- Specified by:
withMarker
in interfaceLogBuilder
- Parameters:
marker
- The Marker to log.- Returns:
- The LogBuilder.
-
withThrowable
public LogBuilder withThrowable(Throwable throwable)
Description copied from interface:LogBuilder
Includes a Throwable in the log event. Interface default method does nothing.- Specified by:
withThrowable
in interfaceLogBuilder
- Parameters:
throwable
- The Throwable to log.- Returns:
- the LogBuilder.
-
withLocation
public LogBuilder withLocation()
Description copied from interface:LogBuilder
An implementation will calculate the caller's stack frame and include it in the log event. Interface default method does nothing.- Specified by:
withLocation
in interfaceLogBuilder
- Returns:
- The LogBuilder.
-
withLocation
public LogBuilder withLocation(StackTraceElement location)
Description copied from interface:LogBuilder
Adds the specified stack trace element to the log event. Interface default method does nothing.- Specified by:
withLocation
in interfaceLogBuilder
- Parameters:
location
- The stack trace element to include in the log event.- Returns:
- The LogBuilder.
-
isInUse
public boolean isInUse()
-
log
public void log(Message message)
Description copied from interface:LogBuilder
Causes all the data collected to be logged along with the message. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- The message to log.
-
log
public void log(CharSequence message)
Description copied from interface:LogBuilder
Causes all the data collected to be logged along with the message. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- The message to log.
-
log
public void log(String message)
Description copied from interface:LogBuilder
Causes all the data collected to be logged along with the message. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- The message to log.
-
log
public void log(String message, Object... params)
Description copied from interface:LogBuilder
Logs a message with parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.params
- parameters to the message.- See Also:
Unbox
-
log
public void log(String message, Supplier<?>... params)
Description copied from interface:LogBuilder
Causes all the data collected to be logged along with the message and parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- The message.params
- Parameters to the message.
-
log
public void log(Supplier<Message> messageSupplier)
Description copied from interface:LogBuilder
Causes all the data collected to be logged along with the message. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
messageSupplier
- The supplier of the message to log.
-
log
public void log(Object message)
Description copied from interface:LogBuilder
Causes all the data collected to be logged along with the message. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- The message to log.
-
log
public void log(String message, Object p0)
Description copied from interface:LogBuilder
Logs a message with parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.p0
- parameter to the message.- See Also:
Unbox
-
log
public void log(String message, Object p0, Object p1)
Description copied from interface:LogBuilder
Logs a message with parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.p0
- parameter to the message.p1
- parameter to the message.- See Also:
Unbox
-
log
public void log(String message, Object p0, Object p1, Object p2)
Description copied from interface:LogBuilder
Logs a message with parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.p0
- parameter to the message.p1
- parameter to the message.p2
- parameter to the message.- See Also:
Unbox
-
log
public void log(String message, Object p0, Object p1, Object p2, Object p3)
Description copied from interface:LogBuilder
Logs a message with parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.p0
- parameter to the message.p1
- parameter to the message.p2
- parameter to the message.p3
- parameter to the message.- See Also:
Unbox
-
log
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4)
Description copied from interface:LogBuilder
Logs a message with parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.p0
- parameter to the message.p1
- parameter to the message.p2
- parameter to the message.p3
- parameter to the message.p4
- parameter to the message.- See Also:
Unbox
-
log
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5)
Description copied from interface:LogBuilder
Logs a message with parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.p0
- parameter to the message.p1
- parameter to the message.p2
- parameter to the message.p3
- parameter to the message.p4
- parameter to the message.p5
- parameter to the message.- See Also:
Unbox
-
log
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6)
Description copied from interface:LogBuilder
Logs a message with parameters.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.p0
- parameter to the message.p1
- parameter to the message.p2
- parameter to the message.p3
- parameter to the message.p4
- parameter to the message.p5
- parameter to the message.p6
- parameter to the message.- See Also:
Unbox
-
log
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7)
Description copied from interface:LogBuilder
Logs a message with parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.p0
- parameter to the message.p1
- parameter to the message.p2
- parameter to the message.p3
- parameter to the message.p4
- parameter to the message.p5
- parameter to the message.p6
- parameter to the message.p7
- parameter to the message.- See Also:
Unbox
-
log
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8)
Description copied from interface:LogBuilder
Logs a message with parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.p0
- parameter to the message.p1
- parameter to the message.p2
- parameter to the message.p3
- parameter to the message.p4
- parameter to the message.p5
- parameter to the message.p6
- parameter to the message.p7
- parameter to the message.p8
- parameter to the message.- See Also:
Unbox
-
log
public void log(String message, Object p0, Object p1, Object p2, Object p3, Object p4, Object p5, Object p6, Object p7, Object p8, Object p9)
Description copied from interface:LogBuilder
Logs a message with parameters. Interface default method does nothing.- Specified by:
log
in interfaceLogBuilder
- Parameters:
message
- the message to log; the format depends on the message factory.p0
- parameter to the message.p1
- parameter to the message.p2
- parameter to the message.p3
- parameter to the message.p4
- parameter to the message.p5
- parameter to the message.p6
- parameter to the message.p7
- parameter to the message.p8
- parameter to the message.p9
- parameter to the message.- See Also:
Unbox
-
log
public void log()
Description copied from interface:LogBuilder
Causes all the data collected to be logged. Default implementatoin does nothing.- Specified by:
log
in interfaceLogBuilder
-
-