DefaultConfigurationBuilder (Apache Log4j Core 2.4.1 API)

java.lang.Object
- org.apache.logging.log4j.core.config.builder.impl.DefaultConfigurationBuilder<T>

Type Parameters:: T - The BuiltConfiguration type.

All Implemented Interfaces:: ConfigurationBuilder<T>, Builder<T>

public class DefaultConfigurationBuilder<T extends BuiltConfiguration>
extends Object
implements ConfigurationBuilder<T>

Constructor Summary

Constructors
Constructor and Description

DefaultConfigurationBuilder()

DefaultConfigurationBuilder(Class<T> clazz)

Constructors
Constructor and Description
`DefaultConfigurationBuilder()`
`DefaultConfigurationBuilder(Class<T> clazz)`

Method Summary

Methods
Modifier and Type	Method and Description
`ConfigurationBuilder<T>`	`add(AppenderComponentBuilder builder)` Adds an AppenderComponent.
`protected ConfigurationBuilder<T>`	`add(Component parent, ComponentBuilder<?> builder)`
`ConfigurationBuilder<T>`	`add(CustomLevelComponentBuilder builder)` Adds a CustomLevel component.
`ConfigurationBuilder<T>`	`add(FilterComponentBuilder builder)` Adds a Filter component.
`ConfigurationBuilder<T>`	`add(LoggerComponentBuilder builder)` Adds a Logger component.
`ConfigurationBuilder<T>`	`add(RootLoggerComponentBuilder builder)` Adds the root Logger component.
`ConfigurationBuilder<T>`	`addProperty(String key, String value)` Adds a Property key and value.
`T`	`build()` Builds the object after all configuration has been set.
`AppenderComponentBuilder`	`newAppender(String name, String type)` Returns a builder for creating Appenders.
`AppenderRefComponentBuilder`	`newAppenderRef(String ref)` Returns a builder for creating AppenderRefs.
`LoggerComponentBuilder`	`newAsyncLogger(String name, Level level)` Returns a builder for creating Async Loggers.
`LoggerComponentBuilder`	`newAsyncLogger(String name, String level)` Returns a builder for creating Async Loggers.
`RootLoggerComponentBuilder`	`newAsyncRootLogger(Level level)` Returns a builder for creating the async root Logger.
`RootLoggerComponentBuilder`	`newAsyncRootLogger(String level)` Returns a builder for creating the async root Logger.
`<B extends ComponentBuilder<B>> ComponentBuilder<B>`	`newComponent(String name, String type)` Returns a builder for creating generic components.
`<B extends ComponentBuilder<B>> ComponentBuilder<B>`	`newComponent(String name, String type, String value)` Returns a builder for creating generic components.
`CustomLevelComponentBuilder`	`newCustomLevel(String name, int level)` Returns a builder for creating CustomLevels
`FilterComponentBuilder`	`newFilter(String type, Filter.Result onMatch, Filter.Result onMisMatch)` Returns a builder for creating Filters.
`FilterComponentBuilder`	`newFilter(String type, String onMatch, String onMisMatch)` Returns a builder for creating Filters.
`LayoutComponentBuilder`	`newLayout(String type)` Returns a builder for creating Layouts.
`LoggerComponentBuilder`	`newLogger(String name, Level level)` Returns a builder for creating Loggers.
`LoggerComponentBuilder`	`newLogger(String name, String level)` Returns a builder for creating Loggers.
`RootLoggerComponentBuilder`	`newRootLogger(Level level)` Returns a builder for creating the root Logger.
`RootLoggerComponentBuilder`	`newRootLogger(String level)` Returns a builder for creating the root Logger.
`ConfigurationBuilder<T>`	`setAdvertiser(String advertiser)` Set the Advertiser Plugin name.
`ConfigurationBuilder<T>`	`setConfigurationName(String name)` Set the name of the configuration.
`ConfigurationBuilder<T>`	`setConfigurationSource(ConfigurationSource configurationSource)` Set the ConfigurationSource.
`ConfigurationBuilder<T>`	`setMonitorInterval(String intervalSeconds)` Sets the interval at which the configuration file should be checked for changes.
`ConfigurationBuilder<T>`	`setPackages(String packages)` Sets the list of packages to search for plugins.
`ConfigurationBuilder<T>`	`setShutdownHook(String flag)` Sets whether the shutdown hook should be disabled.
`ConfigurationBuilder<T>`	`setStatusLevel(Level level)` Sets the level of the StatusLogger.
`ConfigurationBuilder<T>`	`setVerbosity(String verbosity)` Sets whether the logging should include constructing Plugins.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - DefaultConfigurationBuilder
```
public DefaultConfigurationBuilder()
```
  - DefaultConfigurationBuilder
```
public DefaultConfigurationBuilder(Class<T> clazz)
```
- Method Detail
  - add
```
protected ConfigurationBuilder<T> add(Component parent,
                          ComponentBuilder<?> builder)
```
  - add
```
public ConfigurationBuilder<T> add(AppenderComponentBuilder builder)
```
    Description copied from interface: ConfigurationBuilder
    
    Adds an AppenderComponent.
    
    Specified by:
    
    add in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    builder - The AppenderComponentBuilder with all of its attributes and sub components set.
    
    Returns:
    this builder instance.
  - add
```
public ConfigurationBuilder<T> add(CustomLevelComponentBuilder builder)
```
    Description copied from interface: ConfigurationBuilder
    
    Adds a CustomLevel component.
    
    Specified by:
    
    add in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    builder - The CustomLevelComponentBuilder with all of its attributes set.
    
    Returns:
    this builder instance.
  - add
```
public ConfigurationBuilder<T> add(FilterComponentBuilder builder)
```
    Description copied from interface: ConfigurationBuilder
    
    Adds a Filter component.
    
    Specified by:
    
    add in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    builder - the FilterComponentBuilder with all of its attributes and sub components set.
    
    Returns:
    this builder instance.
  - add
```
public ConfigurationBuilder<T> add(LoggerComponentBuilder builder)
```
    Description copied from interface: ConfigurationBuilder
    
    Adds a Logger component.
    
    Specified by:
    
    add in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    builder - The LoggerComponentBuilder with all of its attributes and sub components set.
    
    Returns:
    this builder instance.
  - add
```
public ConfigurationBuilder<T> add(RootLoggerComponentBuilder builder)
```
    Description copied from interface: ConfigurationBuilder
    
    Adds the root Logger component.
    
    Specified by:
    
    add in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    builder - The RootLoggerComponentBuilder with all of its attributes and sub components set.
    
    Returns:
    this builder instance.
  - addProperty
```
public ConfigurationBuilder<T> addProperty(String key,
                                  String value)
```
    Description copied from interface: ConfigurationBuilder
    
    Adds a Property key and value.
    
    Specified by:
    
    addProperty in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    key - The property key.
    value - The property value.
    
    Returns:
    this builder instance.
  - build
```
public T 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<T extends BuiltConfiguration>
    
    Returns:
    the configured instance.
  - newAppender
```
public AppenderComponentBuilder newAppender(String name,
                                   String type)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating Appenders.
    
    Specified by:
    
    newAppender in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    name - The name of the Appender.
    type - The Plugin type of the Appender.
    
    Returns:
    A new AppenderComponentBuilder.
  - newAppenderRef
```
public AppenderRefComponentBuilder newAppenderRef(String ref)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating AppenderRefs.
    
    Specified by:
    
    newAppenderRef in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    ref - The name of the Appender being referenced.
    
    Returns:
    A new AppenderRefComponentBuilder.
  - newAsyncLogger
```
public LoggerComponentBuilder newAsyncLogger(String name,
                                    Level level)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating Async Loggers.
    
    Specified by:
    
    newAsyncLogger in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    name - The name of the Logger.
    level - The logging Level to be assigned to the Logger.
    
    Returns:
    A new LoggerComponentBuilder.
  - newAsyncLogger
```
public LoggerComponentBuilder newAsyncLogger(String name,
                                    String level)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating Async Loggers.
    
    Specified by:
    
    newAsyncLogger in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    name - The name of the Logger.
    level - The logging Level to be assigned to the Logger.
    
    Returns:
    A new LoggerComponentBuilder.
  - newAsyncRootLogger
```
public RootLoggerComponentBuilder newAsyncRootLogger(Level level)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating the async root Logger.
    
    Specified by:
    
    newAsyncRootLogger in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    level - The logging Level to be assigned to the root Logger.
    
    Returns:
    A new RootLoggerComponentBuilder.
  - newAsyncRootLogger
```
public RootLoggerComponentBuilder newAsyncRootLogger(String level)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating the async root Logger.
    
    Specified by:
    
    newAsyncRootLogger in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    level - The logging Level to be assigned to the root Logger.
    
    Returns:
    A new RootLoggerComponentBuilder.
  - newComponent
```
public <B extends ComponentBuilder<B>> ComponentBuilder<B> newComponent(String name,
                                                               String type)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating generic components.
    
    Specified by:
    
    newComponent in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Type Parameters:
    B - ComponentBuilder target type
    Parameters:
    name - The name of the component (may be null).
    type - The Plugin type of the component.
    
    Returns:
    A new ComponentBuilder.
  - newComponent
```
public <B extends ComponentBuilder<B>> ComponentBuilder<B> newComponent(String name,
                                                               String type,
                                                               String value)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating generic components.
    
    Specified by:
    
    newComponent in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Type Parameters:
    B - ComponentBuilder target type
    Parameters:
    name - The name of the component (may be null).
    type - The Plugin type of the component.
    value - The value of the component.
    
    Returns:
    A new ComponentBuilder.
  - newCustomLevel
```
public CustomLevelComponentBuilder newCustomLevel(String name,
                                         int level)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating CustomLevels
    
    Specified by:
    
    newCustomLevel in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    name - The name of the custom level.
    level - The integer value to be assigned to the level.
    
    Returns:
    A new CustomLevelComponentBuilder.
  - newFilter
```
public FilterComponentBuilder newFilter(String type,
                               Filter.Result onMatch,
                               Filter.Result onMisMatch)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating Filters.
    
    Specified by:
    
    newFilter in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    type - The Plugin type of the Filter.
    onMatch - "ACCEPT", "DENY", or "NEUTRAL"
    onMisMatch - "ACCEPT", "DENY", or "NEUTRAL"
    
    Returns:
    A new FilterComponentBuilder.
  - newFilter
```
public FilterComponentBuilder newFilter(String type,
                               String onMatch,
                               String onMisMatch)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating Filters.
    
    Specified by:
    
    newFilter in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    type - The Plugin type of the Filter.
    onMatch - "ACCEPT", "DENY", or "NEUTRAL"
    onMisMatch - "ACCEPT", "DENY", or "NEUTRAL"
    
    Returns:
    A new FilterComponentBuilder.
  - newLayout
```
public LayoutComponentBuilder newLayout(String type)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating Layouts.
    
    Specified by:
    
    newLayout in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    type - The Plugin type of the Layout.
    
    Returns:
    A new LayoutComponentBuilder.
  - newLogger
```
public LoggerComponentBuilder newLogger(String name,
                               Level level)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating Loggers.
    
    Specified by:
    
    newLogger in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    name - The name of the Logger.
    level - The logging Level to be assigned to the Logger.
    
    Returns:
    A new LoggerComponentBuilder.
  - newLogger
```
public LoggerComponentBuilder newLogger(String name,
                               String level)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating Loggers.
    
    Specified by:
    
    newLogger in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    name - The name of the Logger.
    level - The logging Level to be assigned to the Logger.
    
    Returns:
    A new LoggerComponentBuilder.
  - newRootLogger
```
public RootLoggerComponentBuilder newRootLogger(Level level)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating the root Logger.
    
    Specified by:
    
    newRootLogger in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    level - The logging Level to be assigned to the root Logger.
    
    Returns:
    A new RootLoggerComponentBuilder.
  - newRootLogger
```
public RootLoggerComponentBuilder newRootLogger(String level)
```
    Description copied from interface: ConfigurationBuilder
    
    Returns a builder for creating the root Logger.
    
    Specified by:
    
    newRootLogger in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    level - The logging Level to be assigned to the root Logger.
    
    Returns:
    A new RootLoggerComponentBuilder.
  - setAdvertiser
```
public ConfigurationBuilder<T> setAdvertiser(String advertiser)
```
    Description copied from interface: ConfigurationBuilder
    
    Set the Advertiser Plugin name.
    
    Specified by:
    
    setAdvertiser in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    advertiser - The Advertiser Plugin name.
    
    Returns:
    this builder instance.
  - setConfigurationName
```
public ConfigurationBuilder<T> setConfigurationName(String name)
```
    Set the name of the configuration.
    
    Specified by:
    
    setConfigurationName in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    name - the name of the Configuration. By default is "Assembled".
    
    Returns:
    this builder instance
  - setConfigurationSource
```
public ConfigurationBuilder<T> setConfigurationSource(ConfigurationSource configurationSource)
```
    Set the ConfigurationSource.
    
    Specified by:
    
    setConfigurationSource in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    configurationSource - the ConfigurationSource
    
    Returns:
    this builder instance
  - setMonitorInterval
```
public ConfigurationBuilder<T> setMonitorInterval(String intervalSeconds)
```
    Description copied from interface: ConfigurationBuilder
    
    Sets the interval at which the configuration file should be checked for changes.
    
    Specified by:
    
    setMonitorInterval in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    intervalSeconds - The number of seconds that should pass between checks of the configuration file.
    
    Returns:
    this builder instance.
  - setPackages
```
public ConfigurationBuilder<T> setPackages(String packages)
```
    Description copied from interface: ConfigurationBuilder
    
    Sets the list of packages to search for plugins.
    
    Specified by:
    
    setPackages in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    packages - The comma separated list of packages.
    
    Returns:
    this builder instance.
  - setShutdownHook
```
public ConfigurationBuilder<T> setShutdownHook(String flag)
```
    Description copied from interface: ConfigurationBuilder
    
    Sets whether the shutdown hook should be disabled.
    
    Specified by:
    
    setShutdownHook in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    flag - "disable" will prevent the shutdown hook from being set.
    
    Returns:
    this builder instance.
  - setStatusLevel
```
public ConfigurationBuilder<T> setStatusLevel(Level level)
```
    Description copied from interface: ConfigurationBuilder
    
    Sets the level of the StatusLogger.
    
    Specified by:
    
    setStatusLevel in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    level - The logging level.
    
    Returns:
    this builder instance.
  - setVerbosity
```
public ConfigurationBuilder<T> setVerbosity(String verbosity)
```
    Description copied from interface: ConfigurationBuilder
    
    Sets whether the logging should include constructing Plugins.
    
    Specified by:
    
    setVerbosity in interface ConfigurationBuilder<T extends BuiltConfiguration>
    
    Parameters:
    verbosity - "disable" will hide messages from plugin construction.
    
    Returns:
    this builder instance.

Copyright © 1999-2015 Apache Software Foundation. All Rights Reserved.
Apache Logging, Apache Log4j, Log4j, Apache, the Apache feather logo, the Apache Logging project logo, and the Apache Log4j logo are trademarks of The Apache Software Foundation.

Class DefaultConfigurationBuilder<T extends BuiltConfiguration>

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

DefaultConfigurationBuilder

DefaultConfigurationBuilder

Method Detail

add

add

add

add

add

add

addProperty

build

newAppender

newAppenderRef

newAsyncLogger

newAsyncLogger

newAsyncRootLogger

newAsyncRootLogger

newComponent

newComponent

newCustomLevel

newFilter

newFilter

newLayout

newLogger

newLogger

newRootLogger

newRootLogger

setAdvertiser

setConfigurationName

setConfigurationSource

setMonitorInterval

setPackages

setShutdownHook

setStatusLevel

setVerbosity