Top Description Fields Constructors Methods
org.apache.avalon.framework.configuration

public Class DefaultConfigurationSerializer

extends Object
Class Inheritance
Imports
java.io.File, .FileOutputStream, .IOException, .OutputStream, .StringWriter, java.net.URL, java.util.Properties, javax.xml.transform.OutputKeys, .Result, .TransformerFactory, javax.xml.transform.sax.SAXTransformerFactory, .TransformerHandler, javax.xml.transform.stream.StreamResult, org.xml.sax.ContentHandler, .SAXException, org.xml.sax.helpers.AttributesImpl, .NamespaceSupport
A ConfigurationSerializer serializes configurations via SAX2 compliant parser.
Author
Avalon Development Team
Version
$Id: DefaultConfigurationSerializer.java 506231 2007-02-12 02:36:54Z crossley $

Field Summary

Modifier and TypeField and Description
private Properties
m_format

private SAXTransformerFactory
m_tfactory

Constructor Summary

AccessConstructor and Description
public
DefaultConfigurationSerializer()

Method Summary

Modifier and TypeMethod and Description
protected ContentHandler

Returns:

contenthandler that goes to specified OutputStream
createContentHandler(final Result
the result
result)

Create a ContentHandler for an OutputStream

protected SAXTransformerFactory

Returns:

a SAXTransformerFactory value
getTransformerFactory()

Get the SAXTransformerFactory so we can get a serializer without being tied to one vendor.

public void
serialize(final ContentHandler
a ContentHandler to serialize to
handler, final Configuration
a Configuration value
source)

Serialize the configuration to a ContentHandler

public void
serialize(final OutputStream
an OutputStream value
outputStream, final Configuration
a Configuration value
source)

Serialize the configuration object to an output stream.

public void
serialize(final String
a String value
uri, final Configuration
a Configuration value
source)

Serialize the configuration object to an output stream derived from an URI.

public String

Returns:

configuration serialized as a string.
serialize(final Configuration
a Configuration value
source)

Serialize the configuration object to a string

protected void
serializeElement(final ContentHandler
a ContentHandler to use
handler, final NamespaceSupport
a NamespaceSupport to use
namespaceSupport, final Configuration
a Configuration value
element)

Serialize each Configuration element.

public void
serializeToFile(final String
a String value
filename, final Configuration
a Configuration value
source)

Serialize the configuration object to a file using a filename.

public void
serializeToFile(final File
a File value
file, final Configuration
a Configuration value
source)

Serialize the configuration object to a file using a File object.

public void
setIndent(boolean
a boolean value
indent)

Sets the Serializer's use of indentation.

Inherited from java.lang.Object:
cloneequalsfinalizegetClasshashCodenotifynotifyAlltoStringwaitwaitwait

Field Detail

m_formatback to summary
private Properties m_format
m_tfactoryback to summary
private SAXTransformerFactory m_tfactory

Constructor Detail

DefaultConfigurationSerializerback to summary
public DefaultConfigurationSerializer()

Method Detail

createContentHandlerback to summary
protected ContentHandler createContentHandler(final Result result)

Create a ContentHandler for an OutputStream

Parameters
result:Result

the result

Returns:ContentHandler

contenthandler that goes to specified OutputStream

getTransformerFactoryback to summary
protected SAXTransformerFactory getTransformerFactory()

Get the SAXTransformerFactory so we can get a serializer without being tied to one vendor.

Returns:SAXTransformerFactory

a SAXTransformerFactory value

serializeback to summary
public void serialize(final ContentHandler handler, final Configuration source) throws SAXException, ConfigurationException

Serialize the configuration to a ContentHandler

Parameters
handler:ContentHandler

a ContentHandler to serialize to

source:Configuration

a Configuration value

Exceptions
SAXException:
if an error occurs
ConfigurationException:
if an error occurs
serializeback to summary
public void serialize(final OutputStream outputStream, final Configuration source) throws SAXException, IOException, ConfigurationException

Serialize the configuration object to an output stream.

Parameters
outputStream:OutputStream

an OutputStream value

source:Configuration

a Configuration value

Exceptions
SAXException:
if an error occurs
IOException:
if an error occurs
ConfigurationException:
if an error occurs
serializeback to summary
public void serialize(final String uri, final Configuration source) throws SAXException, IOException, ConfigurationException

Serialize the configuration object to an output stream derived from an URI. The URI must be resolveable by the java.net.URL object.

Parameters
uri:String

a String value

source:Configuration

a Configuration value

Exceptions
SAXException:
if an error occurs
IOException:
if an error occurs
ConfigurationException:
if an error occurs
serializeback to summary
public String serialize(final Configuration source) throws SAXException, ConfigurationException

Serialize the configuration object to a string

Parameters
source:Configuration

a Configuration value

Returns:String

configuration serialized as a string.

Exceptions
SAXException:
if an error occurs
ConfigurationException:
if an error occurs
serializeElementback to summary
protected void serializeElement(final ContentHandler handler, final NamespaceSupport namespaceSupport, final Configuration element) throws SAXException, ConfigurationException

Serialize each Configuration element. This method is called recursively.

Parameters
handler:ContentHandler

a ContentHandler to use

namespaceSupport:NamespaceSupport

a NamespaceSupport to use

element:Configuration

a Configuration value

Exceptions
SAXException:
if an error occurs
ConfigurationException:
if an error occurs
serializeToFileback to summary
public void serializeToFile(final String filename, final Configuration source) throws SAXException, IOException, ConfigurationException

Serialize the configuration object to a file using a filename.

Parameters
filename:String

a String value

source:Configuration

a Configuration value

Exceptions
SAXException:
if an error occurs
IOException:
if an error occurs
ConfigurationException:
if an error occurs
serializeToFileback to summary
public void serializeToFile(final File file, final Configuration source) throws SAXException, IOException, ConfigurationException

Serialize the configuration object to a file using a File object.

Parameters
file:File

a File value

source:Configuration

a Configuration value

Exceptions
SAXException:
if an error occurs
IOException:
if an error occurs
ConfigurationException:
if an error occurs
setIndentback to summary
public void setIndent(boolean indent)

Sets the Serializer's use of indentation. This will cause linefeeds to be added after each element, but it does not add any indentation via spaces.

Parameters
indent:boolean

a boolean value