org.apache.avalon.framework.configuration

Class DefaultConfigurationSerializer

public class DefaultConfigurationSerializer extends Object

A ConfigurationSerializer serializes configurations via SAX2 compliant parser.

Version: $Id: DefaultConfigurationSerializer.java 30977 2004-07-30 03:57:54 -0500 (Fri, 30 Jul 2004) niclas $

Field Summary
Properties	m_format
SAXTransformerFactory	m_tfactory

Method Summary
protected ContentHandler	createContentHandler(Result result) Create a ContentHandler for an OutputStream
protected SAXTransformerFactory	getTransformerFactory() Get the SAXTransformerFactory so we can get a serializer without being tied to one vendor.
void	serialize(ContentHandler handler, Configuration source) Serialize the configuration to a ContentHandler
void	serialize(OutputStream outputStream, Configuration source) Serialize the configuration object to an output stream.
void	serialize(String uri, Configuration source) Serialize the configuration object to an output stream derived from an URI.
String	serialize(Configuration source) Serialize the configuration object to a string
protected void	serializeElement(ContentHandler handler, NamespaceSupport namespaceSupport, Configuration element) Serialize each Configuration element.
void	serializeToFile(String filename, Configuration source) Serialize the configuration object to a file using a filename.
void	serializeToFile(File file, Configuration source) Serialize the configuration object to a file using a File object.
void	setIndent(boolean indent) Sets the Serializer's use of indentation.

Field Detail

m_format

private Properties m_format

m_tfactory

private SAXTransformerFactory m_tfactory

Method Detail

createContentHandler

protected ContentHandler createContentHandler(Result result)

Create a ContentHandler for an OutputStream

Parameters: result the result

Returns: contenthandler that goes to specified OutputStream

getTransformerFactory

protected SAXTransformerFactory getTransformerFactory()

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

Returns: a SAXTransformerFactory value

serialize

public void serialize(ContentHandler handler, Configuration source)

Serialize the configuration to a ContentHandler

Parameters: handler a ContentHandler to serialize to source a Configuration value

Throws: SAXException if an error occurs ConfigurationException if an error occurs

serialize

public void serialize(OutputStream outputStream, Configuration source)

Serialize the configuration object to an output stream.

Parameters: outputStream an OutputStream value source a Configuration value

Throws: SAXException if an error occurs IOException if an error occurs ConfigurationException if an error occurs

serialize

public void serialize(String uri, Configuration source)

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 a String value source a Configuration value

Throws: SAXException if an error occurs IOException if an error occurs ConfigurationException if an error occurs

serialize

public String serialize(Configuration source)

Serialize the configuration object to a string

Parameters: source a Configuration value

Returns: configuration serialized as a string.

Throws: SAXException if an error occurs ConfigurationException if an error occurs

serializeElement

protected void serializeElement(ContentHandler handler, NamespaceSupport namespaceSupport, Configuration element)

Serialize each Configuration element. This method is called recursively.

Parameters: handler a ContentHandler to use namespaceSupport a NamespaceSupport to use element a Configuration value

Throws: SAXException if an error occurs ConfigurationException if an error occurs

serializeToFile

public void serializeToFile(String filename, Configuration source)

Serialize the configuration object to a file using a filename.

Parameters: filename a String value source a Configuration value

Throws: SAXException if an error occurs IOException if an error occurs ConfigurationException if an error occurs

serializeToFile

public void serializeToFile(File file, Configuration source)

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

Parameters: file a File value source a Configuration value

Throws: SAXException if an error occurs IOException if an error occurs ConfigurationException if an error occurs

setIndent

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 a boolean value