Package org.apache.logging.log4j.layout.template.json

Class JsonTemplateLayout.Builder

java.lang.Object

org.apache.logging.log4j.layout.template.json.JsonTemplateLayout.Builder

All Implemented Interfaces:

Builder<JsonTemplateLayout>

Enclosing class:

JsonTemplateLayout

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

Field Summary

Fields

Modifier and Type	Field	Description
private java.nio.charset.Charset	charset
private Configuration	configuration
private java.lang.String	eventDelimiter
private java.lang.String	eventTemplate
private JsonTemplateLayout.EventTemplateAdditionalField[]	eventTemplateAdditionalFields
private java.lang.String	eventTemplateRootObjectKey
private java.lang.String	eventTemplateUri
private boolean	locationInfoEnabled
private int	maxStringLength
private boolean	nullEventDelimiterEnabled
private RecyclerFactory	recyclerFactory
private java.lang.String	stackTraceElementTemplate
private java.lang.String	stackTraceElementTemplateUri
private boolean	stackTraceEnabled
private java.lang.String	truncatedStringSuffix

Constructor Summary

Constructors

Modifier	Constructor	Description
private	Builder()

Method Summary

Modifier and Type	Method	Description
JsonTemplateLayout	build()	Builds the object after all configuration has been set.
java.nio.charset.Charset	getCharset()
Configuration	getConfiguration()
java.lang.String	getEventDelimiter()
java.lang.String	getEventTemplate()
JsonTemplateLayout.EventTemplateAdditionalField[]	getEventTemplateAdditionalFields()
java.lang.String	getEventTemplateRootObjectKey()
java.lang.String	getEventTemplateUri()
int	getMaxStringLength()
RecyclerFactory	getRecyclerFactory()
java.lang.String	getStackTraceElementTemplate()
java.lang.String	getStackTraceElementTemplateUri()
java.lang.String	getTruncatedStringSuffix()
boolean	isLocationInfoEnabled()
boolean	isNullEventDelimiterEnabled()
boolean	isStackTraceEnabled()
JsonTemplateLayout.Builder	setCharset(java.nio.charset.Charset charset)
JsonTemplateLayout.Builder	setConfiguration(Configuration configuration)
JsonTemplateLayout.Builder	setEventDelimiter(java.lang.String eventDelimiter)
JsonTemplateLayout.Builder	setEventTemplate(java.lang.String eventTemplate)
JsonTemplateLayout.Builder	setEventTemplateAdditionalFields(JsonTemplateLayout.EventTemplateAdditionalField[] eventTemplateAdditionalFields)
JsonTemplateLayout.Builder	setEventTemplateRootObjectKey(java.lang.String eventTemplateRootObjectKey)
JsonTemplateLayout.Builder	setEventTemplateUri(java.lang.String eventTemplateUri)
JsonTemplateLayout.Builder	setLocationInfoEnabled(boolean locationInfoEnabled)
JsonTemplateLayout.Builder	setMaxStringLength(int maxStringLength)
JsonTemplateLayout.Builder	setNullEventDelimiterEnabled(boolean nullEventDelimiterEnabled)
JsonTemplateLayout.Builder	setRecyclerFactory(RecyclerFactory recyclerFactory)
JsonTemplateLayout.Builder	setStackTraceElementTemplate(java.lang.String stackTraceElementTemplate)
JsonTemplateLayout.Builder	setStackTraceElementTemplateUri(java.lang.String stackTraceElementTemplateUri)
JsonTemplateLayout.Builder	setStackTraceEnabled(boolean stackTraceEnabled)
JsonTemplateLayout.Builder	setTruncatedStringSuffix(java.lang.String truncatedStringSuffix)
private void	validate()

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

configuration

@PluginConfiguration
private Configuration configuration

charset

@PluginBuilderAttribute
private java.nio.charset.Charset charset

locationInfoEnabled

@PluginBuilderAttribute
private boolean locationInfoEnabled

stackTraceEnabled

@PluginBuilderAttribute
private boolean stackTraceEnabled

eventTemplate

@PluginBuilderAttribute
private java.lang.String eventTemplate

eventTemplateUri

@PluginBuilderAttribute
private java.lang.String eventTemplateUri

eventTemplateRootObjectKey

@PluginBuilderAttribute
private java.lang.String eventTemplateRootObjectKey

eventTemplateAdditionalFields

@PluginElement("EventTemplateAdditionalField")
private JsonTemplateLayout.EventTemplateAdditionalField[] eventTemplateAdditionalFields

stackTraceElementTemplate

@PluginBuilderAttribute
private java.lang.String stackTraceElementTemplate

stackTraceElementTemplateUri

@PluginBuilderAttribute
private java.lang.String stackTraceElementTemplateUri

eventDelimiter

@PluginBuilderAttribute
private java.lang.String eventDelimiter

nullEventDelimiterEnabled

@PluginBuilderAttribute
private boolean nullEventDelimiterEnabled

maxStringLength

@PluginBuilderAttribute
private int maxStringLength

truncatedStringSuffix

@PluginBuilderAttribute
private java.lang.String truncatedStringSuffix

recyclerFactory

@PluginBuilderAttribute
private RecyclerFactory recyclerFactory

Constructor Detail

Builder

private Builder()

Method Detail

getConfiguration

public Configuration getConfiguration()

setConfiguration

public JsonTemplateLayout.Builder setConfiguration(Configuration configuration)

getCharset

public java.nio.charset.Charset getCharset()

setCharset

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

isLocationInfoEnabled

public boolean isLocationInfoEnabled()

setLocationInfoEnabled

public JsonTemplateLayout.Builder setLocationInfoEnabled(boolean locationInfoEnabled)

isStackTraceEnabled

public boolean isStackTraceEnabled()

setStackTraceEnabled

public JsonTemplateLayout.Builder setStackTraceEnabled(boolean stackTraceEnabled)

getEventTemplate

public java.lang.String getEventTemplate()

setEventTemplate

public JsonTemplateLayout.Builder setEventTemplate(java.lang.String eventTemplate)

getEventTemplateUri

public java.lang.String getEventTemplateUri()

setEventTemplateUri

public JsonTemplateLayout.Builder setEventTemplateUri(java.lang.String eventTemplateUri)

getEventTemplateRootObjectKey

public java.lang.String getEventTemplateRootObjectKey()

setEventTemplateRootObjectKey

public JsonTemplateLayout.Builder setEventTemplateRootObjectKey(java.lang.String eventTemplateRootObjectKey)

getEventTemplateAdditionalFields

public JsonTemplateLayout.EventTemplateAdditionalField[] getEventTemplateAdditionalFields()

setEventTemplateAdditionalFields

public JsonTemplateLayout.Builder setEventTemplateAdditionalFields(JsonTemplateLayout.EventTemplateAdditionalField[] eventTemplateAdditionalFields)

getStackTraceElementTemplate

public java.lang.String getStackTraceElementTemplate()

setStackTraceElementTemplate

public JsonTemplateLayout.Builder setStackTraceElementTemplate(java.lang.String stackTraceElementTemplate)

getStackTraceElementTemplateUri

public java.lang.String getStackTraceElementTemplateUri()

setStackTraceElementTemplateUri

public JsonTemplateLayout.Builder setStackTraceElementTemplateUri(java.lang.String stackTraceElementTemplateUri)

getEventDelimiter

public java.lang.String getEventDelimiter()

setEventDelimiter

public JsonTemplateLayout.Builder setEventDelimiter(java.lang.String eventDelimiter)

isNullEventDelimiterEnabled

public boolean isNullEventDelimiterEnabled()

setNullEventDelimiterEnabled

public JsonTemplateLayout.Builder setNullEventDelimiterEnabled(boolean nullEventDelimiterEnabled)

getMaxStringLength

public int getMaxStringLength()

setMaxStringLength

public JsonTemplateLayout.Builder setMaxStringLength(int maxStringLength)

getTruncatedStringSuffix

public java.lang.String getTruncatedStringSuffix()

setTruncatedStringSuffix

public JsonTemplateLayout.Builder setTruncatedStringSuffix(java.lang.String truncatedStringSuffix)

getRecyclerFactory

public RecyclerFactory getRecyclerFactory()

setRecyclerFactory

public JsonTemplateLayout.Builder setRecyclerFactory(RecyclerFactory recyclerFactory)

build

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

Returns:

the configured instance.

validate

private void validate()