| Package | Description | 
|---|---|
| org.apache.commons.configuration2.builder | 
 
 This package contains the implementations of configuration builder
 classes used to create new  
Configuration objects. | 
| org.apache.commons.configuration2.builder.combined | 
 
 A package containing the implementation of the builder for combined
 configurations. 
 | 
| org.apache.commons.configuration2.builder.fluent | 
 
 This package defines a fluent API for setting up fully configured configuration
 builders. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
BasicBuilderParameters
 An implementation of  
BuilderParameters which handles the parameters
 of a ConfigurationBuilder common to all concrete
 Configuration implementations. | 
class  | 
DatabaseBuilderParametersImpl
 A specialized parameters object for database configurations. 
 | 
class  | 
EventListenerParameters
 A specialized parameters implementation for  
BasicConfigurationBuilder
 which allows for a convenient event listener initialization. | 
class  | 
FileBasedBuilderParametersImpl
 An implementation of  
BuilderParameters which contains parameters
 related to Configuration implementations that are loaded from files. | 
class  | 
HierarchicalBuilderParametersImpl
 A specialized parameters object for hierarchical configurations. 
 | 
class  | 
INIBuilderParametersImpl
 A specialized parameters class for INI configuration. 
 | 
class  | 
JndiBuilderParametersImpl
 A specialized parameters object for JNDI configurations. 
 | 
class  | 
PropertiesBuilderParametersImpl
 A specialized parameter class for configuring  
PropertiesConfiguration
 instances. | 
class  | 
XMLBuilderParametersImpl
 A specialized parameters class for XML configuration. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
BuilderParameters | 
CopyObjectDefaultHandler.getSource()
Returns the source object of this handler. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
BasicConfigurationBuilder<T> | 
BasicConfigurationBuilder.configure(BuilderParameters... params)
Appends the content of the specified  
BuilderParameters objects to
 the current initialization parameters. | 
FileBasedConfigurationBuilder<T> | 
FileBasedConfigurationBuilder.configure(BuilderParameters... params)
Appends the content of the specified  
BuilderParameters objects to
 the current initialization parameters. | 
ReloadingFileBasedConfigurationBuilder<T> | 
ReloadingFileBasedConfigurationBuilder.configure(BuilderParameters... params)
Appends the content of the specified  
BuilderParameters objects to
 the current initialization parameters. | 
void | 
DefaultParametersManager.initializeParameters(BuilderParameters params)
Initializes the passed in  
BuilderParameters object by applying
 all matching DefaultParametersHandler objects registered at this
 instance. | 
void | 
BasicBuilderParameters.merge(BuilderParameters p)
Merges this object with the given parameters object. 
 | 
| Constructor and Description | 
|---|
CopyObjectDefaultHandler(BuilderParameters src)
Creates a new instance of  
CopyObjectDefaultHandler and
 initializes it with the specified source object. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
CombinedBuilderParametersImpl
 A specialized parameters object for a  
CombinedConfigurationBuilder. | 
class  | 
MultiFileBuilderParametersImpl
 A specialized parameters object for  
MultiFileConfigurationBuilder. | 
| Modifier and Type | Method and Description | 
|---|---|
BuilderParameters | 
CombinedBuilderParametersImpl.getDefinitionBuilderParameters()
Returns the parameters object for the definition configuration builder if
 present. 
 | 
BuilderParameters | 
MultiFileBuilderParametersImpl.getManagedBuilderParameters()
Returns the parameters object for managed configuration builders. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected Collection<BuilderParameters> | 
BaseConfigurationBuilderProvider.createParameterObjects()
Creates a collection of parameter objects to be used for configuring the
 builder. 
 | 
Collection<? extends BuilderParameters> | 
CombinedBuilderParametersImpl.getDefaultChildParameters()
Returns a collection with default parameter objects for child
 configuration sources. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
MultiFileConfigurationBuilder<T> | 
MultiFileConfigurationBuilder.configure(BuilderParameters... params)
Appends the content of the specified  
BuilderParameters objects to
 the current initialization parameters. | 
ReloadingCombinedConfigurationBuilder | 
ReloadingCombinedConfigurationBuilder.configure(BuilderParameters... params)
Appends the content of the specified  
BuilderParameters objects to
 the current initialization parameters. | 
CombinedConfigurationBuilder | 
CombinedConfigurationBuilder.configure(BuilderParameters... params)
Appends the content of the specified  
BuilderParameters objects to
 the current initialization parameters. | 
protected ConfigurationBuilder<? extends HierarchicalConfiguration<?>> | 
ReloadingCombinedConfigurationBuilder.createXMLDefinitionBuilder(BuilderParameters builderParams)
Creates a default builder for the definition configuration and
 initializes it with a parameters object. 
 | 
protected ConfigurationBuilder<? extends HierarchicalConfiguration<?>> | 
CombinedConfigurationBuilder.createXMLDefinitionBuilder(BuilderParameters builderParams)
Creates a default builder for the definition configuration and
 initializes it with a parameters object. 
 | 
protected void | 
CombinedConfigurationBuilder.initChildBuilderParameters(BuilderParameters params)
Initializes a parameters object for a child builder. 
 | 
CombinedBuilderParametersImpl | 
CombinedBuilderParametersImpl.setDefinitionBuilderParameters(BuilderParameters params)
Sets the parameters object for the definition configuration builder. 
 | 
T | 
CombinedBuilderProperties.setDefinitionBuilderParameters(BuilderParameters params)
Sets the parameters object for the definition configuration builder. 
 | 
MultiFileBuilderParametersImpl | 
MultiFileBuilderParametersImpl.setManagedBuilderParameters(BuilderParameters p)  | 
T | 
MultiFileBuilderProperties.setManagedBuilderParameters(BuilderParameters p)
Sets a parameters object to be used when creating a managed
 configuration. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
protected void | 
BaseConfigurationBuilderProvider.configureBuilder(BasicConfigurationBuilder<? extends Configuration> builder,
                ConfigurationDeclaration decl,
                Collection<BuilderParameters> params)
Configures a newly created builder instance with its initialization
 parameters. 
 | 
protected BasicConfigurationBuilder<? extends Configuration> | 
BaseConfigurationBuilderProvider.createBuilder(ConfigurationDeclaration decl,
             Collection<BuilderParameters> params)
Creates a new, uninitialized instance of the builder class managed by
 this provider. 
 | 
protected BasicConfigurationBuilder<? extends Configuration> | 
CombinedConfigurationBuilderProvider.createBuilder(ConfigurationDeclaration decl,
             Collection<BuilderParameters> params)
Creates a new, uninitialized instance of the builder class managed by
 this provider. 
 | 
protected String | 
BaseConfigurationBuilderProvider.determineConfigurationClass(ConfigurationDeclaration decl,
                           Collection<BuilderParameters> params)
Determines the name of the configuration class produced by the builder. 
 | 
protected String | 
FileExtensionConfigurationBuilderProvider.determineConfigurationClass(ConfigurationDeclaration decl,
                           Collection<BuilderParameters> params)
Determines the name of the configuration class produced by the builder. 
 | 
protected void | 
BaseConfigurationBuilderProvider.inheritParentBuilderProperties(ConfigurationDeclaration decl,
                              Collection<BuilderParameters> params)
Passes all parameter objects to the parent
  
CombinedConfigurationBuilder so that properties already defined
 for the parent builder can be added. | 
protected void | 
BaseConfigurationBuilderProvider.initializeParameterObjects(ConfigurationDeclaration decl,
                          Collection<BuilderParameters> params)
Initializes the parameter objects with data stored in the current bean
 declaration. 
 | 
protected void | 
CombinedConfigurationBuilderProvider.initializeParameterObjects(ConfigurationDeclaration decl,
                          Collection<BuilderParameters> params)
Initializes the parameter objects with data stored in the current bean
 declaration. 
 | 
| Modifier and Type | Interface and Description | 
|---|---|
interface  | 
CombinedBuilderParameters
 Definition of a parameters interface providing a fluent API for setting all
 properties of a builder for a combined configuration. 
 | 
interface  | 
DatabaseBuilderParameters
 Definition of a parameters interface providing a fluent API for setting all
 properties for a database configuration. 
 | 
interface  | 
FileBasedBuilderParameters
 Definition of a parameters interface providing a fluent API for setting all
 properties of a configuration of a file-based configuration builder. 
 | 
interface  | 
HierarchicalBuilderParameters
 Definition of a parameters interface providing a fluent API for setting all
 properties for a hierarchical configuration. 
 | 
interface  | 
INIBuilderParameters
 Definition of a parameters interface providing a fluent API for setting all
 properties for a INI configuration. 
 | 
interface  | 
JndiBuilderParameters
 Definition of a parameters interface providing a fluent API for setting all
 properties for a JNDI configuration. 
 | 
interface  | 
MultiFileBuilderParameters
 Definition of a parameters interface providing a fluent API for setting all
 properties of a builder managing multiple file-based configurations. 
 | 
interface  | 
PropertiesBuilderParameters
 Definition of a parameters interface providing a fluent API for setting all
 properties for a properties configuration. 
 | 
interface  | 
XMLBuilderParameters
 Definition of a parameters interface providing a fluent API for setting all
 properties for a XML configuration. 
 | 
Copyright © 2001–2020 The Apache Software Foundation. All rights reserved.