public class MutableLogEvent extends Object implements LogEvent, ReusableMessage, ParameterVisitable
LogEvent
interface.Constructor and Description |
---|
MutableLogEvent() |
MutableLogEvent(StringBuilder msgText,
Object[] replacementParameters) |
Modifier and Type | Method and Description |
---|---|
void |
clear()
Clears all references this event has to other objects.
|
Log4jLogEvent |
createMemento()
Creates and returns a new immutable copy of this
MutableLogEvent . |
<S> void |
forEachParameter(ParameterConsumer<S> action,
S state)
Performs the given action for each parameter until all values
have been processed or the action throws an exception.
|
void |
formatTo(StringBuilder buffer)
Writes a text representation of this object into the specified
StringBuilder , ideally without allocating
temporary objects. |
ReadOnlyStringMap |
getContextData()
Returns the
ReadOnlyStringMap object holding context data key-value pairs. |
Map<String,String> |
getContextMap()
Gets the context map (also know as Mapped Diagnostic Context or MDC).
|
ThreadContext.ContextStack |
getContextStack()
Gets the context stack (also known as Nested Diagnostic Context or NDC).
|
String |
getFormat()
Gets the format portion of the Message.
|
String |
getFormattedMessage()
Gets the Message formatted as a String.
|
Instant |
getInstant()
Returns the Instant when the message was logged.
|
Level |
getLevel()
Gets the level.
|
String |
getLoggerFqcn()
Returns the fully qualified class name of the caller of the logging API.
|
String |
getLoggerName()
Gets the logger name.
|
Marker |
getMarker()
Gets the Marker associated with the event.
|
Message |
getMessage()
Gets the message associated with the event.
|
long |
getNanoTime()
Returns the value of the running Java Virtual Machine's high-resolution time source when this event was created,
or a dummy value if it is known that this value will not be used downstream.
|
short |
getParameterCount()
Returns the number of parameters that was used to initialize this reusable message for the current content.
|
Object[] |
getParameters()
Gets parameter values, if any.
|
StackTraceElement |
getSource()
Returns the StackTraceElement for the caller.
|
long |
getThreadId()
Gets the thread ID.
|
String |
getThreadName()
Gets the thread name.
|
int |
getThreadPriority()
Gets the thread priority.
|
Throwable |
getThrowable()
Gets the throwable, if any.
|
Throwable |
getThrown()
Gets throwable associated with logging request.
|
ThrowableProxy |
getThrownProxy()
Returns the ThrowableProxy associated with the event, or null.
|
long |
getTimeMillis()
Gets event time in milliseconds since midnight, January 1, 1970 UTC.
|
void |
initFrom(LogEvent event)
Initialize the fields of this
MutableLogEvent from another event. |
void |
initializeBuilder(Log4jLogEvent.Builder builder)
Initializes the specified
Log4jLogEvent.Builder from this MutableLogEvent . |
boolean |
isEndOfBatch()
Returns
true if this event is the last one in a batch, false otherwise. |
boolean |
isIncludeLocation()
Returns whether the source of the logging request is required downstream.
|
Message |
memento()
Returns an immutable snapshot of the current internal state of this reusable message.
|
void |
setContextData(StringMap mutableContextData) |
void |
setContextStack(ThreadContext.ContextStack contextStack) |
void |
setEndOfBatch(boolean endOfBatch)
Sets whether this event is the last one in a batch.
|
void |
setIncludeLocation(boolean includeLocation)
Sets whether the source of the logging request is required downstream.
|
void |
setLevel(Level level) |
void |
setLoggerFqcn(String loggerFqcn) |
void |
setLoggerName(String loggerName) |
void |
setMarker(Marker marker) |
void |
setMessage(Message msg) |
void |
setNanoTime(long nanoTime) |
void |
setSource(StackTraceElement source) |
void |
setThreadId(long threadId) |
void |
setThreadName(String threadName) |
void |
setThreadPriority(int threadPriority) |
void |
setThrown(Throwable thrown) |
void |
setTimeMillis(long timeMillis) |
Object[] |
swapParameters(Object[] emptyReplacement)
Replaces this ReusableMessage's parameter array with the specified value and return the original array
|
Log4jLogEvent |
toImmutable()
Returns an immutable version of this log event, which MAY BE a copy of this event.
|
protected Object |
writeReplace()
Creates a LogEventProxy that can be serialized.
|
public MutableLogEvent()
public MutableLogEvent(StringBuilder msgText, Object[] replacementParameters)
public Log4jLogEvent toImmutable()
LogEvent
toImmutable
in interface LogEvent
public void initFrom(LogEvent event)
MutableLogEvent
from another event.
Similar in purpose and usage as Log4jLogEvent.LogEventProxy
,
but a mutable version.
This method is used on async logger ringbuffer slots holding MutableLogEvent objects in each slot.
event
- the event to copy data frompublic void clear()
public String getLoggerFqcn()
LogEvent
getLoggerFqcn
in interface LogEvent
public void setLoggerFqcn(String loggerFqcn)
public Marker getMarker()
LogEvent
public void setMarker(Marker marker)
public void setLevel(Level level)
public String getLoggerName()
LogEvent
getLoggerName
in interface LogEvent
null
.public void setLoggerName(String loggerName)
public Message getMessage()
LogEvent
getMessage
in interface LogEvent
public void setMessage(Message msg)
public String getFormattedMessage()
Message
When configured to log asynchronously, this method is called before the Message is queued, unless this
message implements ReusableMessage
or is annotated with AsynchronouslyFormattable
.
This gives the Message implementation class a chance to create a formatted message String with the current value
of any mutable objects.
The intention is that the Message implementation caches this formatted message and returns it on subsequent
calls. (See LOG4J2-763.)
When logging synchronously, this method will not be called for Messages that implement the
StringBuilderFormattable
interface: instead, the
formatTo(StringBuilder)
method will be called so the
Message can format its contents without creating intermediate String objects.
getFormattedMessage
in interface Message
Message.getFormattedMessage()
public String getFormat()
Message
getFormat
in interface Message
Message.getFormat()
public Object[] getParameters()
Message
getParameters
in interface Message
Message.getParameters()
public <S> void forEachParameter(ParameterConsumer<S> action, S state)
ParameterVisitable
The second parameter lets callers pass in a stateful object to be modified with the key-value pairs, so the TriConsumer implementation itself can be stateless and potentially reusable.
forEachParameter
in interface ParameterVisitable
S
- type of the third parameteraction
- The action to be performed for each key-value pair in this collectionstate
- the object to be passed as the third parameter to each invocation on the
specified ParameterConsumer.public Throwable getThrowable()
Message
getThrowable
in interface Message
Message.getThrowable()
public void formatTo(StringBuilder buffer)
StringBuilderFormattable
StringBuilder
, ideally without allocating
temporary objects.formatTo
in interface StringBuilderFormattable
buffer
- the StringBuilder to write intoStringBuilderFormattable.formatTo(StringBuilder)
public Object[] swapParameters(Object[] emptyReplacement)
swapParameters
in interface ReusableMessage
emptyReplacement
- the parameter array that can be used for subsequent uses of this reusable messageReusableMessage.swapParameters(Object[])
public short getParameterCount()
ReusableMessage
The parameter array returned by ReusableMessage.swapParameters(Object[])
may be larger than the actual number of
parameters. Callers should use this method to determine how many elements the array contains.
getParameterCount
in interface ReusableMessage
public Message memento()
ReusableMessage
memento
in interface ReusableMessage
public Throwable getThrown()
LogEvent
Convenience method for ThrowableProxy.getThrowable();
public void setThrown(Throwable thrown)
public long getTimeMillis()
LogEvent
LogEvent.getInstant()
to get higher precision timestamp information if available on this platform.getTimeMillis
in interface LogEvent
System.currentTimeMillis()
public void setTimeMillis(long timeMillis)
public Instant getInstant()
LogEvent
Caution: if this LogEvent
implementation is mutable and reused for multiple consecutive log messages,
then the Instant
object returned by this method is also mutable and reused.
Client code should not keep a reference to the returned object but make a copy instead.
getInstant
in interface LogEvent
Instant
holding Instant details for this log eventpublic ThrowableProxy getThrownProxy()
getThrownProxy
in interface LogEvent
public void setSource(StackTraceElement source)
public StackTraceElement getSource()
public ReadOnlyStringMap getContextData()
LogEvent
ReadOnlyStringMap
object holding context data key-value pairs.
Context data (also known as Mapped Diagnostic Context or MDC) is data that is set by the application to be
included in all subsequent log events. The default source for context data is the ThreadContext
(and
properties
configured on the Logger that logged the event), but users can configure a custom ContextDataInjector
to inject key-value pairs from any arbitrary source.
getContextData
in interface LogEvent
ReadOnlyStringMap
object holding context data key-value pairsContextDataInjector
,
ThreadContext
public Map<String,String> getContextMap()
LogEvent
getContextMap
in interface LogEvent
null
.public void setContextData(StringMap mutableContextData)
public ThreadContext.ContextStack getContextStack()
LogEvent
getContextStack
in interface LogEvent
null
.public void setContextStack(ThreadContext.ContextStack contextStack)
public long getThreadId()
LogEvent
getThreadId
in interface LogEvent
public void setThreadId(long threadId)
public String getThreadName()
LogEvent
getThreadName
in interface LogEvent
public void setThreadName(String threadName)
public int getThreadPriority()
LogEvent
getThreadPriority
in interface LogEvent
public void setThreadPriority(int threadPriority)
public boolean isIncludeLocation()
LogEvent
StackTrace
snapshot or not before handing off this event to
another thread.isIncludeLocation
in interface LogEvent
true
if the source of the logging request is required downstream, false
otherwise.LogEvent.getSource()
public void setIncludeLocation(boolean includeLocation)
LogEvent
StackTrace
snapshot or not before handing off this event to
another thread.setIncludeLocation
in interface LogEvent
includeLocation
- true
if the source of the logging request is required downstream, false
otherwise.LogEvent.getSource()
public boolean isEndOfBatch()
LogEvent
true
if this event is the last one in a batch, false
otherwise. Used by asynchronous
Loggers and Appenders to signal to buffered downstream components when to flush to disk, as a more efficient
alternative to the immediateFlush=true
configuration.isEndOfBatch
in interface LogEvent
public void setEndOfBatch(boolean endOfBatch)
LogEvent
immediateFlush=true
configuration.setEndOfBatch
in interface LogEvent
endOfBatch
- true
if this event is the last one in a batch, false
otherwise.public long getNanoTime()
LogEvent
getNanoTime
in interface LogEvent
public void setNanoTime(long nanoTime)
protected Object writeReplace()
public Log4jLogEvent createMemento()
MutableLogEvent
.
If isIncludeLocation()
is true, this will obtain caller location information.MutableLogEvent
public void initializeBuilder(Log4jLogEvent.Builder builder)
Log4jLogEvent.Builder
from this MutableLogEvent
.builder
- the builder whose fields to populateCopyright © 1999-2019 The Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.