Package org.apache.commons.configuration

The Configuration main package.

See: Description

Interface Summary

Interface	Description
Configuration	The main Configuration interface.
ConfigurationBuilder	Definition of an interface for objects that can create a configuration.
ConfigurationComparator	Comparator for configurations interface.
FileConfiguration	A persistent configuration loaded and saved to a file.
FileOptionsProvider	Some FileSystems allow options to be passed on File operations.
FileSystemBased	Interface used to install or locate the FileSystem
PropertiesConfiguration.IOFactory	Definition of an interface that allows customization of read and write operations.

Class Summary

Class	Description
AbstractConfiguration	Abstract configuration class.
AbstractFileConfiguration	Partial implementation of the FileConfiguration interface.
AbstractHierarchicalFileConfiguration	Base class for implementing file based hierarchical configurations.
BaseConfiguration	Basic configuration class.
BaseConfigurationXMLReader	A specialized SAX2 XML parser that processes configuration objects.
CombinedConfiguration	A hierarchical composite configuration class.
CompositeConfiguration	CompositeConfiguration allows you to add multiple Configuration objects to an aggregated configuration.
ConfigurationConverter	Configuration converter.
ConfigurationFactory	Deprecated Use DefaultConfigurationBuilder instead; this class provides the same features as ConfigurationFactory plus some more; it can also process the same configuration definition files.
ConfigurationFactory.AdditionalConfigurationData	A simple data class that holds all information about a configuration from the <additional> section.
ConfigurationFactory.ConfigurationBuilder	An internally used helper class for constructing the composite configuration object.
ConfigurationKey	Deprecated Use DefaultConfigurationKey instead.
ConfigurationMap	The ConfigurationMap wraps a configuration-collection Configuration instance to provide a Map interface.
ConfigurationUtils	Miscellaneous utility methods for configurations.
ConfigurationXMLReader	A base class for "faked" XMLReader classes that transform a configuration object in a set of SAX parsing events.
DatabaseConfiguration	Configuration stored in a database.
DataConfiguration	Decorator providing additional getters for any Configuration.
DefaultConfigurationBuilder	A factory class that creates a composite configuration from an XML based configuration definition file.
DefaultConfigurationBuilder.ConfigurationDeclaration	A specialized BeanDeclaration implementation that represents the declaration of a configuration source.
DefaultConfigurationBuilder.ConfigurationProvider	A base class for creating and initializing configuration sources.
DefaultConfigurationBuilder.FileConfigurationProvider	A specialized provider implementation that deals with file based configurations.
DefaultConfigurationBuilder.XMLConfigurationProvider	A specialized configuration provider for XML configurations.
DefaultFileSystem	FileSystem that uses java.io.File or HttpClient
DynamicCombinedConfiguration	DynamicCombinedConfiguration allows a set of CombinedConfigurations to be used.
EnvironmentConfiguration	A Configuration implementation that reads the platform specific environment variables using the map returned by System.getenv().
FileSystem	Abstract layer to allow various types of file systems.
HierarchicalConfiguration	A specialized configuration class that extends its base class by the ability of keeping more structure in the stored properties.
HierarchicalConfiguration.BuilderVisitor	A specialized visitor base class that can be used for storing the tree of configuration nodes.
HierarchicalConfiguration.Node	A data class for storing (hierarchical) property information.
HierarchicalConfiguration.NodeVisitor	Definition of a visitor class for traversing a node and all of its children.
HierarchicalConfigurationXMLReader	A specialized SAX2 XML parser that "parses" hierarchical configuration objects.
HierarchicalINIConfiguration	A specialized hierarchical configuration implementation for parsing ini files.
HierarchicalReloadableConfiguration	A base class for hierarchical configurations with specific reloading requirements.
HierarchicalXMLConfiguration	Deprecated This class is deprecated.
INIConfiguration	Deprecated This class has been replaced by HierarchicalINIConfiguration, which provides a superset of the functionality offered by this class.
JNDIConfiguration	This Configuration class allows you to interface with a JNDI datasource.
Lock	A simple class acting as lock.
MapConfiguration	A Map based Configuration.
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.
PatternSubtreeConfigurationWrapper	Wraps a HierarchicalConfiguration and allows subtrees to be access via a configured path with replaceable tokens derived from the ConfigurationInterpolator.
PropertiesConfiguration	This is the "classic" Properties loader which loads the values from a single or multiple files (which can be chained with "include =".
PropertiesConfiguration.DefaultIOFactory	A default implementation of the IOFactory interface.
PropertiesConfiguration.PropertiesReader	This class is used to read properties lines.
PropertiesConfiguration.PropertiesWriter	This class is used to write properties lines.
PropertiesConfigurationLayout	A helper class used by PropertiesConfiguration to keep the layout of a properties file.
PropertyConverter	A utility class to convert the configuration properties into any type.
StrictConfigurationComparator	Strict comparator for configurations.
SubnodeConfiguration	A specialized hierarchical configuration class that wraps a single node of its parent configuration.
SubsetConfiguration	A subset of another configuration.
SystemConfiguration	A configuration based on the system properties.
VFSFileSystem	FileSystem that uses Commons VFS
XMLConfiguration	A specialized hierarchical configuration class that is able to parse XML documents.
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.

Exception Summary

Exception	Description
ConfigurationException	Any exception that occurs while initializing a Configuration object.
ConfigurationRuntimeException	A configuration related runtime exception.
ConversionException	Exception thrown when a property is incompatible with the type requested.

Package org.apache.commons.configuration Description

The Configuration main package. It contains the definition of the Configuration interface and frequently used implementations like PropertiesConfiguration (dealing with .properties files) or XMLConfiguration that can load XML documents.

$Id: package.html 439648 2006-09-02 20:42:10Z oheger $