Package org.apache.logging.log4j.util

Interface MultiFormatStringBuilderFormattable

All Superinterfaces:

Message, MultiformatMessage, Serializable, StringBuilderFormattable

All Known Implementing Classes:

MapMessage, StringMapMessage, StructuredDataMessage

public interface MultiFormatStringBuilderFormattable
extends MultiformatMessage, StringBuilderFormattable

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"}.

Since:

2.10

Method Summary

Modifier and Type	Method	Description
void	formatTo(String[] formats, StringBuilder buffer)	Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Methods inherited from interface org.apache.logging.log4j.message.Message

getFormat, getFormattedMessage, getParameters, getThrowable

Methods inherited from interface org.apache.logging.log4j.message.MultiformatMessage

getFormats, getFormattedMessage

Methods inherited from interface org.apache.logging.log4j.util.StringBuilderFormattable

formatTo

Method Detail

formatTo

void formatTo(String[] formats,
              StringBuilder buffer)

Writes a text representation of this object into the specified StringBuilder, ideally without allocating temporary objects.

Parameters:

formats - An array of Strings that provide extra information about how to format the message. Each MultiFormatStringBuilderFormattable implementation is free to use the provided formats however they choose.

buffer - the StringBuilder to write into