Uses of Interface
org.apache.commons.configuration2.Configuration
Packages that use Configuration
Package
Description
The Configuration main package.
In this package a
Configuration
implementation can be found that implements the DynaBean
interface.
A package containing the implementation of the builder for combined configurations.
Configuration classes supporting NeXT / OpenStep /GNUStep style configuration.
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.configuration2Modifier and TypeInterfaceDescriptioninterface
An interface which combines theFileBased
andConfiguration
interfaces.interface
An interface for mutable hierarchical configurations.Classes in org.apache.commons.configuration2 that implement ConfigurationModifier and TypeClassDescriptionclass
Abstract configuration class.class
A specialized configuration class that extends its base class by the ability of keeping more structure in the stored properties.class
A base class for configuration implementations based on YAML structures.class
Basic configuration class.class
A specialized hierarchical configuration implementation that is based on a structure ofImmutableNode
objects.class
A hierarchical composite configuration class.class
CompositeConfiguration
allows you to add multipleConfiguration
objects to an aggregated configuration.class
Configuration stored in a database.class
Decorator providing additional getters for any Configuration.class
DynamicCombinedConfiguration allows a set of CombinedConfigurations to be used.class
A Configuration implementation that reads the platform specific environment variables using the map returned bySystem.getenv()
.class
A specialized hierarchical configuration implementation for parsing ini files.class
This Configuration class allows you to interface with a JNDI datasource.class
A specialized hierarchical configuration class that is able to parse JSON documents.class
A Map based Configuration.class
Wraps a BaseHierarchicalConfiguration and allows subtrees to be accessed via a configured path with replaceable tokens derived from the ConfigurationInterpolator.class
This is the "classic" Properties loader which loads the values from a single or multiple files (which can be chained with "include =".class
A specialized hierarchical configuration class with a node model that uses a tracked node of another node model as its root node.class
A subset of another configuration.class
A configuration based on the system properties.class
A specialized hierarchical configuration class that is able to parse XML documents.class
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 ConfigurationModifier and TypeFieldDescriptionprivate Configuration
BaseConfigurationXMLReader.config
Stores the actual configuration.private final Configuration
CombinedConfiguration.ConfigData.configuration
Stores a reference to the configuration.private final Configuration
ConfigurationMap.configuration
TheConfiguration
wrapped by this class.private final Configuration
ConfigurationMap.ConfigurationSet.configuration
The configuration mapped to this entry set.private final Configuration
DataConfiguration.configuration
Stores the wrapped configuration.private final 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 final Configuration
ImmutableConfigurationInvocationHandler.wrappedConfiguration
The underlying configuration object.Fields in org.apache.commons.configuration2 with type parameters of type ConfigurationModifier and TypeFieldDescriptionprivate List
<Configuration> CompositeConfiguration.configList
List holding all the configurationprivate Map
<String, Configuration> CombinedConfiguration.namedConfigurations
Stores a map with the named configurations.private final Map
<String, Configuration> DynamicCombinedConfiguration.namedConfigurations
Stores a map with the named configurations.Methods in org.apache.commons.configuration2 that return ConfigurationModifier and TypeMethodDescriptionstatic Configuration
ConfigurationUtils.cloneConfiguration
(Configuration config) Clones the given configuration object if this is possible.BaseConfigurationXMLReader.getConfiguration()
Gets the actual configuration to be processed.CombinedConfiguration.ConfigData.getConfiguration()
Gets the stored configuration.CombinedConfiguration.getConfiguration
(int index) Gets the configuration at the specified index.CombinedConfiguration.getConfiguration
(String name) Gets the configuration with the given name.CompositeConfiguration.getConfiguration
(int index) Gets the configuration at the specified index.static Configuration
ConfigurationConverter.getConfiguration
(Properties props) Convert a standard Properties class into a configuration class.ConfigurationMap.getConfiguration()
Gets the wrappedConfiguration
object.DataConfiguration.getConfiguration()
Gets the configuration decorated by this DataConfiguration.DynamicCombinedConfiguration.ConfigData.getConfiguration()
Gets the stored configuration.DynamicCombinedConfiguration.getConfiguration
(int index) Gets the configuration at the specified index.DynamicCombinedConfiguration.getConfiguration
(String name) Gets the configuration with the given name.CompositeConfiguration.getInMemoryConfiguration()
Gets the "in memory configuration".SubsetConfiguration.getParent()
Gets the parent configuration for this subset.BaseConfigurationXMLReader.getParsedConfiguration()
Gets the configuration to be processed.abstract Configuration
ConfigurationXMLReader.getParsedConfiguration()
Gets a reference to the configuration that is parsed by this object.HierarchicalConfigurationXMLReader.getParsedConfiguration()
Gets the configuration object to be processed.Gets the configuration source, in which the specified key is defined.Gets the configuration source, in which the specified key is defined.Gets the configuration source, in which the specified key is defined.AbstractConfiguration.interpolatedConfiguration()
Returns a configuration with the same content as this configuration, but with all variables replaced by their actual values.BaseHierarchicalConfiguration.interpolatedConfiguration()
Returns a configuration with the same content as this configuration, but with all variables replaced by their actual values.DynamicCombinedConfiguration.interpolatedConfiguration()
PatternSubtreeConfigurationWrapper.interpolatedConfiguration()
CombinedConfiguration.removeConfiguration
(String name) Removes the configuration with the specified name.DynamicCombinedConfiguration.removeConfiguration
(String name) Removes the configuration with the specified name.CombinedConfiguration.removeConfigurationAt
(int index) Removes the configuration at the specified index.DynamicCombinedConfiguration.removeConfigurationAt
(int index) Removes the configuration at the specified index.Creates a newConfiguration
object containing all keys that start with the specified prefix.Return a decorator Configuration containing every key from the current Configuration that starts with the specified prefix.Methods in org.apache.commons.configuration2 that return types with arguments of type ConfigurationModifier and TypeMethodDescriptionprivate Set
<Configuration> CombinedConfiguration.findSourceConfigurations
(ImmutableNode node) Determines the configurations to which the specified node belongs.CombinedConfiguration.getConfigurations()
Gets a List of all the configurations that have been added.CombinedConfiguration.getSources
(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 ConfigurationModifier and TypeMethodDescriptionvoid
CombinedConfiguration.addConfiguration
(Configuration config) Adds a new configuration to this combined configuration.void
CombinedConfiguration.addConfiguration
(Configuration config, String name) Adds a new configuration to this combined configuration with an optional name.void
CombinedConfiguration.addConfiguration
(Configuration config, String name, 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, 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.private void
CompositeConfiguration.appendListProperty
(List<Object> dest, Configuration config, 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
(Class<?>[] ifcs, Configuration c) Helper method for creating a proxy for an unmodifiable 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.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.protected String
HierarchicalConfigurationConverter.openElements
(DefaultConfigurationKey keyLast, DefaultConfigurationKey keyAct, Configuration config, Set<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 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 ConfigurationModifierConstructorDescriptionCreates 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, Collection<? extends Configuration> configurations) Creates a CompositeConfiguration with a specified in-memory configuration, and then adds the given collection of configurations.ConfigData
(Configuration config, String n, String at) Creates a new instance ofConfigData
and initializes it.ConfigData
(Configuration config, String n, String at) Creates a new instance ofConfigData
and initializes it.ConfigurationMap
(Configuration configuration) Creates a new instance of aConfigurationMap
that wraps the specifiedConfiguration
instance.(package private)
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, String prefix) Create a subset of the specified configurationSubsetConfiguration
(Configuration parent, String prefix, String delimiter) Create a subset of the specified configurationConstructor parameters in org.apache.commons.configuration2 with type arguments of type ConfigurationModifierConstructorDescriptionCompositeConfiguration
(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
Fields in org.apache.commons.configuration2.beanutils declared as ConfigurationModifier and TypeFieldDescriptionprivate final Configuration
ConfigurationDynaClass.configuration
Stores the associated configuration.Constructors in org.apache.commons.configuration2.beanutils with parameters of type ConfigurationModifierConstructorDescriptionConfigurationDynaBean
(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 ConfigurationModifier and TypeFieldDescriptionprivate final Configuration
MultiFileConfigurationBuilderProvider.WrapperBuilder.configuration
The configuration managed by this builder.Fields in org.apache.commons.configuration2.builder.combined with type parameters of type ConfigurationModifier and TypeFieldDescriptionprivate final Collection
<ConfigurationBuilder<? extends Configuration>> CombinedConfigurationBuilder.ConfigurationSourceData.allBuilders
A collection with all child builders.private final ConfigurationBuilder
<? extends Configuration> MultiFileConfigurationBuilderProvider.WrapperBuilder.builder
The builder to which this instance delegates.private final Map
<String, ConfigurationBuilder<? extends Configuration>> CombinedConfigurationBuilder.ConfigurationSourceData.namedBuilders
A map for direct access to a builder by its name.private final List
<ConfigurationBuilder<? extends Configuration>> CombinedConfigurationBuilder.ConfigurationSourceData.overrideBuilders
A list with the builders for override configurations.private final 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 ConfigurationModifier and TypeMethodDescriptionprivate Configuration
MultiFileConfigurationBuilderProvider.createWrapperConfiguration
(ConfigurationBuilder builder) Creates a configuration which wraps the specified builder.MultiFileConfigurationBuilderProvider.WrapperBuilder.getConfiguration()
Methods in org.apache.commons.configuration2.builder.combined that return types with arguments of type ConfigurationModifier and TypeMethodDescriptionList
<ConfigurationBuilder<? extends Configuration>> CombinedConfigurationBuilder.ConfigurationSourceData.createAndAddConfigurations
(CombinedConfiguration ccResult, List<ConfigurationDeclaration> srcDecl, 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, 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.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.Collection
<ConfigurationBuilder<? extends Configuration>> CombinedConfigurationBuilder.ConfigurationSourceData.getChildBuilders()
Gets a collection containing the builders for all child configuration sources.protected 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
(String name) Gets theConfigurationBuilder
with the given name.ConfigurationBuilder
<? extends Configuration> CombinedConfigurationBuilder.getNamedBuilder
(String name) Gets the configuration builder with the given name.Methods in org.apache.commons.configuration2.builder.combined with parameters of type ConfigurationModifier and TypeMethodDescriptionprivate 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 ConfigurationModifier and TypeMethodDescriptionprivate 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, 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 ConfigurationModifierConstructorDescriptionReloadableWrapperBuilder
(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 ConfigurationModifierConstructorDescriptionReloadableWrapperBuilder
(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 ConfigurationModifier and TypeClassDescriptionclass
NeXT / OpenStep style configuration.class
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 ConfigurationModifier and TypeClassDescriptionclass
A configuration wrapper to read applet parameters.(package private) class
An abstract base class for all web configurations.class
A configuration wrapper around aServletConfig
.class
A configuration wrapper to read the initialization parameters of a servlet context.class
A configuration wrapper around aFilterConfig
.class
A configuration wrapper to read the parameters of a servlet request.