Package org.apache.logging.log4j.core

Interface Layout<T extends Serializable>

Type Parameters:

T - The Serializable type returned by toSerializable(LogEvent)

All Superinterfaces:

Encoder<LogEvent>

All Known Subinterfaces:

StringLayout

All Known Implementing Classes:

AbstractCsvLayout, AbstractLayout, AbstractStringLayout, CsvLogEventLayout, CsvParameterLayout, GelfLayout, HtmlLayout, JsonLayout, MessageLayout, PatternLayout, Rfc5424Layout, SerializedLayout, SyslogLayout, XmlLayout, YamlLayout

public interface Layout<T extends Serializable>
extends Encoder<LogEvent>

Lays out a LogEvent in different formats. The formats are:

• byte[]
• an implementer of Serializable, like byte[]
• String
• LogEvent

Since 2.6, Layouts can encode a LogEvent directly to a ByteBufferDestination without creating temporary intermediary objects.

Field Summary

Fields

Modifier and Type	Field	Description
static final String	ELEMENT_TYPE	Main plugin element type for Layout plugins.

Method Summary

Modifier and Type	Method	Description
Map<String,String>	getContentFormat()	Returns a description of the content format.
String	getContentType()	Returns the content type output by this layout.
byte[]	getFooter()	Returns the format for the layout format.
byte[]	getHeader()	Returns the header for the layout format.
byte[]	toByteArray(LogEvent event)	Formats the event suitable for display.
T	toSerializable(LogEvent event)	Formats the event as an Object that can be serialized.

Methods inherited from interface org.apache.logging.log4j.core.layout.Encoder

encode

Field Details

ELEMENT_TYPE

static final String ELEMENT_TYPE

Main plugin element type for Layout plugins.

Since:

2.1

See Also:

• Constant Field Values

Method Details

getFooter

byte[] getFooter()

Returns the format for the layout format.

Returns:

The footer.

getHeader

byte[] getHeader()

Returns the header for the layout format.

Returns:

The header.

toByteArray

byte[] toByteArray(LogEvent event)

Formats the event suitable for display.

Parameters:

event - The Logging Event.

Returns:

The formatted event.

toSerializable

T toSerializable(LogEvent event)

Formats the event as an Object that can be serialized.

Parameters:

event - The Logging Event.

Returns:

The formatted event.

getContentType

String getContentType()

Returns the content type output by this layout. The base class returns "text/plain".

Returns:

the content type.

getContentFormat

Map<String,String> getContentFormat()

Returns a description of the content format.

Returns:

a Map of key/value pairs describing the Layout-specific content format, or an empty Map if no content format descriptors are specified.