Avalon Framework Implementation 4.3.1 · org.apache.avalon.framework.configuration.DefaultConfigurationBuilder

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:

Attributes starting with xmlns: are interpreted as declaring a prefix:namespaceURI mapping, and won't result in the creation of xmlns-prefixed attributes in the Configuration.
Prefixed XML elements, like <doc:title xmlns:doc="http://foo.com">, will result in a Configuration with getName().equals("title") and getNamespace().equals("http://foo.com").

Whitespace handling. Since mixed content is not allowed in the configurations, whitespace is completely discarded in non-leaf nodes. For the leaf nodes the default behavior is to trim the space surrounding the value. This can be changed by specifying xml:space attribute with value of preserve in that case the whitespace is left intact.

Field Summary

Modifier and Type	Field and Description
private SAXConfigurationHandler	m_handler
private XMLReader	m_parser

Constructor Summary

Access	Constructor and Description
public	DefaultConfigurationBuilder() Create a Configuration Builder with a default XMLReader that ignores namespaces.
public	DefaultConfigurationBuilder(final boolean If `true`, a namespace-aware `SAXParser` is used. If `false`, the default JAXP `SAXParser` (without namespace support) is used. enableNamespaces) Create a Configuration Builder, specifying a flag that determines namespace support.
public	DefaultConfigurationBuilder(XMLReader an `XMLReader` parser) Create a Configuration Builder with your own XMLReader.

Method Summary

Modifier and Type	Method and Description
public Configuration	Returns: a `Configuration` object build(final InputStream an `InputStream` value inputStream) Build a configuration object using an InputStream.
public Configuration	Returns: a `Configuration` object build(final InputStream an `InputStream` value inputStream, final String the systemId to set on the intermediate sax inputSource systemId) Build a configuration object using an InputStream; supplying a systemId to make messages about all kinds of errors more meaningfull.
public Configuration	Returns: a `Configuration` object build(final String a `String` value uri) Build a configuration object using an URI
public Configuration	Returns: a `Configuration` object build(final InputSource an `InputSource` value input) Build a configuration object using an XML InputSource object
public Configuration	Returns: a `Configuration` object buildFromFile(final String name of the file filename) Build a configuration object from a file using a filename.
public Configuration	Returns: a `Configuration` object buildFromFile(final File a `File` object file) Build a configuration object from a file using a File object.
protected SAXConfigurationHandler	Returns: a `SAXConfigurationHandler` getHandler() Get a SAXConfigurationHandler for your configuration reading.
public void	setEntityResolver(final EntityResolver implementation of `EntityResolver` resolver) Sets the `EntityResolver` to be used by parser.
private void	setParser(XMLReader parser) Internally sets up the XMLReader

Inherited from java.lang.Object:: clone equals finalize getClass hashCode notify notifyAll toString wait wait wait

Field Detail

m_handler	back to summary
private SAXConfigurationHandler m_handler

m_parser	back to summary
private XMLReader m_parser

Constructor Detail

DefaultConfigurationBuilder	back to summary
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 back to summary

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

public DefaultConfigurationBuilder(final boolean enableNamespaces)

Create a Configuration Builder, specifying a flag that determines namespace support.

Parameters

enableNamespaces:boolean: If true, a namespace-aware SAXParser is used. If false, the default JAXP SAXParser (without namespace support) is used.

Since

4.1

DefaultConfigurationBuilder back to summary

DefaultConfigurationBuilder	back to summary
public DefaultConfigurationBuilder(XMLReader parser) Create a Configuration Builder with your own XMLReader. Parameters parser:XMLReader an `XMLReader`

public DefaultConfigurationBuilder(XMLReader parser)

Create a Configuration Builder with your own XMLReader.

Parameters

parser:XMLReader: an XMLReader

Method Detail

build back to summary

build	back to summary
public Configuration build(final InputStream inputStream) throws SAXException, IOException, ConfigurationException Build a configuration object using an InputStream. Parameters inputStream:InputStream an `InputStream` value Returns:Configuration a `Configuration` object Exceptions SAXException: if a parsing error occurs IOException: if an I/O error occurs ConfigurationException: if an error occurs

public Configuration build(final InputStream inputStream) throws SAXException, IOException, ConfigurationException

Build a configuration object using an InputStream.

Parameters

inputStream:InputStream: an InputStream value

Returns:Configuration

a Configuration object

Exceptions

SAXException:: if a parsing error occurs
IOException:: if an I/O error occurs
ConfigurationException:: if an error occurs

build back to summary

build	back to summary
public Configuration build(final InputStream inputStream, final String systemId) throws SAXException, IOException, ConfigurationException Build a configuration object using an InputStream; supplying a systemId to make messages about all kinds of errors more meaningfull. Parameters inputStream:InputStream an `InputStream` value systemId:String the systemId to set on the intermediate sax inputSource Returns:Configuration a `Configuration` object Exceptions SAXException: if a parsing error occurs IOException: if an I/O error occurs ConfigurationException: if an error occurs

public Configuration build(final InputStream inputStream, final String systemId) throws SAXException, IOException, ConfigurationException

Build a configuration object using an InputStream; supplying a systemId to make messages about all kinds of errors more meaningfull.

Parameters

inputStream:InputStream: an InputStream value
systemId:String: the systemId to set on the intermediate sax inputSource

Returns:Configuration

a Configuration object

Exceptions

SAXException:: if a parsing error occurs
IOException:: if an I/O error occurs
ConfigurationException:: if an error occurs

build back to summary

build	back to summary
public Configuration build(final String uri) throws SAXException, IOException, ConfigurationException Build a configuration object using an URI Parameters uri:String a `String` value Returns:Configuration a `Configuration` object Exceptions SAXException: if a parsing error occurs IOException: if an I/O error occurs ConfigurationException: if an error occurs

public Configuration build(final String uri) throws SAXException, IOException, ConfigurationException

Build a configuration object using an URI

Parameters

uri:String: a String value

Returns:Configuration

a Configuration object

Exceptions

SAXException:: if a parsing error occurs
IOException:: if an I/O error occurs
ConfigurationException:: if an error occurs

build back to summary

build	back to summary
public Configuration build(final InputSource input) throws SAXException, IOException, ConfigurationException Build a configuration object using an XML InputSource object Parameters input:InputSource an `InputSource` value Returns:Configuration a `Configuration` object Exceptions SAXException: if a parsing error occurs IOException: if an I/O error occurs ConfigurationException: if an error occurs

public Configuration build(final InputSource input) throws SAXException, IOException, ConfigurationException

Build a configuration object using an XML InputSource object

Parameters

input:InputSource: an InputSource value

Returns:Configuration

a Configuration object

Exceptions

SAXException:: if a parsing error occurs
IOException:: if an I/O error occurs
ConfigurationException:: if an error occurs

buildFromFile back to summary

buildFromFile	back to summary
public Configuration buildFromFile(final String filename) throws SAXException, IOException, ConfigurationException Build a configuration object from a file using a filename. Parameters filename:String name of the file Returns:Configuration a `Configuration` object Exceptions SAXException: if a parsing error occurs IOException: if an I/O error occurs ConfigurationException: if an error occurs

public Configuration buildFromFile(final String filename) throws SAXException, IOException, ConfigurationException

Build a configuration object from a file using a filename.

Parameters

filename:String: name of the file

Returns:Configuration

a Configuration object

Exceptions

SAXException:: if a parsing error occurs
IOException:: if an I/O error occurs
ConfigurationException:: if an error occurs

buildFromFile back to summary

buildFromFile	back to summary
public Configuration buildFromFile(final File file) throws SAXException, IOException, ConfigurationException Build a configuration object from a file using a File object. Parameters file:File a `File` object Returns:Configuration a `Configuration` object Exceptions SAXException: if a parsing error occurs IOException: if an I/O error occurs ConfigurationException: if an error occurs

public Configuration buildFromFile(final File file) throws SAXException, IOException, ConfigurationException

Build a configuration object from a file using a File object.

Parameters

file:File: a File object

Returns:Configuration

a Configuration object

Exceptions

SAXException:: if a parsing error occurs
IOException:: if an I/O error occurs
ConfigurationException:: if an error occurs

getHandler back to summary

getHandler	back to summary
protected SAXConfigurationHandler getHandler() Get a SAXConfigurationHandler for your configuration reading. Returns:SAXConfigurationHandler a `SAXConfigurationHandler`

protected SAXConfigurationHandler getHandler()

Get a SAXConfigurationHandler for your configuration reading.

Returns:SAXConfigurationHandler: a SAXConfigurationHandler

setEntityResolver back to summary

setEntityResolver	back to summary
public void setEntityResolver(final EntityResolver resolver) Sets the `EntityResolver` to be used by parser. Useful when dealing with xml files that reference external entities. Parameters resolver:EntityResolver implementation of `EntityResolver`

public void setEntityResolver(final EntityResolver resolver)

Sets the EntityResolver to be used by parser. Useful when dealing with xml files that reference external entities.

Parameters

resolver:EntityResolver: implementation of EntityResolver

setParser	back to summary
private void setParser(XMLReader parser) Internally sets up the XMLReader

public Class DefaultConfigurationBuilder

Field Summary

Constructor Summary

Method Summary

Field Detail

Constructor Detail

Method Detail