Package org.apache.logging.log4j.core.config

Class LoggerConfig.Builder<B extends LoggerConfig.Builder<B>>

java.lang.Object

org.apache.logging.log4j.core.config.LoggerConfig.Builder<B>

Type Parameters:

B - The type to build

All Implemented Interfaces:

Builder<LoggerConfig>

Direct Known Subclasses:

AsyncLoggerConfig.Builder

Enclosing class:

LoggerConfig

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

Builds LoggerConfig instances.

Field Summary

Fields

Modifier and Type	Field	Description
private java.lang.Boolean	additivity
private Configuration	config
private Filter	filter
private java.lang.String	includeLocation
private Level	level
private java.lang.String	levelAndRefs
private java.lang.String	loggerName
private Property[]	properties
private AppenderRef[]	refs

Constructor Summary

Constructors

Constructor	Description
Builder()

Method Summary

Modifier and Type	Method	Description
B	asBuilder()
LoggerConfig	build()	Builds the object after all configuration has been set.
Configuration	getConfig()
Filter	getFilter()
java.lang.String	getIncludeLocation()
Level	getLevel()
java.lang.String	getLevelAndRefs()
java.lang.String	getLoggerName()
Property[]	getProperties()
AppenderRef[]	getRefs()
boolean	isAdditivity()
B	setAdditivity(boolean additivity)
B	setConfig(Configuration config)
B	setFilter(Filter filter)
B	setIncludeLocation(java.lang.String includeLocation)
B	setLevel(Level level)
B	setLevelAndRefs(java.lang.String levelAndRefs)
B	setLoggerName(java.lang.String loggerName)
B	setProperties(Property[] properties)
B	setRefs(AppenderRef[] refs)
B	withAdditivity(boolean additivity)	Deprecated. since 2.26.0 use setAdditivity(boolean).
B	withConfig(Configuration config)	Deprecated. since 2.26.0 use setConfig(Configuration).
B	withFilter(Filter filter)	Deprecated. since 2.25.0.
B	withIncludeLocation(java.lang.String includeLocation)	Deprecated. since 2.26.0 use setIncludeLocation(String).
B	withLevel(Level level)	Deprecated. since 2.26.0 use setLevel(Level).
B	withLevelAndRefs(java.lang.String levelAndRefs)	Deprecated. since 2.26.0 use setLevelAndRefs(String).
B	withLoggerName(java.lang.String loggerName)	Deprecated. since 2.26.0 use setLoggerName(String).
B	withProperties(Property[] properties)	Deprecated. since 2.26.0 use setProperties(Property[]).
B	withRefs(AppenderRef[] refs)	Deprecated. since 2.26.0 use setRefs(AppenderRef[]).
B	withtFilter(Filter filter)	Deprecated. Use setFilter(Filter) instead

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

additivity

@PluginBuilderAttribute
private java.lang.Boolean additivity

level

@PluginBuilderAttribute
private Level level

levelAndRefs

@PluginBuilderAttribute
private java.lang.String levelAndRefs

loggerName

@PluginBuilderAttribute("name")
@Required(message="Loggers cannot be configured without a name")
private java.lang.String loggerName

includeLocation

@PluginBuilderAttribute
private java.lang.String includeLocation

refs

@PluginElement("AppenderRef")
private AppenderRef[] refs

properties

@PluginElement("Properties")
private Property[] properties

config

@PluginConfiguration
private Configuration config

filter

@PluginElement("Filter")
private Filter filter

Constructor Detail

Builder

public Builder()

Method Detail

isAdditivity

public boolean isAdditivity()

setAdditivity

public B setAdditivity(boolean additivity)

Since:

2.26.0

getLevel

public Level getLevel()

setLevel

public B setLevel(Level level)

Since:

2.26.0

getLevelAndRefs

public java.lang.String getLevelAndRefs()

setLevelAndRefs

public B setLevelAndRefs(java.lang.String levelAndRefs)

Since:

2.26.0

getLoggerName

public java.lang.String getLoggerName()

setLoggerName

public B setLoggerName(java.lang.String loggerName)

Since:

2.26.0

getIncludeLocation

public java.lang.String getIncludeLocation()

setIncludeLocation

public B setIncludeLocation(java.lang.String includeLocation)

Since:

2.26.0

getRefs

public AppenderRef[] getRefs()

setRefs

public B setRefs(AppenderRef[] refs)

Since:

2.26.0

getProperties

public Property[] getProperties()

setProperties

public B setProperties(Property[] properties)

Since:

2.26.0

getConfig

public Configuration getConfig()

setConfig

public B setConfig(Configuration config)

Since:

2.26.0

getFilter

public Filter getFilter()

setFilter

public B setFilter(Filter filter)

Since:

2.25.0

withAdditivity

@Deprecated
public B withAdditivity(boolean additivity)

Deprecated.

since 2.26.0 use setAdditivity(boolean).

withLevel

@Deprecated
public B withLevel(Level level)

Deprecated.

since 2.26.0 use setLevel(Level).

withLevelAndRefs

@Deprecated
public B withLevelAndRefs(java.lang.String levelAndRefs)

Deprecated.

since 2.26.0 use setLevelAndRefs(String).

withLoggerName

@Deprecated
public B withLoggerName(java.lang.String loggerName)

Deprecated.

since 2.26.0 use setLoggerName(String).

withIncludeLocation

@Deprecated
public B withIncludeLocation(java.lang.String includeLocation)

Deprecated.

since 2.26.0 use setIncludeLocation(String).

withRefs

@Deprecated
public B withRefs(AppenderRef[] refs)

Deprecated.

since 2.26.0 use setRefs(AppenderRef[]).

withProperties

@Deprecated
public B withProperties(Property[] properties)

Deprecated.

since 2.26.0 use setProperties(Property[]).

withConfig

@Deprecated
public B withConfig(Configuration config)

Deprecated.

since 2.26.0 use setConfig(Configuration).

withtFilter

@Deprecated
public B withtFilter(Filter filter)

Deprecated.

Use setFilter(Filter) instead

withFilter

@Deprecated
public B withFilter(Filter filter)

Deprecated.

since 2.25.0. Use setFilter(Filter) instead.

build

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

Returns:

the configured instance.

asBuilder

public B asBuilder()