Package | Description |
---|---|
org.apache.commons.configuration |
The Configuration main package.
|
org.apache.commons.configuration.beanutils |
In this package a
Configuration implementation can be found that
implements the DynaBean interface. |
org.apache.commons.configuration.plist |
Configuration classes supporting NeXT / OpenStep /GNUStep style configuration.
|
org.apache.commons.configuration.web |
This package contains some implementations of the
Configuration
interface that are useful in web environments. |
Modifier and Type | Interface and Description |
---|---|
interface |
FileConfiguration
A persistent configuration loaded and saved to a file.
|
Modifier and Type | Class and Description |
---|---|
class |
AbstractConfiguration
Abstract configuration class.
|
class |
AbstractFileConfiguration
Partial implementation of the
FileConfiguration interface. |
class |
AbstractHierarchicalFileConfiguration
Base class for implementing file based hierarchical configurations.
|
protected class |
AbstractHierarchicalFileConfiguration.FileConfigurationDelegate
A special implementation of the
FileConfiguration interface that is
used internally to implement the FileConfiguration methods
for hierarchical configurations. |
class |
BaseConfiguration
Basic configuration class.
|
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 |
DefaultConfigurationBuilder
A factory class that creates a composite configuration from an XML based
configuration definition file.
|
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 |
HierarchicalConfiguration
A specialized configuration class that extends its base class by the
ability of keeping more structure in the stored properties.
|
class |
HierarchicalINIConfiguration
A specialized hierarchical configuration implementation for parsing ini
files.
|
class |
HierarchicalReloadableConfiguration
A base class for hierarchical configurations with specific reloading
requirements.
|
class |
HierarchicalXMLConfiguration
Deprecated.
This class is deprecated. Use
XMLConfiguration
instead, which supports all features this class had offered before. |
class |
INIConfiguration
Deprecated.
This class has been replaced by HierarchicalINIConfiguration,
which provides a superset of the functionality offered by this class.
|
class |
JNDIConfiguration
This Configuration class allows you to interface with a JNDI datasource.
|
class |
MapConfiguration
A Map based Configuration.
|
class |
MultiFileHierarchicalConfiguration
This class provides access to multiple configuration files that reside in a location that
can be specified by a pattern allowing applications to be multi-tenant.
|
class |
PatternSubtreeConfigurationWrapper
Wraps a HierarchicalConfiguration and allows subtrees to be access 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 that wraps a single node of
its parent configuration.
|
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.
|
Modifier and Type | Field and Description |
---|---|
protected Configuration |
DataConfiguration.configuration
Stores the wrapped configuration.
|
protected Configuration |
SubsetConfiguration.parent
The parent configuration.
|
Modifier and Type | Method and Description |
---|---|
static Configuration |
ConfigurationUtils.cloneConfiguration(Configuration config)
Clones the given configuration object if this is possible.
|
protected Configuration |
ConfigurationFactory.ConfigurationBuilder.createAdditionalConfiguration(Collection<ConfigurationFactory.AdditionalConfigurationData> configs)
Creates a configuration object with the union of all properties
defined in the
<additional> section. |
Configuration |
DefaultConfigurationBuilder.getConfiguration()
Returns the configuration provided by this builder.
|
Configuration |
DataConfiguration.getConfiguration()
Return the configuration decorated by this DataConfiguration.
|
Configuration |
ConfigurationMap.getConfiguration()
Returns the wrapped
Configuration object. |
Configuration |
ConfigurationFactory.getConfiguration()
Deprecated.
Return the configuration provided by this factory.
|
Configuration |
ConfigurationFactory.AdditionalConfigurationData.getConfiguration()
Returns the configuration object.
|
Configuration |
ConfigurationBuilder.getConfiguration()
Returns the configuration provided by this builder.
|
Configuration |
BaseConfigurationXMLReader.getConfiguration()
Returns the actual configuration to be processed.
|
static Configuration |
ConfigurationConverter.getConfiguration(org.apache.commons.collections.ExtendedProperties eprops)
Convert a ExtendedProperties class into a Configuration class.
|
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 |
MultiFileHierarchicalConfiguration.interpolatedConfiguration() |
Configuration |
HierarchicalConfiguration.interpolatedConfiguration()
Returns a configuration with the same content as this configuration, but
with all variables replaced by their actual values.
|
Configuration |
DynamicCombinedConfiguration.interpolatedConfiguration() |
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 |
MultiFileHierarchicalConfiguration.subset(String prefix) |
Configuration |
HierarchicalConfiguration.subset(String prefix)
Creates a new
Configuration object containing all keys
that start with the specified 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 |
AbstractConfiguration.subset(String prefix) |
Modifier and Type | Method and Description |
---|---|
void |
ConfigurationFactory.AdditionalConfigurationData.addConfiguration(Configuration config)
Sets the configuration object.
|
void |
ConfigurationFactory.ConfigurationBuilder.addConfiguration(Configuration conf)
Adds a new configuration to this object.
|
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 |
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 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.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 org.apache.commons.collections.ExtendedProperties |
ConfigurationConverter.getExtendedProperties(Configuration config)
Convert a Configuration class into a ExtendedProperties class.
|
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 String |
ConfigurationUtils.toString(Configuration configuration)
Get a string representation of the key/value mappings of a
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 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.
|
Constructor and Description |
---|
ConfigurationDynaBean(Configuration configuration)
Creates a new instance of
ConfigurationDynaBean and sets
the configuration this bean is associated with. |
ConfigurationDynaClass(Configuration configuration)
Construct an instance of a
ConfigurationDynaClass
wrapping the specified Configuration instance. |
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–2013 The Apache Software Foundation. All rights reserved.