org.apache.logging.log4j.message

Class DefaultFlowMessageFactory.AbstractFlowMessage

java.lang.Object

org.apache.logging.log4j.message.DefaultFlowMessageFactory.AbstractFlowMessage

All Implemented Interfaces:

java.io.Serializable, FlowMessage, Message

Direct Known Subclasses:

DefaultFlowMessageFactory.SimpleEntryMessage, DefaultFlowMessageFactory.SimpleExitMessage

Enclosing class:

DefaultFlowMessageFactory

private static class DefaultFlowMessageFactory.AbstractFlowMessage
extends java.lang.Object
implements FlowMessage

Field Summary

Fields

Modifier and Type	Field and Description
private Message	message
private static long	serialVersionUID
private java.lang.String	text

Constructor Summary

Constructors

Constructor and Description
AbstractFlowMessage(java.lang.String text, Message message)

Method Summary

Modifier and Type	Method and Description
java.lang.String	getFormat() Gets the format portion of the Message.
java.lang.String	getFormattedMessage() Gets the Message formatted as a String.
Message	getMessage() The wrapped message
java.lang.Object[]	getParameters() Gets parameter values, if any.
java.lang.String	getText() The message text like "Enter" or "Exit" used to prefix the actual Message.
java.lang.Throwable	getThrowable() Gets the throwable, if any.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

See Also:

Constant Field Values

message

private final Message message

text

private final java.lang.String text

Constructor Detail

AbstractFlowMessage

AbstractFlowMessage(java.lang.String text,
                    Message message)

Method Detail

getFormattedMessage

public java.lang.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 java.lang.String getFormat()

Description copied from interface: Message

Gets the format portion of the Message.

Specified by:

getFormat in interface Message

Returns:

The message format. Some implementations, such as ParameterizedMessage, will use this as the message "pattern". Other Messages may simply return an empty String. TODO Do all messages have a format? What syntax? Using a Formatter object could be cleaner. (RG) In SimpleMessage the format is identical to the formatted message. In ParameterizedMessage and StructuredDataMessage it is not. It is up to the Message implementer to determine what this method will return. A Formatter is inappropriate as this is very specific to the Message implementation so it isn't clear to me how having a Formatter separate from the Message would be cleaner.

getParameters

public java.lang.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 java.lang.Throwable getThrowable()

Description copied from interface: Message

Gets the throwable, if any.

Specified by:

getThrowable in interface Message

Returns:

the throwable or null.

getMessage

public Message getMessage()

Description copied from interface: FlowMessage

The wrapped message

Specified by:

getMessage in interface FlowMessage

Returns:

the wrapped message

getText

public java.lang.String getText()

Description copied from interface: FlowMessage

The message text like "Enter" or "Exit" used to prefix the actual Message.

Specified by:

getText in interface FlowMessage

Returns:

message text used to prefix the actual Message.