Class HierarchicalConfigurationXMLReader<T>
- java.lang.Object
-
- org.apache.commons.configuration2.ConfigurationXMLReader
-
- org.apache.commons.configuration2.HierarchicalConfigurationXMLReader<T>
-
- Type Parameters:
T- the type of the nodes supported by this reader
- All Implemented Interfaces:
XMLReader
public class HierarchicalConfigurationXMLReader<T> 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
Configurationobject and generates SAX events for the single properties defined there. This enables the whole world of XML processing for configuration objects.The
HierarchicalConfigurationobject to be parsed can be specified using a constructor or thesetConfiguration()method. This object will be processed by theparse()methods. Note that these methods ignore their argument.
-
-
Field Summary
-
Fields inherited from class org.apache.commons.configuration2.ConfigurationXMLReader
NS_URI
-
-
Constructor Summary
Constructors Constructor Description HierarchicalConfigurationXMLReader()Creates a new instance ofHierarchicalConfigurationXMLReader.HierarchicalConfigurationXMLReader(HierarchicalConfiguration<T> config)Creates a new instance ofHierarchicalConfigurationXMLReaderand sets the configuration to be parsed.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description HierarchicalConfiguration<T>getConfiguration()Gets the configuration object to be parsed.ConfigurationgetParsedConfiguration()Gets the configuration object to be processed.protected voidprocessKeys()Processes the actual configuration object to generate SAX parsing events.voidsetConfiguration(HierarchicalConfiguration<T> config)Sets the configuration object to be parsed.-
Methods inherited from class org.apache.commons.configuration2.ConfigurationXMLReader
fireCharacters, fireElementEnd, fireElementStart, getContentHandler, getDTDHandler, getEntityResolver, getErrorHandler, getException, getFeature, getProperty, getRootName, parse, parse, parseConfiguration, setContentHandler, setDTDHandler, setEntityResolver, setErrorHandler, setFeature, setProperty, setRootName
-
-
-
-
Constructor Detail
-
HierarchicalConfigurationXMLReader
public HierarchicalConfigurationXMLReader()
Creates a new instance ofHierarchicalConfigurationXMLReader.
-
HierarchicalConfigurationXMLReader
public HierarchicalConfigurationXMLReader(HierarchicalConfiguration<T> config)
Creates a new instance ofHierarchicalConfigurationXMLReaderand sets the configuration to be parsed.- Parameters:
config- the configuration object
-
-
Method Detail
-
getConfiguration
public HierarchicalConfiguration<T> getConfiguration()
Gets the configuration object to be parsed.- Returns:
- the configuration object to be parsed
-
setConfiguration
public void setConfiguration(HierarchicalConfiguration<T> config)
Sets the configuration object to be parsed.- Parameters:
config- the configuration object to be parsed
-
getParsedConfiguration
public Configuration getParsedConfiguration()
Gets the configuration object to be processed.- Specified by:
getParsedConfigurationin classConfigurationXMLReader- Returns:
- the actual configuration object
-
processKeys
protected void processKeys()
Processes the actual configuration object to generate SAX parsing events.- Specified by:
processKeysin classConfigurationXMLReader
-
-