Package org.apache.logging.log4j.core.layout

Log4j 2 Layout support. Layout plugins should use the plugin category Core and the element type layout.

Interface Summary

Interface	Description
AbstractStringLayout.Serializer
AbstractStringLayout.Serializer2	Variation of AbstractStringLayout.Serializer that avoids allocating temporary objects.
ByteBufferDestination	ByteBufferDestination is the destination that Encoders write binary data to.
Encoder<T>	Objects implementing the Encoder interface know how to convert an object to some binary representation and write the result to a ByteBuffer, ideally without creating temporary objects.
PatternSelector	Allows different patterns to be used with the PatternLayout based on some selection criteria.

Class Summary

Class	Description
AbstractCsvLayout	A superclass for Comma-Separated Value (CSV) layouts.
AbstractLayout<T extends Serializable>	Abstract base class for Layouts.
AbstractLayout.Builder<B extends AbstractLayout.Builder<B>>	Subclasses can extend this abstract Builder.
AbstractStringLayout	Abstract base class for Layouts that result in a String.
AbstractStringLayout.Builder<B extends AbstractStringLayout.Builder<B>>
ByteBufferDestinationHelper	Helper class for ByteBufferDestination implementors.
CsvLogEventLayout	A Comma-Separated Value (CSV) layout to log events.
CsvParameterLayout	A Comma-Separated Value (CSV) layout to log event parameters.
GelfLayout	Lays out events in the Graylog Extended Log Format (GELF) 1.1.
GelfLayout.Builder<B extends GelfLayout.Builder<B>>
HtmlLayout	Outputs events as rows in an HTML table on an HTML page.
HtmlLayout.Builder
JsonLayout	Appends a series of JSON events as strings serialized as bytes.
JsonLayout.Builder<B extends JsonLayout.Builder<B>>
LockingStringBuilderEncoder	Encoder for StringBuilders that locks on the ByteBufferDestination.
LoggerFields	A LoggerFields container.
MarkerPatternSelector	Selects the pattern to use based on the Marker in the LogEvent.
MarkerPatternSelector.Builder	Custom MarkerPatternSelector builder.
MessageLayout	Formats a LogEvent in its Message form.
PatternLayout	A flexible layout configurable with pattern string.
PatternLayout.Builder	Custom PatternLayout builder.
PatternLayout.SerializerBuilder
PatternMatch	PatternMatch configuration item.
PatternMatch.Builder
Rfc5424Layout	Formats a log event in accordance with RFC 5424.
ScriptPatternSelector	Selects the pattern to use based on the Marker in the LogEvent.
ScriptPatternSelector.Builder	Custom ScriptPatternSelector builder.
SerializedLayout	Deprecated. Java Serialization has inherent security weaknesses, see https://www.owasp.org/index.php/Deserialization_of_untrusted_data .
StringBuilderEncoder	Encoder for StringBuilders that uses ThreadLocals to avoid locking as much as possible.
SyslogLayout	Formats a log event as a BSD Log record.
SyslogLayout.Builder<B extends SyslogLayout.Builder<B>>	Builds a SyslogLayout.
TextEncoderHelper	Helper class to encode text to binary data without allocating temporary objects.
XmlLayout	Appends a series of event elements as defined in the log4j.dtd.
XmlLayout.Builder<B extends XmlLayout.Builder<B>>
YamlLayout	Appends a series of YAML events as strings serialized as bytes.
YamlLayout.Builder<B extends YamlLayout.Builder<B>>

Enum Summary

Enum	Description
GelfLayout.CompressionType
HtmlLayout.FontSize	Possible font sizes