| Package | Description | 
|---|---|
| org.apache.commons.configuration2 | 
 
 The Configuration main package. 
 | 
| org.apache.commons.configuration2.builder | 
 
 This package contains the implementations of configuration builder
 classes used to create new  
Configuration objects. | 
| org.apache.commons.configuration2.plist | 
 
 Configuration classes supporting NeXT / OpenStep /GNUStep style configuration. 
 | 
| org.apache.commons.configuration2.web | 
 
 This package contains some implementations of the  
Configuration
 interface that are useful in web environments. | 
| Modifier and Type | Interface and Description | 
|---|---|
interface  | 
Configuration
The main Configuration interface. 
 | 
interface  | 
FileBasedConfiguration
 An interface which combines the  
FileBased and Configuration
 interfaces. | 
interface  | 
HierarchicalConfiguration<T>
 An interface for mutable hierarchical configurations. 
 | 
interface  | 
ImmutableHierarchicalConfiguration
 An interface for immutable hierarchical configurations. 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AbstractConfiguration
Abstract configuration class. 
 | 
class  | 
AbstractHierarchicalConfiguration<T>
 A specialized configuration class that extends its base class by the ability
 of keeping more structure in the stored properties. 
 | 
class  | 
AbstractYAMLBasedConfiguration
 A base class for configuration implementations based on YAML structures. 
 | 
class  | 
BaseConfiguration
Basic configuration class. 
 | 
class  | 
BaseHierarchicalConfiguration
 A specialized hierarchical configuration implementation that is based on a
 structure of  
ImmutableNode objects. | 
class  | 
CombinedConfiguration
 A hierarchical composite configuration class. 
 | 
class  | 
CompositeConfiguration
CompositeConfiguration allows you to add multiple Configuration
 objects to an aggregated configuration. | 
class  | 
DatabaseConfiguration
Configuration stored in a database. 
 | 
class  | 
DataConfiguration
Decorator providing additional getters for any Configuration. 
 | 
class  | 
DynamicCombinedConfiguration
 DynamicCombinedConfiguration allows a set of CombinedConfigurations to be
 used. 
 | 
class  | 
EnvironmentConfiguration
A Configuration implementation that reads the platform specific
 environment variables using the map returned by  
System.getenv(). | 
class  | 
INIConfiguration
 A specialized hierarchical configuration implementation for parsing ini
 files. 
 | 
class  | 
JNDIConfiguration
This Configuration class allows you to interface with a JNDI datasource. 
 | 
class  | 
JSONConfiguration
 A specialized hierarchical configuration class that is able to parse JSON
 documents. 
 | 
class  | 
MapConfiguration
 A Map based Configuration. 
 | 
class  | 
PatternSubtreeConfigurationWrapper
Wraps a BaseHierarchicalConfiguration and allows subtrees to be accessed via a configured path with
 replaceable tokens derived from the ConfigurationInterpolator. 
 | 
class  | 
PropertiesConfiguration
This is the "classic" Properties loader which loads the values from
 a single or multiple files (which can be chained with "include =". 
 | 
class  | 
SubnodeConfiguration
 A specialized hierarchical configuration class with a node model that uses a
 tracked node of another node model as its root node. 
 | 
class  | 
SubsetConfiguration
A subset of another configuration. 
 | 
class  | 
SystemConfiguration
A configuration based on the system properties. 
 | 
class  | 
XMLConfiguration
 A specialized hierarchical configuration class that is able to parse XML
 documents. 
 | 
class  | 
XMLPropertiesConfiguration
This configuration implements the XML properties format introduced in Java
 5.0, see http://java.sun.com/j2se/1.5.0/docs/api/java/util/Properties.html. 
 | 
class  | 
YAMLConfiguration
 A specialized hierarchical configuration class that is able to parse YAML
 documents. 
 | 
| Modifier and Type | Method and Description | 
|---|---|
ImmutableConfiguration | 
ConfigurationLookup.getConfiguration()
Returns the  
ImmutableConfiguration used by this object. | 
ImmutableConfiguration | 
AbstractConfiguration.immutableSubset(String prefix)  | 
ImmutableConfiguration | 
ImmutableConfiguration.immutableSubset(String prefix)
Return a decorator immutable Configuration containing every key from the current
 Configuration that starts with the specified prefix. 
 | 
static ImmutableConfiguration | 
ConfigurationUtils.unmodifiableConfiguration(Configuration c)
Creates an  
ImmutableConfiguration from the given
 Configuration object. | 
| Modifier and Type | Method and Description | 
|---|---|
static void | 
ConfigurationUtils.append(ImmutableConfiguration source,
      Configuration target)
Append all properties from the source configuration to the target
 configuration. 
 | 
static void | 
ConfigurationUtils.copy(ImmutableConfiguration source,
    Configuration target)
Copy all properties from the source configuration to the target
 configuration. 
 | 
static void | 
ConfigurationUtils.dump(ImmutableConfiguration configuration,
    PrintStream out)
Dump the configuration key/value mappings to some ouput stream. 
 | 
static void | 
ConfigurationUtils.dump(ImmutableConfiguration configuration,
    PrintWriter out)
Dump the configuration key/value mappings to some writer. 
 | 
static Properties | 
ConfigurationConverter.getProperties(ImmutableConfiguration config)
Convert a Configuration class into a Properties class. 
 | 
static String | 
ConfigurationUtils.toString(ImmutableConfiguration configuration)
Get a string representation of the key/value mappings of a
 configuration. 
 | 
| Constructor and Description | 
|---|
ConfigurationLookup(ImmutableConfiguration config)
Creates a new instance of  
ConfigurationLookup and sets the
 associated ImmutableConfiguration. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
BasicConfigurationBuilder<T extends ImmutableConfiguration>
 An implementation of the  
ConfigurationBuilder interface which is able
 to create different concrete ImmutableConfiguration implementations based on
 reflection. | 
interface  | 
ConfigurationBuilder<T extends ImmutableConfiguration>
 Definition of an interface for objects that can create  
ImmutableConfiguration
 or Configuration objects of a
 specific type. | 
| Modifier and Type | Method and Description | 
|---|---|
<T extends ImmutableConfiguration> | 
BuilderConfigurationWrapperFactory.createBuilderConfigurationWrapper(Class<T> ifcClass,
                                 ConfigurationBuilder<? extends T> builder)
Creates a wrapper  
ImmutableConfiguration on top of the specified
 ConfigurationBuilder. | 
static <T extends ImmutableConfiguration> | 
BuilderConfigurationWrapperFactory.createBuilderConfigurationWrapper(Class<T> ifcClass,
                                 ConfigurationBuilder<? extends T> builder,
                                 BuilderConfigurationWrapperFactory.EventSourceSupport evSrcSupport)
Returns a  
ImmutableConfiguration object which wraps the specified
 ConfigurationBuilder. | 
| Modifier and Type | Method and Description | 
|---|---|
ImmutableConfiguration | 
ConfigurationBuilderResultCreatedEvent.getConfiguration()
Returns the newly created  
ImmutableConfiguration object. | 
| Constructor and Description | 
|---|
ConfigurationBuilderResultCreatedEvent(ConfigurationBuilder<?> source,
                                      EventType<? extends ConfigurationBuilderResultCreatedEvent> evType,
                                      ImmutableConfiguration createdConfiguration)
Creates a new instance of  
ConfigurationBuilderResultCreatedEvent
 and initializes its properties. | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
PropertyListConfiguration
NeXT / OpenStep style configuration. 
 | 
class  | 
XMLPropertyListConfiguration
Property list file (plist) in XML FORMAT as used by Mac OS X (http://www.apple.com/DTDs/PropertyList-1.0.dtd). 
 | 
| Modifier and Type | Class and Description | 
|---|---|
class  | 
AppletConfiguration
A configuration wrapper to read applet parameters. 
 | 
class  | 
ServletConfiguration
A configuration wrapper around a  
ServletConfig. | 
class  | 
ServletContextConfiguration
A configuration wrapper to read the initialization parameters of a servlet
 context. 
 | 
class  | 
ServletFilterConfiguration
A configuration wrapper around a  
FilterConfig. | 
class  | 
ServletRequestConfiguration
A configuration wrapper to read the parameters of a servlet request. 
 | 
Copyright © 2001–2020 The Apache Software Foundation. All rights reserved.