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

Class JsonLayout.Builder<B extends JsonLayout.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.AbstractJacksonLayout.Builder<B>

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

All Implemented Interfaces:

Builder<JsonLayout>

Enclosing class:

JsonLayout

public static class JsonLayout.Builder<B extends JsonLayout.Builder<B>>
extends AbstractJacksonLayout.Builder<B>
implements Builder<JsonLayout>

Field Summary

Fields

Modifier and Type	Field	Description
private KeyValuePair[]	additionalFields
private boolean	objectMessageAsJsonObject
private boolean	propertiesAsList

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
JsonLayout	build()	Builds the object after all configuration has been set.
KeyValuePair[]	getAdditionalFields()
boolean	getObjectMessageAsJsonObject()
boolean	isPropertiesAsList()
B	setAdditionalFields(KeyValuePair[] additionalFields)	Additional fields to set on each log event.
B	setObjectMessageAsJsonObject(boolean objectMessageAsJsonObject)
B	setPropertiesAsList(boolean propertiesAsList)

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

getEndOfLine, getEventEol, isCompact, isComplete, isIncludeNullDelimiter, isIncludeStacktrace, isIncludeTimeMillis, isLocationInfo, isProperties, isStacktraceAsString, setCompact, setComplete, setEndOfLine, setEventEol, setIncludeNullDelimiter, setIncludeStacktrace, setIncludeTimeMillis, setLocationInfo, setProperties, setStacktraceAsString, toStringOrNull

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

Methods inherited from interface org.apache.logging.log4j.core.util.Builder

getErrorPrefix, isValid

Field Detail

propertiesAsList

@PluginBuilderAttribute
private boolean propertiesAsList

objectMessageAsJsonObject

@PluginBuilderAttribute
private boolean objectMessageAsJsonObject

additionalFields

@PluginElement("AdditionalField")
private KeyValuePair[] additionalFields

Constructor Detail

Builder

public Builder()

Method Detail

build

public JsonLayout 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 JsonLayout.Builder<B>>

Returns:

the configured instance.

isPropertiesAsList

public boolean isPropertiesAsList()

setPropertiesAsList

public B setPropertiesAsList(boolean propertiesAsList)

getObjectMessageAsJsonObject

public boolean getObjectMessageAsJsonObject()

setObjectMessageAsJsonObject

public B setObjectMessageAsJsonObject(boolean objectMessageAsJsonObject)

getAdditionalFields

public KeyValuePair[] getAdditionalFields()

Overrides:

getAdditionalFields in class AbstractJacksonLayout.Builder<B extends JsonLayout.Builder<B>>

setAdditionalFields

public B setAdditionalFields(KeyValuePair[] additionalFields)

Description copied from class: AbstractJacksonLayout.Builder

Additional fields to set on each log event.

Overrides:

setAdditionalFields in class AbstractJacksonLayout.Builder<B extends JsonLayout.Builder<B>>

Returns:

this builder