Package org.apache.logging.log4j.message
Class ParameterizedNoReferenceMessageFactory.StatusMessage
java.lang.Object
org.apache.logging.log4j.message.ParameterizedNoReferenceMessageFactory.StatusMessage
- All Implemented Interfaces:
Serializable
,Message
- Enclosing class:
- ParameterizedNoReferenceMessageFactory
Message implementation that only keeps a reference to the error text and the error (if any), not to the
message parameters, in order to avoid memory leaks. This addresses LOG4J2-1368.
- Since:
- 2.6
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionGets the format portion of the Message.Gets the Message formatted as a String.Object[]
Gets parameter values, if any.Gets the throwable, if any.
-
Field Details
-
serialVersionUID
private static final long serialVersionUID- See Also:
-
formattedMessage
-
throwable
-
-
Constructor Details
-
StatusMessage
-
-
Method Details
-
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 withAsynchronouslyFormattable
. 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, theformatTo(StringBuilder)
method will be called so the Message can format its contents without creating intermediate String objects.- Specified by:
getFormattedMessage
in interfaceMessage
- Returns:
- The message String.
-
getFormat
Description copied from interface:Message
Gets the format portion of the Message.- Specified by:
getFormat
in interfaceMessage
- 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
Description copied from interface:Message
Gets parameter values, if any.- Specified by:
getParameters
in interfaceMessage
- Returns:
- An array of parameter values or null.
-
getThrowable
Description copied from interface:Message
Gets the throwable, if any.- Specified by:
getThrowable
in interfaceMessage
- Returns:
- the throwable or null.
-