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 Object
implements Builder<JsonTemplateLayout>

Field Summary

Fields

Modifier and Type	Field	Description
private Charset	charset
private Configuration	configuration
private String	eventDelimiter
private String	eventTemplate
private JsonTemplateLayout.EventTemplateAdditionalField[]	eventTemplateAdditionalFields
private String	eventTemplateRootObjectKey
private String	eventTemplateUri
private boolean	locationInfoEnabled
private int	maxStringLength
private boolean	nullEventDelimiterEnabled
private RecyclerFactory	recyclerFactory
private String	stackTraceElementTemplate
private String	stackTraceElementTemplateUri
private boolean	stackTraceEnabled
private 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.
Charset	getCharset()
Configuration	getConfiguration()
String	getEventDelimiter()
String	getEventTemplate()
JsonTemplateLayout.EventTemplateAdditionalField[]	getEventTemplateAdditionalFields()
String	getEventTemplateRootObjectKey()
String	getEventTemplateUri()
int	getMaxStringLength()
RecyclerFactory	getRecyclerFactory()
String	getStackTraceElementTemplate()
String	getStackTraceElementTemplateUri()
String	getTruncatedStringSuffix()
boolean	isLocationInfoEnabled()
boolean	isNullEventDelimiterEnabled()
boolean	isStackTraceEnabled()
JsonTemplateLayout.Builder	setCharset(Charset charset)
JsonTemplateLayout.Builder	setConfiguration(Configuration configuration)
JsonTemplateLayout.Builder	setEventDelimiter(String eventDelimiter)
JsonTemplateLayout.Builder	setEventTemplate(String eventTemplate)
JsonTemplateLayout.Builder	setEventTemplateAdditionalFields(JsonTemplateLayout.EventTemplateAdditionalField[] eventTemplateAdditionalFields)
JsonTemplateLayout.Builder	setEventTemplateRootObjectKey(String eventTemplateRootObjectKey)
JsonTemplateLayout.Builder	setEventTemplateUri(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(String stackTraceElementTemplate)
JsonTemplateLayout.Builder	setStackTraceElementTemplateUri(String stackTraceElementTemplateUri)
JsonTemplateLayout.Builder	setStackTraceEnabled(boolean stackTraceEnabled)
JsonTemplateLayout.Builder	setTruncatedStringSuffix(String truncatedStringSuffix)
private void	validate()

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

configuration

@PluginConfiguration
private Configuration configuration

charset

@PluginBuilderAttribute
private Charset charset

locationInfoEnabled

@PluginBuilderAttribute
private boolean locationInfoEnabled

stackTraceEnabled

@PluginBuilderAttribute
private boolean stackTraceEnabled

eventTemplate

@PluginBuilderAttribute
private String eventTemplate

eventTemplateUri

@PluginBuilderAttribute
private String eventTemplateUri

eventTemplateRootObjectKey

@PluginBuilderAttribute
private String eventTemplateRootObjectKey

eventTemplateAdditionalFields

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

stackTraceElementTemplate

@PluginBuilderAttribute
private String stackTraceElementTemplate

stackTraceElementTemplateUri

@PluginBuilderAttribute
private String stackTraceElementTemplateUri

eventDelimiter

@PluginBuilderAttribute
private String eventDelimiter

nullEventDelimiterEnabled

@PluginBuilderAttribute
private boolean nullEventDelimiterEnabled

maxStringLength

@PluginBuilderAttribute
private int maxStringLength

truncatedStringSuffix

@PluginBuilderAttribute
private String truncatedStringSuffix

recyclerFactory

@PluginBuilderAttribute
private RecyclerFactory recyclerFactory

Constructor Details

Builder

private Builder()

Method Details

getConfiguration

public Configuration getConfiguration()

setConfiguration

public JsonTemplateLayout.Builder setConfiguration(Configuration configuration)

getCharset

public Charset getCharset()

setCharset

public JsonTemplateLayout.Builder setCharset(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 String getEventTemplate()

setEventTemplate

public JsonTemplateLayout.Builder setEventTemplate(String eventTemplate)

getEventTemplateUri

public String getEventTemplateUri()

setEventTemplateUri

public JsonTemplateLayout.Builder setEventTemplateUri(String eventTemplateUri)

getEventTemplateRootObjectKey

public String getEventTemplateRootObjectKey()

setEventTemplateRootObjectKey

public JsonTemplateLayout.Builder setEventTemplateRootObjectKey(String eventTemplateRootObjectKey)

getEventTemplateAdditionalFields

public JsonTemplateLayout.EventTemplateAdditionalField[] getEventTemplateAdditionalFields()

setEventTemplateAdditionalFields

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

getStackTraceElementTemplate

public String getStackTraceElementTemplate()

setStackTraceElementTemplate

public JsonTemplateLayout.Builder setStackTraceElementTemplate(String stackTraceElementTemplate)

getStackTraceElementTemplateUri

public String getStackTraceElementTemplateUri()

setStackTraceElementTemplateUri

public JsonTemplateLayout.Builder setStackTraceElementTemplateUri(String stackTraceElementTemplateUri)

getEventDelimiter

public String getEventDelimiter()

setEventDelimiter

public JsonTemplateLayout.Builder setEventDelimiter(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 String getTruncatedStringSuffix()

setTruncatedStringSuffix

public JsonTemplateLayout.Builder setTruncatedStringSuffix(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()