Top Description Methods
org.apache.xml.serialize

public Interface Serializer

Known Direct Implementers
org.apache.xml.serialize.BaseMarkupSerializer
Imports
java.io.IOException, .OutputStream, .Writer, org.w3c.dom.Document, .Element, org.xml.sax.ContentHandler, .DocumentHandler

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.

Authors
Assaf Arkin, Scott Boag
Version
$Revision: 699892 $ $Date: 2008-09-29 02:38:27 +0530 (Mon, 29 Sep 2008) $
See Also
DocumentHandler, ContentHandler, OutputFormat, DOMSerializer

Method Summary

Modifier and TypeMethod and Description
public ContentHandler
asContentHandler()

Return a ContentHandler interface into this serializer.

public DocumentHandler
asDocumentHandler()

Deprecated as a consequence of DocumentHandler being deprecated.
Return a DocumentHandler interface into this serializer.
public DOMSerializer
asDOMSerializer()

Deprecated as a consequence of DOMSerializer being deprecated.
Return a DOMSerializer interface into this serializer.
public void
setOutputByteStream(OutputStream output)

Specifies an output stream to which the document should be serialized.

public void
setOutputCharStream(Writer output)

Specifies a writer to which the document should be serialized.

public void
setOutputFormat(OutputFormat
The output format to use
format
)

Deprecated as a consequence of OutputFormat being deprecated.
Specifies an output format for this serializer.

Method Detail

asContentHandlerback to summary
public ContentHandler asContentHandler() throws IOException

Return a ContentHandler interface into this serializer. If the serializer does not support the ContentHandler interface, it should return null.

asDocumentHandlerback to summary
public DocumentHandler asDocumentHandler() throws IOException

Deprecated

as a consequence of DocumentHandler being deprecated. See corresponding docs for further information.

Return a DocumentHandler interface into this serializer. If the serializer does not support the DocumentHandler interface, it should return null.

asDOMSerializerback to summary
public DOMSerializer asDOMSerializer() throws IOException

Deprecated

as a consequence of DOMSerializer being deprecated. See corresponding docs for further information.

Return a DOMSerializer interface into this serializer. If the serializer does not support the DOMSerializer interface, it should return null.

setOutputByteStreamback to summary
public void setOutputByteStream(OutputStream output)

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.

setOutputCharStreamback to summary
public void setOutputCharStream(Writer output)

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.

setOutputFormatback to summary
public void setOutputFormat(OutputFormat format)

Deprecated

as a consequence of OutputFormat being deprecated. See corresponding docs for further information.

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.

Parameters
format:OutputFormat

The output format to use