org.oddjob.arooa.xml

Class XMLConfiguration

java.lang.Object

org.oddjob.arooa.xml.XMLConfiguration

All Implemented Interfaces:

ArooaConfiguration

public class XMLConfiguration
extends java.lang.Object
implements ArooaConfiguration

An ArooaConfiguration that wraps some XML data and allows it to be parsed.

Author:

rob

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	XMLConfiguration.SaveHandler

Constructor Summary

Constructors

Constructor and Description
XMLConfiguration(java.io.File file) Constructor for a file.
XMLConfiguration(java.lang.String resource, java.lang.ClassLoader maybeClassLoader) Constructor for a ClassLoader resource.
XMLConfiguration(java.lang.String systemId, java.io.InputStream in) Constructor for an InputStream.
XMLConfiguration(java.lang.String systemId, java.lang.String xml) Constructor for Text.
XMLConfiguration(java.net.URL url) Constructor for a URL.

Method Summary

Modifier and Type	Method and Description
XMLConfiguration.SaveHandler	getSaveHandler()
<P extends ParseContext<P>> ConfigurationHandle<P>	parse(P parentContext) Parse the encapsulated configuration.
void	setSaveHandler(XMLConfiguration.SaveHandler saveHandler) Get the resultant XML from calling ConfigurationHandle.save().
java.lang.String	toString()

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Constructor Detail

XMLConfiguration

public XMLConfiguration(java.io.File file)

Constructor for a file.

Parameters:

file -

XMLConfiguration

public XMLConfiguration(java.lang.String systemId,
                        java.lang.String xml)

Constructor for Text.

Parameters:

systemId -

xml -

XMLConfiguration

public XMLConfiguration(java.lang.String resource,
                        java.lang.ClassLoader maybeClassLoader)

Constructor for a ClassLoader resource. Note that, like the underlying ClassLoader.getResourceAsStream, the resource does not have a '/' before the package name.

E.g. new XMLConfiguration("org/oddjob/stuff/config.xml");

Parameters:

resource -

XMLConfiguration

public XMLConfiguration(java.lang.String systemId,
                        java.io.InputStream in)

Constructor for an InputStream.

Parameters:

systemId -

in -

XMLConfiguration

public XMLConfiguration(java.net.URL url)

Constructor for a URL.

Parameters:

url -

Method Detail

parse

public <P extends ParseContext<P>> ConfigurationHandle<P> parse(P parentContext)
                                                         throws ArooaParseException

Description copied from interface: ArooaConfiguration

Parse the encapsulated configuration.

Specified by:

parse in interface ArooaConfiguration

Type Parameters:

P - The type of the context in which parsing occurs.

Parameters:

parentContext - The context in which this configuration will be parsed. This context will provide the ArooaHandler, and therefore subsequent child contexts.

Returns:

A ConfigurationHandle. The handle provides access to the context created as the result of the parse and a way of saving this context back into the configuration.

Throws:

ArooaParseException - If parsing fails.

setSaveHandler

public void setSaveHandler(XMLConfiguration.SaveHandler saveHandler)

Get the resultant XML from calling ConfigurationHandle.save().

getSaveHandler

public XMLConfiguration.SaveHandler getSaveHandler()

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object