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

Class ColumnConfig.Builder

java.lang.Object

org.apache.logging.log4j.core.appender.db.jdbc.ColumnConfig.Builder

All Implemented Interfaces:

Builder<ColumnConfig>

Enclosing class:

ColumnConfig

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

Field Summary

Fields

Modifier and Type	Field	Description
private Configuration	configuration
private boolean	isClob
private boolean	isEventTimestamp
private boolean	isUnicode
private java.lang.String	literal
private java.lang.String	name
private java.lang.String	pattern

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
ColumnConfig	build()	Builds the object after all configuration has been set.
ColumnConfig.Builder	setClob(boolean clob)	If "true", indicates that the column is a character LOB (CLOB).
ColumnConfig.Builder	setConfiguration(Configuration configuration)	The configuration object.
ColumnConfig.Builder	setEventTimestamp(boolean eventTimestamp)	If "true", indicates that this column is a date-time column in which the event timestamp should be inserted.
ColumnConfig.Builder	setLiteral(java.lang.String literal)	The literal value to insert into the column as-is without any quoting or escaping.
ColumnConfig.Builder	setName(java.lang.String name)	The name of the database column as it exists within the database table.
ColumnConfig.Builder	setPattern(java.lang.String pattern)	The PatternLayout pattern to insert in this column.
ColumnConfig.Builder	setUnicode(boolean unicode)	If "true", indicates that the column is a Unicode String.

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

name

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

pattern

@PluginBuilderAttribute
private java.lang.String pattern

literal

@PluginBuilderAttribute
private java.lang.String literal

isEventTimestamp

@PluginBuilderAttribute
private boolean isEventTimestamp

isUnicode

@PluginBuilderAttribute
private boolean isUnicode

isClob

@PluginBuilderAttribute
private boolean isClob

Constructor Detail

Builder

public Builder()

Method Detail

build

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

Returns:

the configured instance.

setClob

public ColumnConfig.Builder setClob(boolean clob)

If "true", indicates that the column is a character LOB (CLOB).

Returns:

this.

setConfiguration

public ColumnConfig.Builder setConfiguration(Configuration configuration)

The configuration object.

Returns:

this.

setEventTimestamp

public ColumnConfig.Builder setEventTimestamp(boolean eventTimestamp)

If "true", indicates that this column is a date-time column in which the event timestamp should be inserted. Mutually exclusive with pattern!=null and literal!=null.

Returns:

this.

setLiteral

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

The literal value to insert into the column as-is without any quoting or escaping. Mutually exclusive with pattern!=null and eventTimestamp=true.

Returns:

this.

setName

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

The name of the database column as it exists within the database table.

Returns:

this.

setPattern

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

The PatternLayout pattern to insert in this column. Mutually exclusive with literal!=null and eventTimestamp=true

Returns:

this.

setUnicode

public ColumnConfig.Builder setUnicode(boolean unicode)

If "true", indicates that the column is a Unicode String.

Returns:

this.