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
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.
-
Nested Class Summary
Nested ClassesModifier and TypeClassDescriptionprivate class
A specialized visitor class for generating SAX events for a hierarchical node structure. -
Field Summary
FieldsModifier and TypeFieldDescriptionprivate HierarchicalConfiguration<T>
Stores the configuration object to be parsed.Fields inherited from class org.apache.commons.configuration2.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 TypeMethodDescriptionGets the configuration object to be parsed.Gets the configuration object to be processed.protected void
Processes the actual configuration object to generate SAX parsing events.void
setConfiguration
(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
-
Field Details
-
configuration
Stores the configuration object to be parsed.
-
-
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
Gets 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
Gets the configuration object to be processed.- Specified by:
getParsedConfiguration
in classConfigurationXMLReader
- Returns:
- the actual configuration object
-
processKeys
protected void processKeys()Processes the actual configuration object to generate SAX parsing events.- Specified by:
processKeys
in classConfigurationXMLReader
-