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 aConfiguration
implementation can be found that implements theDynaBean
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.web This package contains some implementations of theConfiguration
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 Description interface
FileBasedConfiguration
An interface which combines theFileBased
andConfiguration
interfaces.interface
HierarchicalConfiguration<T>
An interface for mutable hierarchical configurations.Classes in org.apache.commons.configuration2 that implement Configuration Modifier and Type Class 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 ofImmutableNode
objects.class
CombinedConfiguration
A hierarchical composite configuration class.class
CompositeConfiguration
CompositeConfiguration
allows you to add multipleConfiguration
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 bySystem.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, see https://docs.oracle.com/javase/8/docs/api/java/util/Properties.html.Fields in org.apache.commons.configuration2 declared as Configuration Modifier and Type Field Description private Configuration
BaseConfigurationXMLReader. config
Stores the actual configuration.private Configuration
CombinedConfiguration.ConfigData. configuration
Stores a reference to the configuration.private Configuration
ConfigurationMap. configuration
TheConfiguration
wrapped by this class.private Configuration
ConfigurationMap.ConfigurationSet. configuration
The configuration mapped to this entry set.private Configuration
DataConfiguration. configuration
Stores the wrapped configuration.private Configuration
DynamicCombinedConfiguration.ConfigData. configuration
Stores a reference to the configuration.private Configuration
CompositeConfiguration. inMemoryConfiguration
Configuration that holds in memory stuff.protected Configuration
SubsetConfiguration. parent
The parent configuration.private Configuration
ImmutableConfigurationInvocationHandler. wrappedConfiguration
The underlying configuration object.Fields in org.apache.commons.configuration2 with type parameters of type Configuration Modifier and Type Field Description private java.util.List<Configuration>
CompositeConfiguration. configList
List holding all the configurationprivate java.util.Map<java.lang.String,Configuration>
CombinedConfiguration. namedConfigurations
Stores a map with the named configurations.private java.util.Map<java.lang.String,Configuration>
DynamicCombinedConfiguration. namedConfigurations
Stores a map with the named configurations.Methods in org.apache.commons.configuration2 that return Configuration Modifier and Type Method Description static Configuration
ConfigurationUtils. cloneConfiguration(Configuration config)
Clones the given configuration object if this is possible.Configuration
BaseConfigurationXMLReader. getConfiguration()
Gets the actual configuration to be processed.Configuration
CombinedConfiguration.ConfigData. getConfiguration()
Gets the stored configuration.Configuration
CombinedConfiguration. getConfiguration(int index)
Gets the configuration at the specified index.Configuration
CombinedConfiguration. getConfiguration(java.lang.String name)
Gets the configuration with the given name.Configuration
CompositeConfiguration. getConfiguration(int index)
Gets the configuration at the specified index.static Configuration
ConfigurationConverter. getConfiguration(java.util.Properties props)
Convert a standard Properties class into a configuration class.Configuration
ConfigurationMap. getConfiguration()
Gets the wrappedConfiguration
object.Configuration
DataConfiguration. getConfiguration()
Gets the configuration decorated by this DataConfiguration.Configuration
DynamicCombinedConfiguration.ConfigData. getConfiguration()
Gets the stored configuration.Configuration
DynamicCombinedConfiguration. getConfiguration(int index)
Gets the configuration at the specified index.Configuration
DynamicCombinedConfiguration. getConfiguration(java.lang.String name)
Gets the configuration with the given name.Configuration
CompositeConfiguration. getInMemoryConfiguration()
Gets the "in memory configuration".Configuration
SubsetConfiguration. getParent()
Gets the parent configuration for this subset.Configuration
BaseConfigurationXMLReader. getParsedConfiguration()
Gets the configuration to be processed.abstract Configuration
ConfigurationXMLReader. getParsedConfiguration()
Gets a reference to the configuration that is parsed by this object.Configuration
HierarchicalConfigurationXMLReader. getParsedConfiguration()
Gets the configuration object to be processed.Configuration
CombinedConfiguration. getSource(java.lang.String key)
Gets the configuration source, in which the specified key is defined.Configuration
CompositeConfiguration. getSource(java.lang.String key)
Gets the configuration source, in which the specified key is defined.Configuration
DynamicCombinedConfiguration. getSource(java.lang.String key)
Gets the configuration source, in which the specified key is defined.Configuration
AbstractConfiguration. interpolatedConfiguration()
Returns a configuration with the same content as this configuration, but with all variables replaced by their actual values.Configuration
BaseHierarchicalConfiguration. interpolatedConfiguration()
Returns a configuration with the same content as this configuration, but with all variables replaced by their actual values.Configuration
DynamicCombinedConfiguration. interpolatedConfiguration()
Configuration
PatternSubtreeConfigurationWrapper. interpolatedConfiguration()
Configuration
CombinedConfiguration. removeConfiguration(java.lang.String name)
Removes the configuration with the specified name.Configuration
DynamicCombinedConfiguration. removeConfiguration(java.lang.String name)
Removes the configuration with the specified name.Configuration
CombinedConfiguration. removeConfigurationAt(int index)
Removes the configuration at the specified index.Configuration
DynamicCombinedConfiguration. removeConfigurationAt(int index)
Removes the configuration at the specified index.Configuration
AbstractConfiguration. subset(java.lang.String prefix)
Configuration
BaseHierarchicalConfiguration. subset(java.lang.String prefix)
Creates a newConfiguration
object containing all keys that start with the specified prefix.Configuration
Configuration. subset(java.lang.String prefix)
Return a decorator Configuration containing every key from the current Configuration that starts with the specified prefix.Configuration
DynamicCombinedConfiguration. subset(java.lang.String prefix)
Configuration
PatternSubtreeConfigurationWrapper. subset(java.lang.String prefix)
Configuration
SubsetConfiguration. subset(java.lang.String prefix)
Methods in org.apache.commons.configuration2 that return types with arguments of type Configuration Modifier and Type Method Description private java.util.Set<Configuration>
CombinedConfiguration. findSourceConfigurations(ImmutableNode node)
Determines the configurations to which the specified node belongs.java.util.List<Configuration>
CombinedConfiguration. getConfigurations()
Gets a List of all the configurations that have been added.java.util.Set<Configuration>
CombinedConfiguration. getSources(java.lang.String key)
Gets 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 Description void
CombinedConfiguration. addConfiguration(Configuration config)
Adds a new configuration to this combined configuration.void
CombinedConfiguration. addConfiguration(Configuration config, java.lang.String name)
Adds a new configuration to this combined configuration with an optional name.void
CombinedConfiguration. addConfiguration(Configuration config, java.lang.String name, java.lang.String at)
Adds a new configuration to this combined configuration.void
CompositeConfiguration. addConfiguration(Configuration config)
Add a configuration.void
CompositeConfiguration. addConfiguration(Configuration config, boolean asInMemory)
Adds a child configuration and optionally makes it the in-memory configuration.void
DynamicCombinedConfiguration. addConfiguration(Configuration config, java.lang.String name, java.lang.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.private void
CompositeConfiguration. appendListProperty(java.util.List<java.lang.Object> dest, Configuration config, java.lang.String key)
Adds the value of a property to the given list.static Configuration
ConfigurationUtils. cloneConfiguration(Configuration config)
Clones the given configuration object if this is possible.boolean
ConfigurationComparator. compare(Configuration a, Configuration b)
Compare two configuration objects.boolean
StrictConfigurationComparator. 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 inConfiguration
object to a hierarchical one using the specifiedExpressionEngine
.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.private static ImmutableConfiguration
ConfigurationUtils. createUnmodifiableConfiguration(java.lang.Class<?>[] ifcs, Configuration c)
Helper method for creating a proxy for an unmodifiable configuration.static void
ConfigurationUtils. dump(Configuration configuration, java.io.PrintStream out)
Dump the configuration key/value mappings to some ouput stream.static void
ConfigurationUtils. dump(Configuration configuration, java.io.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 java.util.Map<java.lang.Object,java.lang.Object>
ConfigurationConverter. getMap(Configuration config)
Convert a Configuration class into a Map class.static java.util.Properties
ConfigurationConverter. getProperties(Configuration config)
Convert a Configuration class into a Properties class.protected java.lang.String
HierarchicalConfigurationConverter. openElements(DefaultConfigurationKey keyLast, DefaultConfigurationKey keyAct, Configuration config, java.util.Set<java.lang.String> keySet)
Fires all necessary element start events for the specified key.void
HierarchicalConfigurationConverter. process(Configuration config)
Processes the specified configuration object.private void
CombinedConfiguration. registerListenerAt(Configuration configuration)
Registers this combined configuration as listener at the given child configuration.boolean
CombinedConfiguration. removeConfiguration(Configuration config)
Removes the specified configuration from this combined configuration.void
CompositeConfiguration. removeConfiguration(Configuration config)
Remove a configuration.boolean
DynamicCombinedConfiguration. removeConfiguration(Configuration config)
Removes the specified configuration from this combined configuration.private void
CompositeConfiguration. replaceInMemoryConfiguration(Configuration config)
Replaces the current in-memory configuration by the given one.void
BaseConfigurationXMLReader. setConfiguration(Configuration conf)
Sets the configuration to be processed.static void
SystemConfiguration. setSystemProperties(Configuration systemConfig)
Sets System properties from a configuration object.static java.lang.String
ConfigurationUtils. toString(Configuration configuration)
Gets a string representation of the key/value mappings of a configuration.static ImmutableConfiguration
ConfigurationUtils. unmodifiableConfiguration(Configuration c)
Creates anImmutableConfiguration
from the givenConfiguration
object.private void
CombinedConfiguration. unregisterListenerAt(Configuration configuration)
Removes this combined configuration as listener from the given child configuration.Constructors in org.apache.commons.configuration2 with parameters of type Configuration Constructor Description BaseConfigurationXMLReader(Configuration conf)
Creates a new instance ofBaseConfigurationXMLReader
and sets the configuration object to be parsed.CompositeConfiguration(Configuration inMemoryConfiguration)
Creates a CompositeConfiguration object with a specified in-memory configuration.CompositeConfiguration(Configuration inMemoryConfiguration, java.util.Collection<? extends Configuration> configurations)
Creates a CompositeConfiguration with a specified in-memory configuration, and then adds the given collection of configurations.ConfigData(Configuration config, java.lang.String n, java.lang.String at)
Creates a new instance ofConfigData
and initializes it.ConfigData(Configuration config, java.lang.String n, java.lang.String at)
Creates a new instance ofConfigData
and initializes it.ConfigurationMap(Configuration configuration)
Creates a new instance of aConfigurationMap
that wraps the specifiedConfiguration
instance.ConfigurationSet(Configuration configuration)
DataConfiguration(Configuration configuration)
Creates a new instance ofDataConfiguration
and sets the wrapped configuration.ImmutableConfigurationInvocationHandler(Configuration configuration)
Creates a new instance ofImmutableConfigurationInvocationHandler
and initializes it with the wrapped configuration object.SubsetConfiguration(Configuration parent, java.lang.String prefix)
Create a subset of the specified configurationSubsetConfiguration(Configuration parent, java.lang.String prefix, java.lang.String delimiter)
Create a subset of the specified configurationConstructor parameters in org.apache.commons.configuration2 with type arguments of type Configuration Constructor Description CompositeConfiguration(java.util.Collection<? extends Configuration> configurations)
Create a CompositeConfiguration with an empty in memory configuration and adds the collection of configurations specified.CompositeConfiguration(Configuration inMemoryConfiguration, java.util.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
Fields in org.apache.commons.configuration2.beanutils declared as Configuration Modifier and Type Field Description private Configuration
ConfigurationDynaClass. configuration
Stores the associated configuration.Constructors in org.apache.commons.configuration2.beanutils with parameters of type Configuration Constructor Description ConfigurationDynaBean(Configuration configuration)
Constructs a new instance ofConfigurationDynaBean
and sets the configuration this bean is associated with.ConfigurationDynaClass(Configuration configuration)
Constructs an instance of aConfigurationDynaClass
wrapping the specifiedConfiguration
instance. -
Uses of Configuration in org.apache.commons.configuration2.builder.combined
Fields in org.apache.commons.configuration2.builder.combined declared as Configuration Modifier and Type Field Description private Configuration
MultiFileConfigurationBuilderProvider.WrapperBuilder. configuration
The configuration managed by this builder.Fields in org.apache.commons.configuration2.builder.combined with type parameters of type Configuration Modifier and Type Field Description private java.util.Collection<ConfigurationBuilder<? extends Configuration>>
CombinedConfigurationBuilder.ConfigurationSourceData. allBuilders
A collection with all child builders.private ConfigurationBuilder<? extends Configuration>
MultiFileConfigurationBuilderProvider.WrapperBuilder. builder
The builder to which this instance delegates.private java.util.Map<java.lang.String,ConfigurationBuilder<? extends Configuration>>
CombinedConfigurationBuilder.ConfigurationSourceData. namedBuilders
A map for direct access to a builder by its name.private java.util.List<ConfigurationBuilder<? extends Configuration>>
CombinedConfigurationBuilder.ConfigurationSourceData. overrideBuilders
A list with the builders for override configurations.private java.util.List<ConfigurationBuilder<? extends Configuration>>
CombinedConfigurationBuilder.ConfigurationSourceData. unionBuilders
A list with the builders for union configurations.Methods in org.apache.commons.configuration2.builder.combined that return Configuration Modifier and Type Method Description private Configuration
MultiFileConfigurationBuilderProvider. createWrapperConfiguration(ConfigurationBuilder builder)
Creates a configuration which wraps the specified builder.Configuration
MultiFileConfigurationBuilderProvider.WrapperBuilder. getConfiguration()
Methods in org.apache.commons.configuration2.builder.combined that return types with arguments of type Configuration Modifier and Type Method Description java.util.List<ConfigurationBuilder<? extends Configuration>>
CombinedConfigurationBuilder.ConfigurationSourceData. createAndAddConfigurations(CombinedConfiguration ccResult, java.util.List<ConfigurationDeclaration> srcDecl, java.util.List<ConfigurationBuilder<? extends Configuration>> builders)
Processes the declaration of configuration builder providers, creates the corresponding builder if necessary, obtains configurations, and adds them to the specified result configuration.protected BasicConfigurationBuilder<? extends Configuration>
BaseConfigurationBuilderProvider. createBuilder(ConfigurationDeclaration decl, java.util.Collection<BuilderParameters> params)
Creates a new, uninitialized instance of the builder class managed by this provider.protected BasicConfigurationBuilder<? extends Configuration>
CombinedConfigurationBuilderProvider. createBuilder(ConfigurationDeclaration decl, java.util.Collection<BuilderParameters> params)
Creates a new, uninitialized instance of the builder class managed by this provider.private ConfigurationBuilder<? extends Configuration>
CombinedConfigurationBuilder.ConfigurationSourceData. createConfigurationBuilder(ConfigurationDeclaration decl)
Creates a configuration builder based on a source declaration in the definition configuration.private static ConfigurationBuilder<? extends Configuration>
MultiFileConfigurationBuilderProvider. createWrapperBuilder(ConfigurationBuilder<? extends Configuration> multiBuilder, Configuration wrapConfig)
Creates theConfigurationBuilder
to be returned by this provider.java.util.Collection<ConfigurationBuilder<? extends Configuration>>
CombinedConfigurationBuilder.ConfigurationSourceData. getChildBuilders()
Gets a collection containing the builders for all child configuration sources.protected java.util.Collection<ConfigurationBuilder<? extends Configuration>>
CombinedConfigurationBuilder. getChildBuilders()
Gets a collection with the builders for all child configuration sources.ConfigurationBuilder<? extends Configuration>
BaseConfigurationBuilderProvider. getConfigurationBuilder(ConfigurationDeclaration decl)
Gets the builder for the configuration source managed by this provider.ConfigurationBuilder<? extends Configuration>
ConfigurationBuilderProvider. getConfigurationBuilder(ConfigurationDeclaration decl)
Gets the builder for the configuration source managed by this provider.ConfigurationBuilder<? extends Configuration>
MultiFileConfigurationBuilderProvider. getConfigurationBuilder(ConfigurationDeclaration decl)
Gets the builder for the configuration source managed by this provider.ConfigurationBuilder<? extends Configuration>
CombinedConfigurationBuilder.ConfigurationSourceData. getNamedBuilder(java.lang.String name)
Gets theConfigurationBuilder
with the given name.ConfigurationBuilder<? extends Configuration>
CombinedConfigurationBuilder. getNamedBuilder(java.lang.String name)
Gets the configuration builder with the given name.Methods in org.apache.commons.configuration2.builder.combined with parameters of type Configuration Modifier and Type Method Description private static ConfigurationBuilder<? extends Configuration>
MultiFileConfigurationBuilderProvider. createWrapperBuilder(ConfigurationBuilder<? extends Configuration> multiBuilder, Configuration wrapConfig)
Creates theConfigurationBuilder
to be returned by this provider.protected void
CombinedConfigurationBuilder. registerConfiguredLookups(HierarchicalConfiguration<?> defConfig, Configuration resultConfig)
Processes customLookup
objects that might be declared in the definition configuration.private void
CombinedConfigurationBuilder. setUpParentInterpolator(Configuration resultConfig, Configuration defConfig)
Sets up a parentConfigurationInterpolator
object.Method parameters in org.apache.commons.configuration2.builder.combined with type arguments of type Configuration Modifier and Type Method Description private void
CombinedConfigurationBuilder.ConfigurationSourceData. addChildConfiguration(CombinedConfiguration ccResult, ConfigurationDeclaration decl, ConfigurationBuilder<? extends Configuration> builder)
Creates a new configuration using the specified builder and adds it to the resulting combined configuration.protected void
BaseConfigurationBuilderProvider. configureBuilder(BasicConfigurationBuilder<? extends Configuration> builder, ConfigurationDeclaration decl, java.util.Collection<BuilderParameters> params)
Configures a newly created builder instance with its initialization parameters.private static ConfigurationBuilder<? extends Configuration>
MultiFileConfigurationBuilderProvider. createWrapperBuilder(ConfigurationBuilder<? extends Configuration> multiBuilder, Configuration wrapConfig)
Creates theConfigurationBuilder
to be returned by this provider.(package private) void
CombinedConfigurationBuilder. initChildEventListeners(BasicConfigurationBuilder<? extends Configuration> dest)
Initializes the event listeners of the specified builder from this object.Constructors in org.apache.commons.configuration2.builder.combined with parameters of type Configuration Constructor Description ReloadableWrapperBuilder(Configuration conf, ConfigurationBuilder<? extends Configuration> bldr)
Creates a new instance ofReloadableWrapperBuilder
.WrapperBuilder(Configuration conf, ConfigurationBuilder<? extends Configuration> bldr)
Creates a new instance ofWrapperBuilder
.Constructor parameters in org.apache.commons.configuration2.builder.combined with type arguments of type Configuration Constructor Description ReloadableWrapperBuilder(Configuration conf, ConfigurationBuilder<? extends Configuration> bldr)
Creates a new instance ofReloadableWrapperBuilder
.WrapperBuilder(Configuration conf, ConfigurationBuilder<? extends Configuration> bldr)
Creates a new instance ofWrapperBuilder
. -
Uses of Configuration in org.apache.commons.configuration2.plist
Classes in org.apache.commons.configuration2.plist that implement Configuration Modifier and Type Class Description class
PropertyListConfiguration
NeXT / OpenStep style configuration.class
XMLPropertyListConfiguration
Property list file (plist) in XML FORMAT as used by macOS X (http://www.apple.com/DTDs/PropertyList-1.0.dtd). -
Uses of Configuration in org.apache.commons.configuration2.web
Classes in org.apache.commons.configuration2.web that implement Configuration Modifier and Type Class Description class
AppletConfiguration
A configuration wrapper to read applet parameters.(package private) class
BaseWebConfiguration
An abstract base class for all web configurations.class
ServletConfiguration
A configuration wrapper around aServletConfig
.class
ServletContextConfiguration
A configuration wrapper to read the initialization parameters of a servlet context.class
ServletFilterConfiguration
A configuration wrapper around aFilterConfig
.class
ServletRequestConfiguration
A configuration wrapper to read the parameters of a servlet request.
-