Package org.apache.logging.log4j.core.config

Class DefaultLayout

java.lang.Object

org.apache.logging.log4j.core.config.DefaultLayout

All Implemented Interfaces:

Layout<java.lang.String>, Encoder<LogEvent>, StringLayout

final class DefaultLayout
extends java.lang.Object
implements StringLayout

A simple layout used only by DefaultConfiguration

This layout allows to create applications that don't contain PatternLayout and all its patterns, e.g. GraalVM applications.

Since:

2.25.0

Field Summary

Fields

Modifier and Type	Field	Description
(package private) static StringLayout	INSTANCE

Fields inherited from interface org.apache.logging.log4j.core.Layout

ELEMENT_TYPE

Constructor Summary

Constructors

Modifier	Constructor	Description
private	DefaultLayout()

Method Summary

Modifier and Type	Method	Description
void	encode(LogEvent event, ByteBufferDestination destination)	Encodes the specified source object to some binary representation and writes the result to the specified destination.
java.nio.charset.Charset	getCharset()	Gets the Charset this layout uses to encode Strings into bytes.
java.util.Map<java.lang.String,java.lang.String>	getContentFormat()	Returns a description of the content format.
java.lang.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.
java.lang.String	toSerializable(LogEvent event)	Formats the event as an Object that can be serialized.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

INSTANCE

static final StringLayout INSTANCE

Constructor Detail

DefaultLayout

private DefaultLayout()

Method Detail

toSerializable

public java.lang.String toSerializable(LogEvent event)

Description copied from interface: Layout

Formats the event as an Object that can be serialized.

Specified by:

toSerializable in interface Layout<java.lang.String>

Parameters:

event - The Logging Event.

Returns:

The formatted event.

toByteArray

public byte[] toByteArray(LogEvent event)

Description copied from interface: Layout

Formats the event suitable for display.

Specified by:

toByteArray in interface Layout<java.lang.String>

Parameters:

event - The Logging Event.

Returns:

The formatted event.

encode

public void encode(LogEvent event,
                   ByteBufferDestination destination)

Description copied from interface: Encoder

Encodes the specified source object to some binary representation and writes the result to the specified destination.

Specified by:

encode in interface Encoder<LogEvent>

Parameters:

event - the object to encode.

destination - holds the ByteBuffer to write into.

getContentType

public java.lang.String getContentType()

Description copied from interface: Layout

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

Specified by:

getContentType in interface Layout<java.lang.String>

Returns:

the content type.

getCharset

public java.nio.charset.Charset getCharset()

Description copied from interface: StringLayout

Gets the Charset this layout uses to encode Strings into bytes.

Specified by:

getCharset in interface StringLayout

Returns:

the Charset this layout uses to encode Strings into bytes.

getFooter

public byte[] getFooter()

Description copied from interface: Layout

Returns the format for the layout format.

Specified by:

getFooter in interface Layout<java.lang.String>

Returns:

The footer.

getHeader

public byte[] getHeader()

Description copied from interface: Layout

Returns the header for the layout format.

Specified by:

getHeader in interface Layout<java.lang.String>

Returns:

The header.

getContentFormat

public java.util.Map<java.lang.String,java.lang.String> getContentFormat()

Description copied from interface: Layout

Returns a description of the content format.

Specified by:

getContentFormat in interface Layout<java.lang.String>

Returns:

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