Package org.apache.logging.log4j.message
Interface MultiformatMessage
-
- All Superinterfaces:
Message
,java.io.Serializable
- All Known Implementing Classes:
MapMessage
,StringMapMessage
,StructuredDataMessage
public interface MultiformatMessage extends Message
A Message that can render itself in more than one way. The format string is used by the Message implementation as extra information that it may use to help it to determine how to format itself. For example, MapMessage accepts a format of "XML" to tell it to render the Map as XML instead of its default format of {key1="value1" key2="value2"}.
-
-
Method Summary
All Methods Instance Methods Abstract Methods Modifier and Type Method Description java.lang.String[]
getFormats()
Returns the supported formats.java.lang.String
getFormattedMessage(java.lang.String[] formats)
Returns the Message formatted as a String.-
Methods inherited from interface org.apache.logging.log4j.message.Message
getFormat, getFormattedMessage, getParameters, getThrowable
-
-
-
-
Method Detail
-
getFormattedMessage
java.lang.String getFormattedMessage(java.lang.String[] formats)
Returns the Message formatted as a String.- Parameters:
formats
- An array of Strings that provide extra information about how to format the message. Each MultiformatMessage implementation is free to use the provided formats however they choose.- Returns:
- The message String.
-
getFormats
java.lang.String[] getFormats()
Returns the supported formats.- Returns:
- The supported formats.
-
-