Package org.apache.logging.log4j.core.appender.db

Class ColumnMapping.Builder

java.lang.Object

org.apache.logging.log4j.core.appender.db.ColumnMapping.Builder

All Implemented Interfaces:

Builder<ColumnMapping>

Enclosing class:

ColumnMapping

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

Builder for ColumnMapping.

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	configuration
private StringLayout	layout
private java.lang.String	literal
private java.lang.String	name
private java.lang.String	parameter
private java.lang.String	pattern
private java.lang.String	source
private java.lang.Class<?>	type

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ColumnMapping	build()	Builds the object after all configuration has been set.
ColumnMapping.Builder	setConfiguration(Configuration configuration)
ColumnMapping.Builder	setLayout(StringLayout layout)	Layout of value to write to database (before type conversion).
ColumnMapping.Builder	setLiteral(java.lang.String literal)	Literal value to use for populating a column.
ColumnMapping.Builder	setName(java.lang.String name)	Column name.
ColumnMapping.Builder	setParameter(java.lang.String parameter)	Parameter value to use for populating a column, MUST contain a single parameter marker '?'.
ColumnMapping.Builder	setPattern(java.lang.String pattern)	Pattern to use as a PatternLayout.
ColumnMapping.Builder	setSource(java.lang.String source)	Source name.
ColumnMapping.Builder	setType(java.lang.Class<?> type)	Class to convert value to before storing in database.
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getErrorPrefix, isValid

Field Detail

configuration

@PluginConfiguration
private Configuration configuration

layout

@PluginElement("Layout")
private StringLayout layout

literal

@PluginBuilderAttribute
private java.lang.String literal

name

@PluginBuilderAttribute
@Required(message="No column name provided")
private java.lang.String name

parameter

@PluginBuilderAttribute
private java.lang.String parameter

pattern

@PluginBuilderAttribute
private java.lang.String pattern

source

@PluginBuilderAttribute
private java.lang.String source

type

@PluginBuilderAttribute
@Required(message="No conversion type provided")
private java.lang.Class<?> type

Constructor Detail

Builder

public Builder()

Method Detail

build

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

Returns:

the configured instance.

setConfiguration

public ColumnMapping.Builder setConfiguration(Configuration configuration)

setLayout

public ColumnMapping.Builder setLayout(StringLayout layout)

Layout of value to write to database (before type conversion). Not applicable if setType(Class) is a ReadOnlyStringMap, ThreadContextMap, or ThreadContextStack.

Returns:

this.

setLiteral

public ColumnMapping.Builder setLiteral(java.lang.String literal)

Literal value to use for populating a column. This is generally useful for functions, stored procedures, etc. No escaping will be done on this value.

Returns:

this.

setName

public ColumnMapping.Builder setName(java.lang.String name)

Column name.

Returns:

this.

setParameter

public ColumnMapping.Builder setParameter(java.lang.String parameter)

Parameter value to use for populating a column, MUST contain a single parameter marker '?'. This is generally useful for functions, stored procedures, etc. No escaping will be done on this value.

Returns:

this.

setPattern

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

Pattern to use as a PatternLayout. Convenient shorthand for setLayout(StringLayout) with a PatternLayout.

Returns:

this.

setSource

public ColumnMapping.Builder setSource(java.lang.String source)

Source name. Useful when combined with a MapMessage depending on the appender.

Returns:

this.

setType

public ColumnMapping.Builder setType(java.lang.Class<?> type)

Class to convert value to before storing in database. If the type is compatible with ThreadContextMap or ReadOnlyStringMap, then the MDC will be used. If the type is compatible with ThreadContextStack, then the NDC will be used. If the type is compatible with Date, then the event timestamp will be used.

Returns:

this.

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object