Class DefaultConfigurationSerializer
- java.lang.Object
-
- org.apache.avalon.framework.configuration.DefaultConfigurationSerializer
-
public class DefaultConfigurationSerializer extends java.lang.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 $
- Author:
- Avalon Development Team
-
-
Field Summary
Fields Modifier and Type Field Description private java.util.Properties
m_format
private javax.xml.transform.sax.SAXTransformerFactory
m_tfactory
-
Constructor Summary
Constructors Constructor Description DefaultConfigurationSerializer()
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description protected org.xml.sax.ContentHandler
createContentHandler(javax.xml.transform.Result result)
Create a ContentHandler for an OutputStreamprotected javax.xml.transform.sax.SAXTransformerFactory
getTransformerFactory()
Get the SAXTransformerFactory so we can get a serializer without being tied to one vendor.void
serialize(java.io.OutputStream outputStream, org.apache.avalon.framework.configuration.Configuration source)
Serialize the configuration object to an output stream.void
serialize(java.lang.String uri, org.apache.avalon.framework.configuration.Configuration source)
Serialize the configuration object to an output stream derived from an URI.java.lang.String
serialize(org.apache.avalon.framework.configuration.Configuration source)
Serialize the configuration object to a stringvoid
serialize(org.xml.sax.ContentHandler handler, org.apache.avalon.framework.configuration.Configuration source)
Serialize the configuration to a ContentHandlerprotected void
serializeElement(org.xml.sax.ContentHandler handler, org.xml.sax.helpers.NamespaceSupport namespaceSupport, org.apache.avalon.framework.configuration.Configuration element)
Serialize each Configuration element.void
serializeToFile(java.io.File file, org.apache.avalon.framework.configuration.Configuration source)
Serialize the configuration object to a file using a File object.void
serializeToFile(java.lang.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.
-
-
-
Method Detail
-
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
protected org.xml.sax.ContentHandler createContentHandler(javax.xml.transform.Result result)
Create a ContentHandler for an OutputStream- Parameters:
result
- the result- Returns:
- contenthandler that goes to specified OutputStream
-
getTransformerFactory
protected javax.xml.transform.sax.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(org.xml.sax.ContentHandler handler, org.apache.avalon.framework.configuration.Configuration source) throws org.xml.sax.SAXException, org.apache.avalon.framework.configuration.ConfigurationException
Serialize the configuration to a ContentHandler- Parameters:
handler
- aContentHandler
to serialize tosource
- aConfiguration
value- Throws:
org.xml.sax.SAXException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serializeElement
protected void serializeElement(org.xml.sax.ContentHandler handler, org.xml.sax.helpers.NamespaceSupport namespaceSupport, org.apache.avalon.framework.configuration.Configuration element) throws org.xml.sax.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:
org.xml.sax.SAXException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serializeToFile
public void serializeToFile(java.lang.String filename, org.apache.avalon.framework.configuration.Configuration source) throws org.xml.sax.SAXException, java.io.IOException, org.apache.avalon.framework.configuration.ConfigurationException
Serialize the configuration object to a file using a filename.- Parameters:
filename
- aString
valuesource
- aConfiguration
value- Throws:
org.xml.sax.SAXException
- if an error occursjava.io.IOException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serializeToFile
public void serializeToFile(java.io.File file, org.apache.avalon.framework.configuration.Configuration source) throws org.xml.sax.SAXException, java.io.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:
org.xml.sax.SAXException
- if an error occursjava.io.IOException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serialize
public void serialize(java.io.OutputStream outputStream, org.apache.avalon.framework.configuration.Configuration source) throws org.xml.sax.SAXException, java.io.IOException, org.apache.avalon.framework.configuration.ConfigurationException
Serialize the configuration object to an output stream.- Parameters:
outputStream
- anOutputStream
valuesource
- aConfiguration
value- Throws:
org.xml.sax.SAXException
- if an error occursjava.io.IOException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serialize
public void serialize(java.lang.String uri, org.apache.avalon.framework.configuration.Configuration source) throws org.xml.sax.SAXException, java.io.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:
org.xml.sax.SAXException
- if an error occursjava.io.IOException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
serialize
public java.lang.String serialize(org.apache.avalon.framework.configuration.Configuration source) throws org.xml.sax.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:
org.xml.sax.SAXException
- if an error occursorg.apache.avalon.framework.configuration.ConfigurationException
- if an error occurs
-
-