Package org.apache.logging.log4j.message

Public Message Types used for Log4j 2. Users may implement their own Messages.

Interface Summary

Interface	Description
EntryMessage	Entry flow messages
ExitMessage	Exit flow messages
FlowMessage	Flow messages
FlowMessageFactory	Creates flow messages.
LoggerNameAwareMessage	Message that is interested in the name of the Logger.
Message	An interface for various Message implementations that can be logged.
MessageCollectionMessage<T>	A Message that is a collection of Messages.
MessageFactory	Creates messages.
MessageFactory2	Creates messages.
MultiformatMessage	A Message that can render itself in more than one way.
ParameterConsumer<S>	An operation that accepts two input arguments and returns no result.
ParameterVisitable	Allows message parameters to be iterated over without any allocation or memory copies.
ReusableMessage	Messages implementing this interface are reused between logging calls.
ThreadDumpMessage.ThreadInfoFactory	Factory to create Thread information.
ThreadInformation	Interface used to print basic or extended thread information.
TimestampMessage	Messages that use this interface will cause the timestamp in the message to be used instead of the timestamp in the LogEvent.

Class Summary

Class	Description
AbstractMessageFactory	Provides an abstract superclass for MessageFactory2 implementations with default implementations (and for MessageFactory by extension).
DefaultFlowMessageFactory	Default factory for flow messages.
FormattedMessage	Handles messages that contain a format String.
FormattedMessageFactory	Creates FormattedMessage instances for MessageFactory2 methods (and MessageFactory by extension.)
LocalizedMessage	Provides some level of compatibility with Log4j 1.x and convenience but is not the recommended way to Localize messages.
LocalizedMessageFactory	Creates FormattedMessage instances for MessageFactory2 methods (and MessageFactory by extension.)
MapMessage<M extends MapMessage<M,V>,V>	Represents a Message that consists of a Map.
MessageFormatMessage	Handles messages that consist of a format string conforming to java.text.MessageFormat.
MessageFormatMessageFactory	Creates FormattedMessage instances for MessageFactory2 methods (and MessageFactory by extension.)
ObjectArrayMessage	Handles messages that contain an Object[].
ObjectMessage	Handles messages that contain an Object.
ParameterizedMessage	Handles messages that consist of a format string containing '{}' to represent each replaceable token, and the parameters.
ParameterizedMessageFactory	Creates FormattedMessage instances for MessageFactory2 methods (and MessageFactory by extension.)
ParameterizedNoReferenceMessageFactory	Creates FormattedMessage instances for MessageFactory2 methods (and MessageFactory by extension.)
ReusableMessageFactory	Implementation of the MessageFactory interface that avoids allocating temporary objects where possible.
ReusableObjectMessage	Mutable Message wrapper around an Object message.
ReusableParameterizedMessage	Reusable parameterized message.
ReusableSimpleMessage	Mutable Message wrapper around a String message.
SimpleMessage	The simplest possible implementation of Message.
SimpleMessageFactory	Creates FormattedMessage instances for MessageFactory2 methods (and MessageFactory by extension.)
StringFormattedMessage	Handles messages that consist of a format string conforming to Formatter.
StringFormatterMessageFactory	Creates FormattedMessage instances for MessageFactory2 methods (and MessageFactory by extension.)
StringMapMessage	A StringMapMessage typed to String-only values.
StructuredDataCollectionMessage	A collection of StructuredDataMessages.
StructuredDataId	The StructuredData identifier.
StructuredDataMessage	Represents a Message that conforms to an RFC 5424 StructuredData element along with the syslog message.
ThreadDumpMessage	Captures information about all running Threads.

Enum Summary

Enum	Description
MapMessage.MapFormat	When set as the format specifier causes the Map to be formatted as XML.
StructuredDataMessage.Format	Supported formats.

Annotation Types Summary

Annotation Type	Description
AsynchronouslyFormattable	Annotation that signals to asynchronous logging components that messages of this type can safely be passed to a background thread without calling Message.getFormattedMessage() first.