## Uses of Interface
org.apache.commons.configuration2.Configuration

- Packages that use Configuration
  Package | Description
  --- | ---
  org.apache.commons.configuration2 | The Configuration main package.
  org.apache.commons.configuration2.beanutils | In this package a `Configuration` implementation can be found that implements the `DynaBean` interface.
  org.apache.commons.configuration2.builder.combined | A package containing the implementation of the builder for combined configurations.
  org.apache.commons.configuration2.plist | Configuration classes supporting NeXT / OpenStep /GNUStep style configuration.
  org.apache.commons.configuration2.spring | A package containing integrations for the Spring Framework.
  org.apache.commons.configuration2.web | This package contains some implementations of the `Configuration` interface that are useful in web environments.

- - ### Uses of Configuration in org.apache.commons.configuration2

    Subinterfaces of Configuration in org.apache.commons.configuration2
    Modifier and Type | Interface and Description
    --- | ---
    `interface` | `FileBasedConfiguration` An interface which combines the `FileBased` and `Configuration` interfaces.
    `interface` | `HierarchicalConfiguration<T>` An interface for mutable hierarchical configurations.

    Classes in org.apache.commons.configuration2 that implement Configuration
    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.

    Fields in org.apache.commons.configuration2 declared as Configuration
    Modifier and Type | Field and Description
    --- | ---
    `protected Configuration` | SubsetConfiguration.`parent` The parent configuration.

    Methods in org.apache.commons.configuration2 that return Configuration
    Modifier and Type | Method and Description
    --- | ---
    `static Configuration` | ConfigurationUtils.`cloneConfiguration(Configuration config)` Clones the given configuration object if this is possible.
    `Configuration` | DataConfiguration.`getConfiguration()` Return the configuration decorated by this DataConfiguration.
    `Configuration` | ConfigurationMap.`getConfiguration()` Returns the wrapped `Configuration` object.
    `Configuration` | BaseConfigurationXMLReader.`getConfiguration()` Returns the actual configuration to be processed.
    `Configuration` | DynamicCombinedConfiguration.`getConfiguration(int index)` Returns the configuration at the specified index.
    `Configuration` | CompositeConfiguration.`getConfiguration(int index)` Return the configuration at the specified index.
    `Configuration` | CombinedConfiguration.`getConfiguration(int index)` Returns the configuration at the specified index.
    `static Configuration` | ConfigurationConverter.`getConfiguration(Properties props)` Convert a standard Properties class into a configuration class.
    `Configuration` | DynamicCombinedConfiguration.`getConfiguration(String name)` Returns the configuration with the given name.
    `Configuration` | CombinedConfiguration.`getConfiguration(String name)` Returns the configuration with the given name.
    `Configuration` | CompositeConfiguration.`getInMemoryConfiguration()` Returns the "in memory configuration".
    `Configuration` | SubsetConfiguration.`getParent()` Return the parent configuration for this subset.
    `Configuration` | HierarchicalConfigurationXMLReader.`getParsedConfiguration()` Returns the configuration object to be processed.
    `abstract Configuration` | ConfigurationXMLReader.`getParsedConfiguration()` Returns a reference to the configuration that is parsed by this object.
    `Configuration` | BaseConfigurationXMLReader.`getParsedConfiguration()` Returns the configuration to be processed.
    `Configuration` | DynamicCombinedConfiguration.`getSource(String key)` Returns the configuration source, in which the specified key is defined.
    `Configuration` | CompositeConfiguration.`getSource(String key)` Returns the configuration source, in which the specified key is defined.
    `Configuration` | CombinedConfiguration.`getSource(String key)` Returns the configuration source, in which the specified key is defined.
    `Configuration` | PatternSubtreeConfigurationWrapper.`interpolatedConfiguration()`
    `Configuration` | DynamicCombinedConfiguration.`interpolatedConfiguration()`
    `Configuration` | BaseHierarchicalConfiguration.`interpolatedConfiguration()` Returns a configuration with the same content as this configuration, but with all variables replaced by their actual values.
    `Configuration` | AbstractConfiguration.`interpolatedConfiguration()` Returns a configuration with the same content as this configuration, but with all variables replaced by their actual values.
    `Configuration` | DynamicCombinedConfiguration.`removeConfiguration(String name)` Removes the configuration with the specified name.
    `Configuration` | CombinedConfiguration.`removeConfiguration(String name)` Removes the configuration with the specified name.
    `Configuration` | DynamicCombinedConfiguration.`removeConfigurationAt(int index)` Removes the configuration at the specified index.
    `Configuration` | CombinedConfiguration.`removeConfigurationAt(int index)` Removes the configuration at the specified index.
    `Configuration` | SubsetConfiguration.`subset(String prefix)`
    `Configuration` | PatternSubtreeConfigurationWrapper.`subset(String prefix)`
    `Configuration` | DynamicCombinedConfiguration.`subset(String prefix)`
    `Configuration` | Configuration.`subset(String prefix)` Return a decorator Configuration containing every key from the current Configuration that starts with the specified prefix.
    `Configuration` | BaseHierarchicalConfiguration.`subset(String prefix)` Creates a new `Configuration` object containing all keys that start with the specified prefix.
    `Configuration` | AbstractConfiguration.`subset(String prefix)`

    Methods in org.apache.commons.configuration2 that return types with arguments of type Configuration
    Modifier and Type | Method and Description
    --- | ---
    `List<Configuration>` | CombinedConfiguration.`getConfigurations()` Returns a List of all the configurations that have been added.
    `Set<Configuration>` | CombinedConfiguration.`getSources(String key)` Returns a set with the configuration sources, in which the specified key is defined.

    Methods in org.apache.commons.configuration2 with parameters of type Configuration
    Modifier and Type | Method and Description
    --- | ---
    `void` | CompositeConfiguration.`addConfiguration(Configuration config)` Add a configuration.
    `void` | CombinedConfiguration.`addConfiguration(Configuration config)` Adds a new configuration to this combined configuration.
    `void` | CompositeConfiguration.`addConfiguration(Configuration config, boolean asInMemory)` Adds a child configuration and optionally makes it the in-memory configuration.
    `void` | CombinedConfiguration.`addConfiguration(Configuration config, String name)` Adds a new configuration to this combined configuration with an optional name.
    `void` | DynamicCombinedConfiguration.`addConfiguration(Configuration config, String name, String at)` Adds a new configuration to this combined configuration.
    `void` | CombinedConfiguration.`addConfiguration(Configuration config, String name, String at)` Adds a new configuration to this combined configuration.
    `void` | CompositeConfiguration.`addConfigurationFirst(Configuration config)` Add a configuration to the start of the list of child configurations.
    `void` | CompositeConfiguration.`addConfigurationFirst(Configuration config, boolean asInMemory)` Adds a child configuration to the start of the collection and optionally makes it the in-memory configuration.
    `void` | AbstractConfiguration.`append(Configuration c)` Appends the content of the specified configuration to this configuration.
    `static void` | ConfigurationUtils.`append(Configuration source, Configuration target)` Append all properties from the source configuration to the target configuration.
    `static void` | ConfigurationUtils.`append(ImmutableConfiguration source, Configuration target)` Append all properties from the source configuration to the target configuration.
    `static Configuration` | ConfigurationUtils.`cloneConfiguration(Configuration config)` Clones the given configuration object if this is possible.
    `boolean` | StrictConfigurationComparator.`compare(Configuration a, Configuration b)` Compare two configuration objects.
    `boolean` | ConfigurationComparator.`compare(Configuration a, Configuration b)` Compare two configuration objects.
    `static HierarchicalConfiguration<?>` | ConfigurationUtils.`convertToHierarchical(Configuration conf)` Converts the passed in configuration to a hierarchical one.
    `static HierarchicalConfiguration<?>` | ConfigurationUtils.`convertToHierarchical(Configuration conf, ExpressionEngine engine)` Converts the passed in `Configuration` object to a hierarchical one using the specified `ExpressionEngine`.
    `void` | AbstractConfiguration.`copy(Configuration c)` Copies the content of the specified configuration into this configuration.
    `static void` | ConfigurationUtils.`copy(Configuration source, Configuration target)` Copy 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(Configuration configuration, PrintStream out)` Dump the configuration key/value mappings to some ouput stream.
    `static void` | ConfigurationUtils.`dump(Configuration configuration, PrintWriter out)` Dump the configuration key/value mappings to some writer.
    `static void` | ConfigurationUtils.`enableRuntimeExceptions(Configuration src)` Enables runtime exceptions for the specified configuration object.
    `static Map<Object,Object>` | ConfigurationConverter.`getMap(Configuration config)` Convert a Configuration class into a Map class.
    `static Properties` | ConfigurationConverter.`getProperties(Configuration config)` Convert a Configuration class into a Properties class.
    `boolean` | DynamicCombinedConfiguration.`removeConfiguration(Configuration config)` Removes the specified configuration from this combined configuration.
    `void` | CompositeConfiguration.`removeConfiguration(Configuration config)` Remove a configuration.
    `boolean` | CombinedConfiguration.`removeConfiguration(Configuration config)` Removes the specified configuration from this combined configuration.
    `void` | BaseConfigurationXMLReader.`setConfiguration(Configuration conf)` Sets the configuration to be processed.
    `static void` | SystemConfiguration.`setSystemProperties(Configuration systemConfig)` Set System properties from a configuration object.
    `static String` | ConfigurationUtils.`toString(Configuration configuration)` Get a string representation of the key/value mappings of a configuration.
    `static ImmutableConfiguration` | ConfigurationUtils.`unmodifiableConfiguration(Configuration c)` Creates an `ImmutableConfiguration` from the given `Configuration` object.

    Constructors in org.apache.commons.configuration2 with parameters of type Configuration
    Constructor and Description
    `BaseConfigurationXMLReader(Configuration conf)` Creates a new instance of `BaseConfigurationXMLReader` and sets the configuration object to be parsed.
    `CompositeConfiguration(Configuration inMemoryConfiguration)` Creates a CompositeConfiguration object with a specified in-memory configuration.
    `CompositeConfiguration(Configuration inMemoryConfiguration, Collection<? extends Configuration> configurations)` Creates a CompositeConfiguration with a specified in-memory configuration, and then adds the given collection of configurations.
    `ConfigurationMap(Configuration configuration)` Creates a new instance of a `ConfigurationMap` that wraps the specified `Configuration` instance.
    `DataConfiguration(Configuration configuration)` Creates a new instance of `DataConfiguration` and sets the wrapped configuration.
    `SubsetConfiguration(Configuration parent, String prefix)` Create a subset of the specified configuration
    `SubsetConfiguration(Configuration parent, String prefix, String delimiter)` Create a subset of the specified configuration

    Constructor parameters in org.apache.commons.configuration2 with type arguments of type Configuration
    Constructor and Description
    `CompositeConfiguration(Collection<? extends Configuration> configurations)` Create a CompositeConfiguration with an empty in memory configuration and adds the collection of configurations specified.
    `CompositeConfiguration(Configuration inMemoryConfiguration, Collection<? extends Configuration> configurations)` Creates a CompositeConfiguration with a specified in-memory configuration, and then adds the given collection of configurations.

  - ### Uses of Configuration in org.apache.commons.configuration2.beanutils

    Constructors in org.apache.commons.configuration2.beanutils with parameters of type Configuration
    Constructor and Description
    `ConfigurationDynaBean(Configuration configuration)` Constructs a new instance of `ConfigurationDynaBean` and sets the configuration this bean is associated with.
    `ConfigurationDynaClass(Configuration configuration)` Constructs an instance of a `ConfigurationDynaClass` wrapping the specified `Configuration` instance.

  - ### Uses of Configuration in org.apache.commons.configuration2.builder.combined

    Methods in org.apache.commons.configuration2.builder.combined that return types with arguments of type Configuration
    Modifier and Type | Method and Description
    --- | ---
    `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 BasicConfigurationBuilder<? extends Configuration>` | BaseConfigurationBuilderProvider.`createBuilder(ConfigurationDeclaration decl, Collection<BuilderParameters> params)` Creates a new, uninitialized instance of the builder class managed by this provider.
    `protected Collection<ConfigurationBuilder<? extends Configuration>>` | CombinedConfigurationBuilder.`getChildBuilders()` Returns a collection with the builders for all child configuration sources.
    `ConfigurationBuilder<? extends Configuration>` | MultiFileConfigurationBuilderProvider.`getConfigurationBuilder(ConfigurationDeclaration decl)` Returns the builder for the configuration source managed by this provider.
    `ConfigurationBuilder<? extends Configuration>` | ConfigurationBuilderProvider.`getConfigurationBuilder(ConfigurationDeclaration decl)` Returns the builder for the configuration source managed by this provider.
    `ConfigurationBuilder<? extends Configuration>` | BaseConfigurationBuilderProvider.`getConfigurationBuilder(ConfigurationDeclaration decl)` Returns the builder for the configuration source managed by this provider.
    `ConfigurationBuilder<? extends Configuration>` | CombinedConfigurationBuilder.`getNamedBuilder(String name)` Returns the configuration builder with the given name.

    Methods in org.apache.commons.configuration2.builder.combined with parameters of type Configuration
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | CombinedConfigurationBuilder.`registerConfiguredLookups(HierarchicalConfiguration<?> defConfig, Configuration resultConfig)` Processes custom `Lookup` objects that might be declared in the definition configuration.

    Method parameters in org.apache.commons.configuration2.builder.combined with type arguments of type 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.

  - ### Uses of Configuration in org.apache.commons.configuration2.plist

    Classes in org.apache.commons.configuration2.plist that implement Configuration
    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).

  - ### Uses of Configuration in org.apache.commons.configuration2.spring

    Methods in org.apache.commons.configuration2.spring that return Configuration
    Modifier and Type | Method and Description
    --- | ---
    `Configuration[]` | ConfigurationPropertiesFactoryBean.`getConfigurations()`

    Methods in org.apache.commons.configuration2.spring with parameters of type Configuration
    Modifier and Type | Method and Description
    --- | ---
    `void` | ConfigurationPropertiesFactoryBean.`setConfigurations(Configuration... configurations)` Set the commons configurations objects which will be used as properties.

    Constructors in org.apache.commons.configuration2.spring with parameters of type Configuration
    Constructor and Description
    `ConfigurationPropertiesFactoryBean(Configuration configuration)`
    `ConfigurationPropertySource(String name, Configuration source)`

  - ### Uses of Configuration in org.apache.commons.configuration2.web

    Classes in org.apache.commons.configuration2.web that implement Configuration
    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–2022 The Apache Software Foundation. All rights reserved.