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

Class PatternLayout.Builder

java.lang.Object

org.apache.logging.log4j.core.layout.PatternLayout.Builder

All Implemented Interfaces:

Builder<PatternLayout>

Enclosing class:

PatternLayout

public static class PatternLayout.Builder
extends java.lang.Object
implements Builder<PatternLayout>

Custom PatternLayout builder. Use the builder factory method to create this.

Field Summary

Fields

Modifier and Type	Field	Description
private boolean	alwaysWriteExceptions
private java.nio.charset.Charset	charset
private Configuration	configuration
private boolean	disableAnsi
private java.lang.String	footer
private java.lang.String	header
private boolean	noConsoleNoAnsi
private java.lang.String	pattern
private PatternSelector	patternSelector
private RegexReplacement	regexReplacement

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder()

Method Summary

Modifier and Type	Method	Description
PatternLayout	build()	Builds the object after all configuration has been set.
PatternLayout.Builder	setAlwaysWriteExceptions(boolean alwaysWriteExceptions)
PatternLayout.Builder	setCharset(java.nio.charset.Charset charset)
PatternLayout.Builder	setConfiguration(Configuration configuration)
PatternLayout.Builder	setDisableAnsi(boolean disableAnsi)
PatternLayout.Builder	setFooter(java.lang.String footer)
PatternLayout.Builder	setHeader(java.lang.String header)
PatternLayout.Builder	setNoConsoleNoAnsi(boolean noConsoleNoAnsi)
PatternLayout.Builder	setPattern(java.lang.String pattern)
PatternLayout.Builder	setPatternSelector(PatternSelector patternSelector)
PatternLayout.Builder	setRegexReplacement(RegexReplacement regexReplacement)
PatternLayout.Builder	withAlwaysWriteExceptions(boolean alwaysWriteExceptions)	Deprecated. since 2.26.0 use setAlwaysWriteExceptions(boolean).
PatternLayout.Builder	withCharset(java.nio.charset.Charset charset)	Deprecated. since 2.26.0 use setCharset(Charset).
PatternLayout.Builder	withConfiguration(Configuration configuration)	Deprecated. since 2.26.0 use setConfiguration(Configuration).
PatternLayout.Builder	withDisableAnsi(boolean disableAnsi)	Deprecated. since 2.26.0 use setDisableAnsi(boolean).
PatternLayout.Builder	withFooter(java.lang.String footer)	Deprecated. since 2.26.0 use setFooter(String).
PatternLayout.Builder	withHeader(java.lang.String header)	Deprecated. since 2.26.0 use setHeader(String).
PatternLayout.Builder	withNoConsoleNoAnsi(boolean noConsoleNoAnsi)	Deprecated. since 2.26.0 use setNoConsoleNoAnsi(boolean).
PatternLayout.Builder	withPattern(java.lang.String pattern)	Deprecated. since 2.26.0 use setPattern(String).
PatternLayout.Builder	withPatternSelector(PatternSelector patternSelector)	Deprecated. since 2.26.0 use setPatternSelector(PatternSelector).
PatternLayout.Builder	withRegexReplacement(RegexReplacement regexReplacement)	Deprecated. since 2.26.0 use setRegexReplacement(RegexReplacement).

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.util.Builder

getErrorPrefix, isValid

Field Detail

pattern

@PluginBuilderAttribute
private java.lang.String pattern

patternSelector

@PluginElement("PatternSelector")
private PatternSelector patternSelector

configuration

@PluginConfiguration
private Configuration configuration

regexReplacement

@PluginElement("Replace")
private RegexReplacement regexReplacement

charset

@PluginBuilderAttribute
private java.nio.charset.Charset charset

alwaysWriteExceptions

@PluginBuilderAttribute
private boolean alwaysWriteExceptions

disableAnsi

@PluginBuilderAttribute
private boolean disableAnsi

noConsoleNoAnsi

@PluginBuilderAttribute
private boolean noConsoleNoAnsi

header

@PluginBuilderAttribute
private java.lang.String header

footer

@PluginBuilderAttribute
private java.lang.String footer

Constructor Detail

Builder

private Builder()

Method Detail

setPattern

public PatternLayout.Builder setPattern(java.lang.String pattern)

Parameters:

pattern - The pattern. If not specified, defaults to DEFAULT_CONVERSION_PATTERN.

Since:

2.26.0

setPatternSelector

public PatternLayout.Builder setPatternSelector(PatternSelector patternSelector)

Parameters:

patternSelector - Allows different patterns to be used based on some selection criteria.

Since:

2.26.0

setConfiguration

public PatternLayout.Builder setConfiguration(Configuration configuration)

Parameters:

configuration - The Configuration. Some Converters require access to the Interpolator.

Since:

2.26.0

setRegexReplacement

public PatternLayout.Builder setRegexReplacement(RegexReplacement regexReplacement)

Parameters:

regexReplacement - A Regex replacement

Since:

2.26.0

setCharset

public PatternLayout.Builder setCharset(java.nio.charset.Charset charset)

Parameters:

charset - The character set. The platform default is used if not specified.

Since:

2.26.0

setAlwaysWriteExceptions

public PatternLayout.Builder setAlwaysWriteExceptions(boolean alwaysWriteExceptions)

Parameters:

alwaysWriteExceptions - If "true" (default) exceptions are always written even if the pattern contains no exception tokens.

Since:

2.26.0

setDisableAnsi

public PatternLayout.Builder setDisableAnsi(boolean disableAnsi)

Parameters:

disableAnsi - If true, do not output ANSI escape codes.

Since:

2.26.0

setNoConsoleNoAnsi

public PatternLayout.Builder setNoConsoleNoAnsi(boolean noConsoleNoAnsi)

Parameters:

noConsoleNoAnsi - If "true" (default is false) and System.console() is null, do not output ANSI escape codes

Since:

2.26.0

setHeader

public PatternLayout.Builder setHeader(java.lang.String header)

Parameters:

header - The header to place at the top of the document, once.

Since:

2.26.0

setFooter

public PatternLayout.Builder setFooter(java.lang.String footer)

Parameters:

footer - The footer to place at the bottom of the document, once.

Since:

2.26.0

withPattern

@Deprecated
public PatternLayout.Builder withPattern(java.lang.String pattern)

Deprecated.

since 2.26.0 use setPattern(String).

withPatternSelector

@Deprecated
public PatternLayout.Builder withPatternSelector(PatternSelector patternSelector)

Deprecated.

since 2.26.0 use setPatternSelector(PatternSelector).

withConfiguration

@Deprecated
public PatternLayout.Builder withConfiguration(Configuration configuration)

Deprecated.

since 2.26.0 use setConfiguration(Configuration).

withRegexReplacement

@Deprecated
public PatternLayout.Builder withRegexReplacement(RegexReplacement regexReplacement)

Deprecated.

since 2.26.0 use setRegexReplacement(RegexReplacement).

withCharset

@Deprecated
public PatternLayout.Builder withCharset(java.nio.charset.Charset charset)

Deprecated.

since 2.26.0 use setCharset(Charset).

withAlwaysWriteExceptions

@Deprecated
public PatternLayout.Builder withAlwaysWriteExceptions(boolean alwaysWriteExceptions)

Deprecated.

since 2.26.0 use setAlwaysWriteExceptions(boolean).

withDisableAnsi

@Deprecated
public PatternLayout.Builder withDisableAnsi(boolean disableAnsi)

Deprecated.

since 2.26.0 use setDisableAnsi(boolean).

withNoConsoleNoAnsi

@Deprecated
public PatternLayout.Builder withNoConsoleNoAnsi(boolean noConsoleNoAnsi)

Deprecated.

since 2.26.0 use setNoConsoleNoAnsi(boolean).

withHeader

@Deprecated
public PatternLayout.Builder withHeader(java.lang.String header)

Deprecated.

since 2.26.0 use setHeader(String).

withFooter

@Deprecated
public PatternLayout.Builder withFooter(java.lang.String footer)

Deprecated.

since 2.26.0 use setFooter(String).

build

public PatternLayout 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<PatternLayout>

Returns:

the configured instance.