Package org.apache.logging.log4j.core.impl

Class Log4jLogEvent.Builder

java.lang.Object

org.apache.logging.log4j.core.impl.Log4jLogEvent.Builder

All Implemented Interfaces:

Builder<LogEvent>

Enclosing class:

Log4jLogEvent

public static class Log4jLogEvent.Builder
extends java.lang.Object
implements Builder<LogEvent>

LogEvent Builder helper class.

Field Summary

Fields

Modifier and Type	Field	Description
private StringMap	contextData
private ThreadContext.ContextStack	contextStack
private boolean	endOfBatch
private boolean	includeLocation
private MutableInstant	instant
private Level	level
private java.lang.String	loggerFqcn
private java.lang.String	loggerName
private Marker	marker
private Message	message
private long	nanoTime
private java.lang.StackTraceElement	source
private long	threadId
private java.lang.String	threadName
private int	threadPriority
private java.lang.Throwable	thrown

Constructor Summary

Constructors

Constructor	Description
Builder()
Builder(LogEvent other)	Initializes the builder with an immutable instance or a copy of the log event fields.

Method Summary

Modifier and Type	Method	Description
Log4jLogEvent	build()	Builds the object after all configuration has been set.
private void	initTimeFields()
Log4jLogEvent.Builder	setContextData(StringMap contextData)
Log4jLogEvent.Builder	setContextMap(java.util.Map<java.lang.String,java.lang.String> contextMap)	Deprecated.
Log4jLogEvent.Builder	setContextStack(ThreadContext.ContextStack contextStack)
Log4jLogEvent.Builder	setEndOfBatch(boolean endOfBatch)
Log4jLogEvent.Builder	setIncludeLocation(boolean includeLocation)
Log4jLogEvent.Builder	setInstant(Instant instant)
Log4jLogEvent.Builder	setLevel(Level level)
Log4jLogEvent.Builder	setLoggerFqcn(java.lang.String loggerFqcn)
Log4jLogEvent.Builder	setLoggerName(java.lang.String loggerName)
Log4jLogEvent.Builder	setMarker(Marker marker)
Log4jLogEvent.Builder	setMessage(Message message)
Log4jLogEvent.Builder	setNanoTime(long nanoTime)	Sets the nano time for the event.
Log4jLogEvent.Builder	setSource(java.lang.StackTraceElement source)
Log4jLogEvent.Builder	setThreadId(long threadId)
Log4jLogEvent.Builder	setThreadName(java.lang.String threadName)
Log4jLogEvent.Builder	setThreadPriority(int threadPriority)
Log4jLogEvent.Builder	setThrown(java.lang.Throwable thrown)
Log4jLogEvent.Builder	setThrownProxy(ThrowableProxy thrownProxy)	Deprecated. since 2.25.0 without a replacement
Log4jLogEvent.Builder	setTimeMillis(long timeMillis)

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Field Detail

loggerFqcn

private java.lang.String loggerFqcn

level

private Level level

loggerName

private java.lang.String loggerName

marker

private Marker marker

thrown

private java.lang.Throwable thrown

endOfBatch

private boolean endOfBatch

includeLocation

private boolean includeLocation

nanoTime

private long nanoTime

instant

private final MutableInstant instant

source

private java.lang.StackTraceElement source

threadName

private java.lang.String threadName

threadId

private long threadId

threadPriority

private int threadPriority

message

private Message message

contextData

private StringMap contextData

contextStack

private ThreadContext.ContextStack contextStack

Constructor Detail

Builder

public Builder()

Builder

public Builder(LogEvent other)

Initializes the builder with an immutable instance or a copy of the log event fields.

Parameters:

other - The log event to copy.

Method Detail

setLevel

public Log4jLogEvent.Builder setLevel(Level level)

setLoggerFqcn

public Log4jLogEvent.Builder setLoggerFqcn(java.lang.String loggerFqcn)

setLoggerName

public Log4jLogEvent.Builder setLoggerName(java.lang.String loggerName)

setMarker

public Log4jLogEvent.Builder setMarker(Marker marker)

setMessage

public Log4jLogEvent.Builder setMessage(Message message)

setThrown

public Log4jLogEvent.Builder setThrown(java.lang.Throwable thrown)

setTimeMillis

public Log4jLogEvent.Builder setTimeMillis(long timeMillis)

setInstant

public Log4jLogEvent.Builder setInstant(Instant instant)

setThrownProxy

@Deprecated
public Log4jLogEvent.Builder setThrownProxy(ThrowableProxy thrownProxy)

Deprecated.

since 2.25.0 without a replacement

setContextMap

@Deprecated
public Log4jLogEvent.Builder setContextMap(java.util.Map<java.lang.String,java.lang.String> contextMap)

Deprecated.

setContextData

public Log4jLogEvent.Builder setContextData(StringMap contextData)

setContextStack

public Log4jLogEvent.Builder setContextStack(ThreadContext.ContextStack contextStack)

setThreadId

public Log4jLogEvent.Builder setThreadId(long threadId)

setThreadName

public Log4jLogEvent.Builder setThreadName(java.lang.String threadName)

setThreadPriority

public Log4jLogEvent.Builder setThreadPriority(int threadPriority)

setSource

public Log4jLogEvent.Builder setSource(java.lang.StackTraceElement source)

setIncludeLocation

public Log4jLogEvent.Builder setIncludeLocation(boolean includeLocation)

setEndOfBatch

public Log4jLogEvent.Builder setEndOfBatch(boolean endOfBatch)

setNanoTime

public Log4jLogEvent.Builder setNanoTime(long nanoTime)

Sets the nano time for the event.

Parameters:

nanoTime - The value of the running Java Virtual Machine's high-resolution time source when the event was created.

Returns:

this builder

build

public Log4jLogEvent build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<LogEvent>

Returns:

the configured instance.

initTimeFields

private void initTimeFields()