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:
- CVS $Revision: 1.24 $ $Date: 2003/02/11 15:58:39 $
- Author:
- Avalon Development Team
-
-
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, Configuration source)
Serialize the configuration object to an output stream.void
serialize(java.lang.String uri, Configuration source)
Serialize the configuration object to an output stream derived from an URI.java.lang.String
serialize(Configuration source)
Serialize the configuration object to a stringvoid
serialize(org.xml.sax.ContentHandler handler, Configuration source)
Serialize the configuration to a ContentHandlerprotected void
serializeElement(org.xml.sax.ContentHandler handler, org.xml.sax.helpers.NamespaceSupport namespaceSupport, Configuration element)
Serialize each Configuration element.void
serializeToFile(java.io.File file, Configuration source)
Serialize the configuration object to a file using a File object.void
serializeToFile(java.lang.String filename, 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, Configuration source) throws org.xml.sax.SAXException, ConfigurationException
Serialize the configuration to a ContentHandler- Parameters:
handler
- aContentHandler
to serialize tosource
- aConfiguration
value- Throws:
org.xml.sax.SAXException
- if an error occursConfigurationException
- if an error occurs
-
serializeElement
protected void serializeElement(org.xml.sax.ContentHandler handler, org.xml.sax.helpers.NamespaceSupport namespaceSupport, Configuration element) throws org.xml.sax.SAXException, 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 occursConfigurationException
- if an error occurs
-
serializeToFile
public void serializeToFile(java.lang.String filename, Configuration source) throws org.xml.sax.SAXException, java.io.IOException, 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 occursConfigurationException
- if an error occurs
-
serializeToFile
public void serializeToFile(java.io.File file, Configuration source) throws org.xml.sax.SAXException, java.io.IOException, 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 occursConfigurationException
- if an error occurs
-
serialize
public void serialize(java.io.OutputStream outputStream, Configuration source) throws org.xml.sax.SAXException, java.io.IOException, 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 occursConfigurationException
- if an error occurs
-
serialize
public void serialize(java.lang.String uri, Configuration source) throws org.xml.sax.SAXException, java.io.IOException, 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 occursConfigurationException
- if an error occurs
-
serialize
public java.lang.String serialize(Configuration source) throws org.xml.sax.SAXException, 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 occursConfigurationException
- if an error occurs
-
-