org.apache.logging.log4j.core.layout

Class AbstractStringLayout

java.lang.Object

org.apache.logging.log4j.core.layout.AbstractLayout<String>

org.apache.logging.log4j.core.layout.AbstractStringLayout

All Implemented Interfaces:

Layout<String>

Direct Known Subclasses:

HTMLLayout, JSONLayout, PatternLayout, RFC5424Layout, SyslogLayout, XMLLayout

public abstract class AbstractStringLayout
extends AbstractLayout<String>

Abstract base class for Layouts that result in a String.

Field Summary

Fields inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

footer, header, LOGGER

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	AbstractStringLayout(Charset charset)

Method Summary

Methods

Modifier and Type	Method and Description
protected Charset	getCharset()
String	getContentType() Returns the content type output by this layout.
byte[]	toByteArray(LogEvent event) Formats the Log Event as a byte array.

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractLayout

getFooter, getHeader, setFooter, setHeader

Methods inherited from class java.lang.Object

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

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

getContentFormat, toSerializable

Constructor Detail

AbstractStringLayout

protected AbstractStringLayout(Charset charset)

Method Detail

toByteArray

public byte[] toByteArray(LogEvent event)

Formats the Log Event as a byte array.

Parameters:

event - The Log Event.

Returns:

The formatted event as a byte array.

getContentType

public String getContentType()

Description copied from interface: Layout

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

Returns:

The default content type for Strings.

getCharset

protected Charset getCharset()