org.apache.logging.log4j.core.layout

Class SyslogLayout.Builder<B extends SyslogLayout.Builder<B>>

java.lang.Object

org.apache.logging.log4j.core.layout.AbstractLayout.Builder<B>

org.apache.logging.log4j.core.layout.AbstractStringLayout.Builder<B>

org.apache.logging.log4j.core.layout.SyslogLayout.Builder<B>

Type Parameters:

B - the builder type

All Implemented Interfaces:

Builder<SyslogLayout>

Enclosing class:

SyslogLayout

public static class SyslogLayout.Builder<B extends SyslogLayout.Builder<B>>
extends AbstractStringLayout.Builder<B>
implements Builder<SyslogLayout>

Builds a SyslogLayout.

The main arguments are

• facility: The Facility is used to try to classify the message.
• includeNewLine: If true a newline will be appended to the result.
• escapeNL: Pattern to use for replacing newlines.
• charset: The character set.

Field Summary

Fields

Modifier and Type	Field and Description
private java.lang.String	escapeNL
private Facility	facility
private boolean	includeNewLine

Constructor Summary

Constructors

Constructor and Description
Builder()

Method Summary

Modifier and Type	Method and Description
SyslogLayout	build() Builds the object after all configuration has been set.
java.lang.String	getEscapeNL()
Facility	getFacility()
boolean	isIncludeNewLine()
B	setEscapeNL(java.lang.String escapeNL)
B	setFacility(Facility facility)
B	setIncludeNewLine(boolean includeNewLine)

Methods inherited from class org.apache.logging.log4j.core.layout.AbstractStringLayout.Builder

getCharset, getFooterSerializer, getHeaderSerializer, setCharset, setFooterSerializer, setHeaderSerializer

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

asBuilder, getConfiguration, getFooter, getHeader, setConfiguration, setFooter, setHeader

Methods inherited from class java.lang.Object

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

Field Detail

facility

@PluginBuilderAttribute
private Facility facility

includeNewLine

@PluginBuilderAttribute(value="newLine")
private boolean includeNewLine

escapeNL

@PluginBuilderAttribute(value="newLineEscape")
private java.lang.String escapeNL

Constructor Detail

Builder

public Builder()

Method Detail

build

public SyslogLayout build()

Description copied from interface: Builder

Builds the object after all configuration has been set. This will use default values for any unspecified attributes for the object.

Specified by:

build in interface Builder<SyslogLayout>

Returns:

the configured instance.

getFacility

public Facility getFacility()

isIncludeNewLine

public boolean isIncludeNewLine()

getEscapeNL

public java.lang.String getEscapeNL()

setFacility

public B setFacility(Facility facility)

setIncludeNewLine

public B setIncludeNewLine(boolean includeNewLine)

setEscapeNL

public B setEscapeNL(java.lang.String escapeNL)