org.apache.commons.configuration

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 $

Abstract configuration class.

Partial implementation of the FileConfiguration interface. Developpers of file based configuration may want to extend this class, the two methods left to implement are FileConfiguration.load(Reader) and FileConfiguration.save(Writer) .

This base class already implements a couple of ways to specify the location of the file this configuration is based on.

Base class for implementing file based hierarchical configurations.

This class serves an analogous purpose as the AbstractFileConfiguration class for non hierarchical configurations.

A specialized SAX2 XML parser that processes configuration objects.

This class mimics to be a SAX compliant XML parser.

A hierarchical composite configuration class.

This class maintains a list of configuration objects, which can be added using the divers addConfiguration() methods.

The main Configuration interface.

This interface allows accessing and manipulating a configuration object. The major part of the methods defined in this interface deals with accessing properties of various data types.

Definition of an interface for objects that can create a configuration.

This interface defines an abstract way of creating a Configuration object.

Factory class to create a CompositeConfiguration from a .xml file using Digester.

A simple class that supports creation of and iteration on complex configuration keys.

For key creation the class works similar to a StringBuffer: There are several appendXXXX() methods with which single parts of a key can be constructed.

A base class for "faked" XMLReader classes that transform a configuration object in a set of SAX parsing events.

This class provides dummy implementations for most of the methods defined in the XMLReader interface that are not used for this special purpose.

A factory class that creates a composite configuration from an XML based configuration definition file.

This class provides an easy and flexible means for loading multiple configuration sources and combining the results into a single configuration object.

A specialized configuration class that extends its base class by the ability of keeping more structure in the stored properties.

There are some sources of configuration data that cannot be stored very well in a BaseConfiguration object because then their structure is lost. This is especially true for XML documents.

A base class for converters that transform a normal configuration object into a hierarchical configuration.

This class provides a default mechanism for iterating over the keys in a configuration and to throw corresponding element start and end events.

A specialized SAX2 XML parser that "parses" hierarchical configuration objects.

This class mimics to be a SAX conform XML parser.

The parsed document will be stored keeping its structure.

An initialization or ini file is a configuration file tpically found on Microsoft's Windows operating system and contains data for Windows based applications.

Although popularized by Windows, ini files can be used on any system or platform due to the fact that they are merely text files that can easily be parsed and modified by both humans and computers.

A typcial ini file could look something like:

The format of ini files is fairly straight forward and is comosed of three components:

• Sections: Ini files are split into sections, each section starting with a section declaration.

In this class, empty PropertyConfigurations can be built, properties added and later saved.

A helper class used by PropertiesConfiguration to keep the layout of a properties file.

Instances of this class are associated with a PropertiesConfiguration object.

A specialized hierarchical configuration class that wraps a single node of its parent configuration.

Configurations of this type are initialized with a parent configuration and a configuration node of this configuration.

A subset of another configuration.

A specialized hierarchical configuration class that is able to parse XML documents.

The parsed document will be stored keeping its structure.

 <?xml version="1.0"?>
 <!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
 <properties>
 <comment>Description of the property list</comment>
 <entry key="key1">value1</entry>
 <entry key="key2">value2</entry>
 <entry key="key3">value3</entry>
 </properties>