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

Class MementoMessage

java.lang.Object

org.apache.logging.log4j.core.impl.MementoMessage

All Implemented Interfaces:

Serializable, Message, StringBuilderFormattable

public final class MementoMessage
extends Object
implements Message, StringBuilderFormattable

Consider this class private. MementoMessage is intended to be used when we need to make an immutable copy of a Message without forgetting the original Message.getFormat() and Message.getParameters() values.

Since:

3.0

See Also:

• Serialized Form

Field Summary

Fields

Modifier and Type	Field	Description
private final String	format
private final String	formattedMessage
private final Object[]	parameters

Constructor Summary

Constructors

Constructor	Description
MementoMessage(String formattedMessage, String format, Object[] parameters)

Method Summary

Modifier and Type	Method	Description
void	formatTo(StringBuilder buffer)	Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.
String	getFormat()	This method has unclear semantics and inconsistent implementations – its usage is strongly discouraged.
String	getFormattedMessage()	Gets the Message formatted as a String.
Object[]	getParameters()	Gets parameter values, if any.
Throwable	getThrowable()	Always returns null.
String	toString()

Methods inherited from class java.lang.Object

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

Field Details

formattedMessage

private final String formattedMessage

format

private final String format

parameters

private final Object[] parameters

Constructor Details

MementoMessage

public MementoMessage(String formattedMessage,
 String format,
 Object[] parameters)

Method Details

getFormattedMessage

public String getFormattedMessage()

Description copied from interface: Message

Gets the Message formatted as a String. Each Message implementation determines the appropriate way to format the data encapsulated in the Message. Messages that provide more than one way of formatting the Message will implement MultiformatMessage.

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.

Specified by:

getFormattedMessage in interface Message

Returns:

The message String.

getFormat

public String getFormat()

Description copied from interface: Message

This method has unclear semantics and inconsistent implementations – its usage is strongly discouraged.

Specified by:

getFormat in interface Message

getParameters

public Object[] getParameters()

Description copied from interface: Message

Gets parameter values, if any.

Specified by:

getParameters in interface Message

Returns:

An array of parameter values or null.

getThrowable

public Throwable getThrowable()

Always returns null.

Specified by:

getThrowable in interface Message

Returns:

null

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

toString

public String toString()

Overrides:

toString in class Object