Class BaseConfigurationXMLReader

java.lang.Object
org.apache.commons.configuration2.ConfigurationXMLReader
org.apache.commons.configuration2.BaseConfigurationXMLReader
All Implemented Interfaces:
XMLReader

public class BaseConfigurationXMLReader extends ConfigurationXMLReader

A specialized SAX2 XML parser that processes configuration objects.

This class mimics to be a SAX compliant XML parser. It is able to iterate over the keys in a configuration object and to generate corresponding SAX events. By registering a ContentHandler at an instance it is possible to perform XML processing on a configuration object.

  • Field Details

    • config

      private Configuration config
      Stores the actual configuration.
  • Constructor Details

    • BaseConfigurationXMLReader

      public BaseConfigurationXMLReader()
      Creates a new instance of BaseConfigurationXMLReader.
    • BaseConfigurationXMLReader

      public BaseConfigurationXMLReader(Configuration conf)
      Creates a new instance of BaseConfigurationXMLReader and sets the configuration object to be parsed.
      Parameters:
      conf - the configuration to be parsed
  • Method Details

    • getConfiguration

      public Configuration getConfiguration()
      Gets the actual configuration to be processed.
      Returns:
      the actual configuration
    • getParsedConfiguration

      public Configuration getParsedConfiguration()
      Gets the configuration to be processed.
      Specified by:
      getParsedConfiguration in class ConfigurationXMLReader
      Returns:
      the actual configuration
    • processKeys

      protected void processKeys()
      The main SAX event generation method. This element uses an internal HierarchicalConfigurationConverter object to iterate over all keys in the actual configuration and to generate corresponding SAX events.
      Specified by:
      processKeys in class ConfigurationXMLReader
    • setConfiguration

      public void setConfiguration(Configuration conf)
      Sets the configuration to be processed.
      Parameters:
      conf - the configuration