org.apache.avalon.framework.configuration
Class DefaultConfigurationBuilder

java.lang.Object
  |
  +--org.apache.avalon.framework.configuration.DefaultConfigurationBuilder

public class DefaultConfigurationBuilder
extends java.lang.Object

A DefaultConfigurationBuilder builds Configurations from XML, via a SAX2 compliant parser.

XML namespace support is optional, and disabled by default to preserve backwards-compatibility. To enable it, pass the DefaultConfigurationBuilder(boolean) constructor the flag true, or pass a namespace-enabled XMLReader to the DefaultConfigurationBuilder(XMLReader) constructor.

The mapping from XML namespaces to Configuration namespaces is pretty straightforward, with one caveat: attribute namespaces are (deliberately) not supported. Enabling namespace processing has the following effects:

Author:
Federico Barbieri, Peter Donald, Berin Loritsch

Constructor Summary
DefaultConfigurationBuilder()
          Create a Configuration Builder with a default XMLReader that ignores namespaces.
DefaultConfigurationBuilder(boolean enableNamespaces)
          Create a Configuration Builder, specifying a flag that determines namespace support.
DefaultConfigurationBuilder(org.xml.sax.XMLReader parser)
          Create a Configuration Builder with your own XMLReader.
 
Method Summary
 Configuration build(org.xml.sax.InputSource input)
          Build a configuration object using an XML InputSource object
 Configuration build(java.io.InputStream inputStream)
          Build a configuration object using an InputStream.
 Configuration build(java.lang.String uri)
          Build a configuration object using an URI
 Configuration buildFromFile(java.io.File file)
          Build a configuration object from a file using a File object.
 Configuration buildFromFile(java.lang.String filename)
          Build a configuration object from a file using a filename.
protected  SAXConfigurationHandler getHandler()
          Get a SAXConfigurationHandler for your configuration reading.
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

DefaultConfigurationBuilder

public DefaultConfigurationBuilder()
Create a Configuration Builder with a default XMLReader that ignores namespaces. In order to enable namespaces, use either the constructor that has a boolean or that allows you to pass in your own namespace-enabled XMLReader.

DefaultConfigurationBuilder

public DefaultConfigurationBuilder(boolean enableNamespaces)
Create a Configuration Builder, specifying a flag that determines namespace support.
Parameters:
enableNamespaces - If true, a namespace-aware SAXParser is used. If false, the default JAXP SAXParser (without namespace support) is used.

DefaultConfigurationBuilder

public DefaultConfigurationBuilder(org.xml.sax.XMLReader parser)
Create a Configuration Builder with your own XMLReader.
Method Detail

getHandler

protected SAXConfigurationHandler getHandler()
Get a SAXConfigurationHandler for your configuration reading.

buildFromFile

public Configuration buildFromFile(java.lang.String filename)
                            throws org.xml.sax.SAXException,
                                   java.io.IOException,
                                   ConfigurationException
Build a configuration object from a file using a filename.

buildFromFile

public Configuration buildFromFile(java.io.File file)
                            throws org.xml.sax.SAXException,
                                   java.io.IOException,
                                   ConfigurationException
Build a configuration object from a file using a File object.

build

public Configuration build(java.io.InputStream inputStream)
                    throws org.xml.sax.SAXException,
                           java.io.IOException,
                           ConfigurationException
Build a configuration object using an InputStream.

build

public Configuration build(java.lang.String uri)
                    throws org.xml.sax.SAXException,
                           java.io.IOException,
                           ConfigurationException
Build a configuration object using an URI

build

public Configuration build(org.xml.sax.InputSource input)
                    throws org.xml.sax.SAXException,
                           java.io.IOException,
                           ConfigurationException
Build a configuration object using an XML InputSource object


"Copyright © 2001 Apache Jakarta Project. All Rights Reserved."