org.apache.xml.serialize: public interface: Serializer

org.apache.xml.serialize
public interface: Serializer [javadoc | source]

All Known Implementing Classes:
XMLSerializer, XHTMLSerializer, BaseMarkupSerializer, XML11Serializer, HTMLSerializer, TextSerializer

Deprecated! This - class was deprecated in Xerces 2.9.0. It is recommended that new applications use the DOM Level 3 LSSerializer or JAXP's Transformation API for XML (TrAX) for serializing XML and HTML. See the Xerces documentation for more information.

Interface for a DOM serializer implementation, factory for DOM and SAX serializers, and static methods for serializing DOM documents.

To serialize a document using SAX events, create a compatible serializer and pass it around as a org.xml.sax.DocumentHandler . If an I/O error occurs while serializing, it will be thrown by DocumentHandler#endDocument . The SAX serializer may also be used as org.xml.sax.DTDHandler , org.xml.sax.ext.DeclHandler and org.xml.sax.ext.LexicalHandler .

To serialize a DOM document or DOM element, create a compatible serializer and call it's DOMSerializer#serialize(Document) or DOMSerializer#serialize(Element) methods. Both methods would produce a full XML document, to serizlie only the portion of the document use OutputFormat#setOmitXMLDeclaration and specify no document type.

The OutputFormat dictates what underlying serialized is used to serialize the document based on the specified method. If the output format or method are missing, the default is an XML serializer with UTF-8 encoding and now indentation.

Also see:

version: $ - Revision: 476047 $ $Date: 2006-11-16 23:27:45 -0500 (Thu, 16 Nov 2006) $

author: < - a href="mailto:arkin@intalio.com">Assaf Arkin

author: < - a href="mailto:Scott_Boag/CAM/Lotus@lotus.com">Scott Boag

Method from org.apache.xml.serialize.Serializer Summary:
asContentHandler, asDOMSerializer, asDocumentHandler, setOutputByteStream, setOutputCharStream, setOutputFormat

Method from org.apache.xml.serialize.Serializer Detail:
public ContentHandler asContentHandler() throws IOException Deprecated! Return a ContentHandler interface into this serializer. If the serializer does not support the ContentHandler interface, it should return null.
public DOMSerializer asDOMSerializer() throws IOException Deprecated! Return a DOMSerializer interface into this serializer. If the serializer does not support the DOMSerializer interface, it should return null.
public DocumentHandler asDocumentHandler() throws IOException Deprecated! Return a DocumentHandler interface into this serializer. If the serializer does not support the DocumentHandler interface, it should return null.
public void setOutputByteStream(OutputStream output) Deprecated! Specifies an output stream to which the document should be serialized. This method should not be called while the serializer is in the process of serializing a document.
public void setOutputCharStream(Writer output) Deprecated! Specifies a writer to which the document should be serialized. This method should not be called while the serializer is in the process of serializing a document.
public void setOutputFormat(OutputFormat format) Deprecated! Specifies an output format for this serializer. It the serializer has already been associated with an output format, it will switch to the new format. This method should not be called while the serializer is in the process of serializing a document.