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

- Packages that use HierarchicalConfiguration
  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.

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

    Classes in org.apache.commons.configuration2 that implement HierarchicalConfiguration
    Modifier and Type | Class and Description
    --- | ---
    `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` | `BaseHierarchicalConfiguration` A specialized hierarchical configuration implementation that is based on a structure of `ImmutableNode` objects.
    `class` | `CombinedConfiguration` A hierarchical composite configuration class.
    `class` | `DynamicCombinedConfiguration` DynamicCombinedConfiguration allows a set of CombinedConfigurations to be used.
    `class` | `INIConfiguration` A specialized hierarchical configuration implementation for parsing ini files.
    `class` | `JSONConfiguration` A specialized hierarchical configuration class that is able to parse JSON documents.
    `class` | `PatternSubtreeConfigurationWrapper` Wraps a BaseHierarchicalConfiguration and allows subtrees to be accessed via a configured path with replaceable tokens derived from the ConfigurationInterpolator.
    `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` | `XMLConfiguration` A specialized hierarchical configuration class that is able to parse XML documents.
    `class` | `YAMLConfiguration` A specialized hierarchical configuration class that is able to parse YAML documents.

    Methods in org.apache.commons.configuration2 that return HierarchicalConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `HierarchicalConfiguration<ImmutableNode>` | PatternSubtreeConfigurationWrapper.`configurationAt(String key)`
    `HierarchicalConfiguration<T>` | HierarchicalConfiguration.`configurationAt(String key)` Returns a hierarchical subnode configuration for the node specified by the given key.
    `HierarchicalConfiguration<ImmutableNode>` | DynamicCombinedConfiguration.`configurationAt(String key)`
    `HierarchicalConfiguration<ImmutableNode>` | BaseHierarchicalConfiguration.`configurationAt(String key)` Returns a hierarchical subnode configuration for the node specified by the given key.
    `HierarchicalConfiguration<ImmutableNode>` | PatternSubtreeConfigurationWrapper.`configurationAt(String key, boolean supportUpdates)`
    `HierarchicalConfiguration<T>` | HierarchicalConfiguration.`configurationAt(String key, boolean supportUpdates)` Returns a hierarchical sub configuration object that wraps the configuration node specified by the given key.
    `HierarchicalConfiguration<ImmutableNode>` | DynamicCombinedConfiguration.`configurationAt(String key, boolean supportUpdates)`
    `HierarchicalConfiguration<ImmutableNode>` | BaseHierarchicalConfiguration.`configurationAt(String key, boolean supportUpdates)` Returns a hierarchical sub configuration object that wraps the configuration node specified by the given key.
    `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`.
    `HierarchicalConfiguration<T>` | HierarchicalConfigurationXMLReader.`getConfiguration()` Returns the configuration object to be parsed.

    Methods in org.apache.commons.configuration2 that return types with arguments of type HierarchicalConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `List<HierarchicalConfiguration<T>>` | HierarchicalConfiguration.`childConfigurationsAt(String key)` Returns a list with sub configurations for all child nodes of the node selected by the given key.
    `List<HierarchicalConfiguration<ImmutableNode>>` | BaseHierarchicalConfiguration.`childConfigurationsAt(String key)` Returns a list with sub configurations for all child nodes of the node selected by the given key.
    `List<HierarchicalConfiguration<T>>` | HierarchicalConfiguration.`childConfigurationsAt(String key, boolean supportUpdates)` Returns a list with sub configurations for all child nodes of the node selected by the given key allowing the caller to specify the `supportUpdates` flag.
    `List<HierarchicalConfiguration<ImmutableNode>>` | BaseHierarchicalConfiguration.`childConfigurationsAt(String key, boolean supportUpdates)` Returns a list with sub configurations for all child nodes of the node selected by the given key allowing the caller to specify the `supportUpdates` flag.
    `List<HierarchicalConfiguration<ImmutableNode>>` | PatternSubtreeConfigurationWrapper.`configurationsAt(String key)`
    `List<HierarchicalConfiguration<T>>` | HierarchicalConfiguration.`configurationsAt(String key)` Returns a list of sub configurations for all configuration nodes selected by the given key.
    `List<HierarchicalConfiguration<ImmutableNode>>` | DynamicCombinedConfiguration.`configurationsAt(String key)`
    `List<HierarchicalConfiguration<ImmutableNode>>` | BaseHierarchicalConfiguration.`configurationsAt(String key)` Returns a list of sub configurations for all configuration nodes selected by the given key.
    `List<HierarchicalConfiguration<T>>` | HierarchicalConfiguration.`configurationsAt(String key, boolean supportUpdates)` Returns a list of sub configurations for all configuration nodes selected by the given key allowing the caller to specify the `supportUpdates` flag.
    `List<HierarchicalConfiguration<ImmutableNode>>` | BaseHierarchicalConfiguration.`configurationsAt(String key, boolean supportUpdates)` Returns a list of sub configurations for all configuration nodes selected by the given key allowing the caller to specify the `supportUpdates` flag.

    Methods in org.apache.commons.configuration2 with parameters of type HierarchicalConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `void` | HierarchicalConfigurationXMLReader.`setConfiguration(HierarchicalConfiguration<T> config)` Sets the configuration object to be parsed.
    `static ImmutableHierarchicalConfiguration` | ConfigurationUtils.`unmodifiableConfiguration(HierarchicalConfiguration<?> c)` Creates an `ImmutableHierarchicalConfiguration` from the given `HierarchicalConfiguration` object.

    Constructors in org.apache.commons.configuration2 with parameters of type HierarchicalConfiguration
    Constructor and Description
    `AbstractYAMLBasedConfiguration(HierarchicalConfiguration<ImmutableNode> c)` Creates a new instance of `AbstractYAMLBasedConfiguration` as a copy of the specified configuration.
    `BaseHierarchicalConfiguration(HierarchicalConfiguration<ImmutableNode> c)` Creates a new instance of `BaseHierarchicalConfiguration` and copies all data contained in the specified configuration into the new one.
    `HierarchicalConfigurationXMLReader(HierarchicalConfiguration<T> config)` Creates a new instance of `HierarchicalConfigurationXMLReader` and sets the configuration to be parsed.
    `INIConfiguration(HierarchicalConfiguration<ImmutableNode> c)` Creates a new instance of `INIConfiguration` with the content of the specified `HierarchicalConfiguration`.
    `JSONConfiguration(HierarchicalConfiguration<ImmutableNode> c)` Creates a new instance of `JSONConfiguration` as a copy of the specified configuration.
    `PatternSubtreeConfigurationWrapper(HierarchicalConfiguration<ImmutableNode> config, String path)` Constructor
    `XMLConfiguration(HierarchicalConfiguration<ImmutableNode> c)` Creates a new instance of `XMLConfiguration` and copies the content of the passed in configuration into this object.
    `YAMLConfiguration(HierarchicalConfiguration<ImmutableNode> c)` Creates a new instance of `YAMLConfiguration` as a copy of the specified configuration.

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

    Methods in org.apache.commons.configuration2.beanutils that return HierarchicalConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `HierarchicalConfiguration<?>` | XMLBeanDeclaration.`getConfiguration()` Gets the configuration object this bean declaration is based on.

    Constructors in org.apache.commons.configuration2.beanutils with parameters of type HierarchicalConfiguration
    Constructor and Description
    `XMLBeanDeclaration(HierarchicalConfiguration<T> config)` Constructs a new instance of `XMLBeanDeclaration` and initializes it from the given configuration.
    `XMLBeanDeclaration(HierarchicalConfiguration<T> config, String key)` Constructs a new instance of `XMLBeanDeclaration` and initializes it from the given configuration.
    `XMLBeanDeclaration(HierarchicalConfiguration<T> config, String key, boolean optional)` Constructs a new instance of `XMLBeanDeclaration` and initializes it from the given configuration supporting optional declarations.
    `XMLBeanDeclaration(HierarchicalConfiguration<T> config, String key, boolean optional, String defBeanClsName)` Constructs a new instance of `XMLBeanDeclaration` and initializes it from the given configuration supporting optional declarations and a default bean class name.

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

    Methods in org.apache.commons.configuration2.builder.combined that return HierarchicalConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `protected HierarchicalConfiguration<?>` | CombinedConfigurationBuilder.`getDefinitionConfiguration()` Returns the configuration containing the definition of the combined configuration to be created.

    Methods in org.apache.commons.configuration2.builder.combined that return types with arguments of type HierarchicalConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `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.
    `ConfigurationBuilder<? extends HierarchicalConfiguration<?>>` | CombinedConfigurationBuilder.`getDefinitionBuilder()` Returns the `ConfigurationBuilder` which creates the definition configuration.
    `ConfigurationBuilder<? extends HierarchicalConfiguration<?>>` | CombinedBuilderParametersImpl.`getDefinitionBuilder()` Returns the `ConfigurationBuilder` object for obtaining the definition configuration.
    `protected ConfigurationBuilder<? extends HierarchicalConfiguration<?>>` | CombinedConfigurationBuilder.`setupDefinitionBuilder(Map<String,Object> params)` Obtains the `ConfigurationBuilder` object which provides access to the configuration containing the definition of the combined configuration to create.

    Methods in org.apache.commons.configuration2.builder.combined with parameters of type HierarchicalConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `protected void` | CombinedConfigurationBuilder.`configureEntityResolver(HierarchicalConfiguration<?> config, XMLBuilderParametersImpl xmlParams)` Creates and initializes a default `EntityResolver` if the definition configuration contains a corresponding declaration.
    `protected FileSystem` | CombinedConfigurationBuilder.`initFileSystem(HierarchicalConfiguration<?> config)` Creates and initializes a default `FileSystem` if the definition configuration contains a corresponding declaration.
    `protected void` | CombinedConfigurationBuilder.`initSystemProperties(HierarchicalConfiguration<?> config, String basePath)` Handles a file with system properties that may be defined in the definition configuration.
    `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 HierarchicalConfiguration
    Modifier and Type | Method and Description
    --- | ---
    `T` | CombinedBuilderProperties.`setDefinitionBuilder(ConfigurationBuilder<? extends HierarchicalConfiguration<?>> builder)` Sets the `ConfigurationBuilder` for the definition configuration.
    `CombinedBuilderParametersImpl` | CombinedBuilderParametersImpl.`setDefinitionBuilder(ConfigurationBuilder<? extends HierarchicalConfiguration<?>> builder)` Sets the `ConfigurationBuilder` for the definition configuration.

    Constructors in org.apache.commons.configuration2.builder.combined with parameters of type HierarchicalConfiguration
    Constructor and Description
    `ConfigurationDeclaration(CombinedConfigurationBuilder builder, HierarchicalConfiguration<?> config)` Creates a new instance of `ConfigurationDeclaration` and initializes it.

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

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

    Constructors in org.apache.commons.configuration2.plist with parameters of type HierarchicalConfiguration
    Constructor and Description
    `PropertyListConfiguration(HierarchicalConfiguration<ImmutableNode> c)` Creates a new instance of `PropertyListConfiguration` and copies the content of the specified configuration into this object.
    `XMLPropertyListConfiguration(HierarchicalConfiguration<ImmutableNode> configuration)` Creates a new instance of `XMLPropertyListConfiguration` and copies the content of the specified configuration into this object.

Copyright © 2001–2022 The Apache Software Foundation. All rights reserved.