Package org.apache.logging.log4j.message
Class ReusableParameterizedMessage
java.lang.Object
org.apache.logging.log4j.message.ReusableParameterizedMessage
- All Implemented Interfaces:
Serializable
,Message
,ParameterVisitable
,ReusableMessage
,StringBuilderFormattable
public class ReusableParameterizedMessage
extends Object
implements ReusableMessage, ParameterVisitable
Reusable parameterized message. This message is mutable and is not safe to be accessed or modified by multiple
threads concurrently.
- Since:
- 2.6
- See Also:
-
Constructor Summary
-
Method Summary
Modifier and TypeMethodDescriptionvoid
clear()
<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 builder) Writes a text representation of this object into the specifiedStringBuilder
, ideally without allocating temporary objects.Returns the message pattern.Returns the formatted message.short
Returns the number of parameters that was used to initialize this reusable message for the current content.Object[]
Returns the message parameters.Returns the Throwable that was given as the last argument, if any.memento()
Returns an immutable snapshot of the current internal state of this reusable message.Object[]
swapParameters
(Object[] emptyReplacement) Returns the parameter array that was used to initialize this reusable message and replaces it with the specified array.toString()
-
Constructor Details
-
ReusableParameterizedMessage
public ReusableParameterizedMessage()Creates a reusable message.
-
-
Method Details
-
swapParameters
Description copied from interface:ReusableMessage
Returns the parameter array that was used to initialize this reusable message and replaces it with the specified array. The returned parameter array will no longer be modified by this reusable message. The specified array is now "owned" by this reusable message and can be modified if necessary for the next log event.ReusableMessages that have no parameters return the specified array.
This method is used by asynchronous loggers to pass the parameter array to a background thread without allocating new objects. The actual number of parameters in the returned array can be determined with
ReusableMessage.getParameterCount()
.- Specified by:
swapParameters
in interfaceReusableMessage
- Parameters:
emptyReplacement
- the parameter array that can be used for subsequent uses of this reusable message. This replacement array must have at least 10 elements (the number of varargs supported by the Logger API).- Returns:
- the parameter array for the current message content. This may be a vararg array of any length, or it may be a reusable array of 10 elements used to hold the unrolled vararg parameters.
- See Also:
-
getParameterCount
public short getParameterCount()Description copied from interface:ReusableMessage
Returns the number of parameters that was used to initialize this reusable message for the current content.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.- Specified by:
getParameterCount
in interfaceReusableMessage
- Returns:
- the current number of parameters
-
forEachParameter
Description copied from interface:ParameterVisitable
Performs the given action for each parameter until all values have been processed or the action throws an exception.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.
- Specified by:
forEachParameter
in interfaceParameterVisitable
- Type Parameters:
S
- type of the third parameter- Parameters:
action
- 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.
-
memento
Description copied from interface:ReusableMessage
Returns an immutable snapshot of the current internal state of this reusable message. The returned snapshot will not be affected by subsequent modifications of this reusable message.- Specified by:
memento
in interfaceReusableMessage
- Returns:
- an immutable snapshot of this message
-
getFormat
Returns the message pattern. -
getParameters
Returns the message parameters.- Specified by:
getParameters
in interfaceMessage
- Returns:
- the message parameters.
-
getThrowable
Returns the Throwable that was given as the last argument, if any. It will not survive serialization. The Throwable exists as part of the message primarily so that it can be extracted from the end of the list of parameters and then be added to the LogEvent. As such, the Throwable in the event should not be used once the LogEvent has been constructed.- Specified by:
getThrowable
in interfaceMessage
- Returns:
- the Throwable, if any.
-
getFormattedMessage
Returns the formatted message.- Specified by:
getFormattedMessage
in interfaceMessage
- Returns:
- the formatted message.
-
formatTo
Description copied from interface:StringBuilderFormattable
Writes a text representation of this object into the specifiedStringBuilder
, ideally without allocating temporary objects.- Specified by:
formatTo
in interfaceStringBuilderFormattable
- Parameters:
builder
- the StringBuilder to write into
-
toString
-
clear
public void clear()
-