Package org.apache.commons.configuration
Class HierarchicalConfigurationXMLReader
java.lang.Object
org.apache.commons.configuration.ConfigurationXMLReader
org.apache.commons.configuration.HierarchicalConfigurationXMLReader
- All Implemented Interfaces:
XMLReader
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
ConstructorsConstructorDescriptionCreates a new instance ofHierarchicalConfigurationXMLReader
.Creates a new instance ofHierarchicalConfigurationXMLReader
and sets the configuration to be parsed. -
Method Summary
Modifier and TypeMethodDescriptionReturns the configuration object to be parsed.Returns the configuration object to be processed.protected void
Processes the actual configuration object to generate SAX parsing events.void
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
-
Constructor Details
-
HierarchicalConfigurationXMLReader
public HierarchicalConfigurationXMLReader()Creates a new instance ofHierarchicalConfigurationXMLReader
. -
HierarchicalConfigurationXMLReader
Creates a new instance ofHierarchicalConfigurationXMLReader
and sets the configuration to be parsed.- Parameters:
config
- the configuration object
-
-
Method Details
-
getConfiguration
Returns the configuration object to be parsed.- Returns:
- the configuration object to be parsed
-
setConfiguration
Sets the configuration object to be parsed.- Parameters:
config
- the configuration object to be parsed
-
getParsedConfiguration
Returns the configuration object to be processed.- Specified by:
getParsedConfiguration
in classConfigurationXMLReader
- Returns:
- the actual configuration object
-
processKeys
Processes the actual configuration object to generate SAX parsing events.- Specified by:
processKeys
in classConfigurationXMLReader
-