SyslogLayout.Builder

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

Description

private String

escapeNL

private Facility

facility

private boolean

includeNewLine
Constructor Summary

Constructors

Constructor

Description

Builder()
Method Summary

Modifier and Type

Method

Description

SyslogLayout

build()

Builds the object after all configuration has been set.

String

getEscapeNL()

Facility

getFacility()

boolean

isIncludeNewLine()

B

setEscapeNL(String escapeNL)

B

setFacility(Facility facility)

B

setIncludeNewLine(boolean includeNewLine)

Methods inherited from class AbstractStringLayout.Builder
getCharset, getFooterSerializer, getHeaderSerializer, setCharset, setFooterSerializer, setHeaderSerializer

Methods inherited from class AbstractLayout.Builder
asBuilder, getConfiguration, getFooter, getHeader, setConfiguration, setFooter, setHeader

Methods inherited from class Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface Builder
getErrorPrefix, isValid

Field Details
- facility
  
  @PluginBuilderAttribute private Facility facility
- includeNewLine
  
  @PluginBuilderAttribute("newLine") private boolean includeNewLine
- escapeNL
  
  @PluginBuilderAttribute("newLineEscape") private String escapeNL
Constructor Details
- Builder
  
  public Builder()
Method Details
- 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<B extends SyslogLayout.Builder<B>>
  
  Returns:
  
  the configured instance.
- getFacility
  
  public Facility getFacility()
- isIncludeNewLine
  
  public boolean isIncludeNewLine()
- getEscapeNL
  
  public String getEscapeNL()
- setFacility
  
  public B setFacility(Facility facility)
- setIncludeNewLine
  
  public B setIncludeNewLine(boolean includeNewLine)
- setEscapeNL
  
  public B setEscapeNL(String escapeNL)