org.apache.logging.log4j.message

Class ReusableObjectMessage

java.lang.Object

org.apache.logging.log4j.message.ReusableObjectMessage

All Implemented Interfaces:

Serializable, Message, ParameterVisitable, ReusableMessage, StringBuilderFormattable

public class ReusableObjectMessage
extends Object
implements ReusableMessage, ParameterVisitable

Mutable Message wrapper around an Object message.

Since:

2.6

See Also:

Serialized Form

Constructor Summary

Constructors

Constructor and Description
ReusableObjectMessage()

Method Summary

Modifier and Type	Method and Description
void	clear() Resets the object to a clean state.
<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.
String	getFormat() Returns the object formatted using its toString method.
String	getFormattedMessage() Returns the formatted object message.
Object	getParameter() Returns the object parameter.
short	getParameterCount() This message has exactly one parameter (the object), so always returns one.
Object[]	getParameters() Returns the object as if it were a parameter.
Throwable	getThrowable() Gets the message if it is a throwable.
Message	memento() Returns an immutable snapshot of the current internal state of this reusable message.
void	set(Object object)
Object[]	swapParameters(Object[] emptyReplacement) This message has exactly one parameter (the object), so returns it as the first parameter in the array.
String	toString()

Methods inherited from class java.lang.Object

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

Constructor Detail

ReusableObjectMessage

public ReusableObjectMessage()

Method Detail

set

public void set(Object object)

getFormattedMessage

public String getFormattedMessage()

Returns the formatted object message.

Specified by:

getFormattedMessage in interface Message

Returns:

the formatted object message.

formatTo

public void formatTo(StringBuilder buffer)

Description copied from interface: StringBuilderFormattable

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Specified by:

formatTo in interface StringBuilderFormattable

Parameters:

buffer - the StringBuilder to write into

getFormat

public String getFormat()

Returns the object formatted using its toString method.

Specified by:

getFormat in interface Message

Returns:

the String representation of the object.

getParameter

public Object getParameter()

Returns the object parameter.

Returns:

The object.

Since:

2.7

getParameters

public Object[] getParameters()

Returns the object as if it were a parameter.

Specified by:

getParameters in interface Message

Returns:

The object.

toString

public String toString()

Overrides:

toString in class Object

getThrowable

public Throwable getThrowable()

Gets the message if it is a throwable.

Specified by:

getThrowable in interface Message

Returns:

the message if it is a throwable.

swapParameters

public Object[] swapParameters(Object[] emptyReplacement)

This message has exactly one parameter (the object), so returns it as the first parameter in the array.

Specified by:

swapParameters in interface ReusableMessage

Parameters:

emptyReplacement - the parameter array to return

Returns:

the specified array

See Also:

ReusableMessage.getParameterCount()

getParameterCount

public short getParameterCount()

This message has exactly one parameter (the object), so always returns one.

Specified by:

getParameterCount in interface ReusableMessage

Returns:

1

forEachParameter

public <S> void forEachParameter(ParameterConsumer<S> action,
                                 S state)

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 interface ParameterVisitable

Type Parameters:

S - type of the third parameter

Parameters:

action - The action to be performed for each key-value pair in this collection

state - the object to be passed as the third parameter to each invocation on the specified ParameterConsumer.

memento

public Message 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 interface ReusableMessage

Returns:

an immutable snapshot of this message

clear

public void clear()

Resets the object to a clean state.