Class DefaultConfigurationSerializer
java.lang.Object
org.apache.avalon.framework.configuration.DefaultConfigurationSerializer
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 $
- Author:
- Avalon Development Team
-
Field Summary
Fields -
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprotected ContentHandler
createContentHandler
(Result result) Create a ContentHandler for an OutputStreamprotected SAXTransformerFactory
Get the SAXTransformerFactory so we can get a serializer without being tied to one vendor.void
serialize
(OutputStream outputStream, org.apache.avalon.framework.configuration.Configuration source) Serialize the configuration object to an output stream.void
Serialize the configuration object to an output stream derived from an URI.serialize
(org.apache.avalon.framework.configuration.Configuration source) Serialize the configuration object to a stringvoid
serialize
(ContentHandler handler, org.apache.avalon.framework.configuration.Configuration source) Serialize the configuration to a ContentHandlerprotected void
serializeElement
(ContentHandler handler, NamespaceSupport namespaceSupport, org.apache.avalon.framework.configuration.Configuration element) Serialize each Configuration element.void
serializeToFile
(File file, org.apache.avalon.framework.configuration.Configuration source) Serialize the configuration object to a file using a File object.void
serializeToFile
(String filename, org.apache.avalon.framework.configuration.Configuration source) Serialize the configuration object to a file using a filename.void
setIndent
(boolean indent) Sets the Serializer's use of indentation.
-
Field Details
-
m_tfactory
-
m_format
-
-
Constructor Details
-
DefaultConfigurationSerializer
public DefaultConfigurationSerializer()
-
-
Method Details
-
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
- aboolean
value
-
createContentHandler
Create a ContentHandler for an OutputStream- Parameters:
result
- the result- Returns:
- contenthandler that goes to specified OutputStream
-
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, org.apache.avalon.framework.configuration.Configuration source) throws SAXException, org.apache.avalon.framework.configuration.ConfigurationException Serialize the configuration to a ContentHandler- Parameters:
handler
- aContentHandler
to serialize tosource
- aConfiguration
value- Throws:
SAXException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serializeElement
protected void serializeElement(ContentHandler handler, NamespaceSupport namespaceSupport, org.apache.avalon.framework.configuration.Configuration element) throws SAXException, org.apache.avalon.framework.configuration.ConfigurationException Serialize each Configuration element. This method is called recursively.- Parameters:
handler
- aContentHandler
to usenamespaceSupport
- aNamespaceSupport
to useelement
- aConfiguration
value- Throws:
SAXException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serializeToFile
public void serializeToFile(String filename, org.apache.avalon.framework.configuration.Configuration source) throws SAXException, IOException, org.apache.avalon.framework.configuration.ConfigurationException Serialize the configuration object to a file using a filename.- Parameters:
filename
- aString
valuesource
- aConfiguration
value- Throws:
SAXException
- if an error occursIOException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serializeToFile
public void serializeToFile(File file, org.apache.avalon.framework.configuration.Configuration source) throws SAXException, IOException, org.apache.avalon.framework.configuration.ConfigurationException Serialize the configuration object to a file using a File object.- Parameters:
file
- aFile
valuesource
- aConfiguration
value- Throws:
SAXException
- if an error occursIOException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serialize
public void serialize(OutputStream outputStream, org.apache.avalon.framework.configuration.Configuration source) throws SAXException, IOException, org.apache.avalon.framework.configuration.ConfigurationException Serialize the configuration object to an output stream.- Parameters:
outputStream
- anOutputStream
valuesource
- aConfiguration
value- Throws:
SAXException
- if an error occursIOException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serialize
public void serialize(String uri, org.apache.avalon.framework.configuration.Configuration source) throws SAXException, IOException, org.apache.avalon.framework.configuration.ConfigurationException Serialize the configuration object to an output stream derived from an URI. The URI must be resolveable by thejava.net.URL
object.- Parameters:
uri
- aString
valuesource
- aConfiguration
value- Throws:
SAXException
- if an error occursIOException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serialize
public String serialize(org.apache.avalon.framework.configuration.Configuration source) throws SAXException, org.apache.avalon.framework.configuration.ConfigurationException Serialize the configuration object to a string- Parameters:
source
- aConfiguration
value- Returns:
- configuration serialized as a string.
- Throws:
SAXException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-