HierarchicalConfigurationXMLReader

java.lang.Object
- org.apache.commons.configuration.ConfigurationXMLReader
- - org.apache.commons.configuration.HierarchicalConfigurationXMLReader

All Implemented Interfaces:

org.xml.sax.XMLReader
```
public class HierarchicalConfigurationXMLReader
extends ConfigurationXMLReader
```
A specialized SAX2 XML parser that "parses" hierarchical configuration objects.

This class mimics to be a SAX conform XML parser. Instead of parsing XML documents it processes a Configuration object and generates SAX events for the single properties defined there. This enables the whole world of XML processing for configuration objects.

The HierarchicalConfiguration object to be parsed can be specified using a constructor or the setConfiguration() method. This object will be processed by the parse() methods. Note that these methods ignore their argument.

Version:

$Id: HierarchicalConfigurationXMLReader.java 1209998 2011-12-03 20:31:16Z oheger $

Author:

Commons Configuration team

Field Summary
- Fields inherited from class org.apache.commons.configuration.ConfigurationXMLReader
  NS_URI

Constructor Summary

Constructors
Constructor	Description
`HierarchicalConfigurationXMLReader()`	Creates a new instance of `HierarchicalConfigurationXMLReader`.
`HierarchicalConfigurationXMLReader(HierarchicalConfiguration config)`	Creates a new instance of `HierarchicalConfigurationXMLReader` and sets the configuration to be parsed.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method	Description
`HierarchicalConfiguration`	`getConfiguration()`	Returns the configuration object to be parsed.
`Configuration`	`getParsedConfiguration()`	Returns the configuration object to be processed.
`protected void`	`processKeys()`	Processes the actual configuration object to generate SAX parsing events.
`void`	`setConfiguration(HierarchicalConfiguration config)`	Sets the configuration object to be parsed.

Methods inherited from class org.apache.commons.configuration.ConfigurationXMLReader
fireCharacters, fireElementEnd, fireElementStart, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getException, getFeature, getProperty, getRootName, parse, parse, parseConfiguration, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setProperty, setRootName

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - HierarchicalConfigurationXMLReader
```
public HierarchicalConfigurationXMLReader()
```
    Creates a new instance of HierarchicalConfigurationXMLReader.
  - HierarchicalConfigurationXMLReader
```
public HierarchicalConfigurationXMLReader(HierarchicalConfiguration config)
```
    Creates a new instance of HierarchicalConfigurationXMLReader and sets the configuration to be parsed.
    
    Parameters:
    
    config - the configuration object
- Method Detail
  - getConfiguration
```
public HierarchicalConfiguration getConfiguration()
```
    Returns the configuration object to be parsed.
    
    Returns:
    
    the configuration object to be parsed
  - setConfiguration
```
public void setConfiguration(HierarchicalConfiguration config)
```
    Sets the configuration object to be parsed.
    
    Parameters:
    
    config - the configuration object to be parsed
  - getParsedConfiguration
```
public Configuration getParsedConfiguration()
```
    Returns the configuration object to be processed.
    
    Specified by:
    
    getParsedConfiguration in class ConfigurationXMLReader
    
    Returns:
    
    the actual configuration object
  - processKeys
```
protected void processKeys()
```
    Processes the actual configuration object to generate SAX parsing events.
    
    Specified by:
    
    processKeys in class ConfigurationXMLReader