org.apache.jackrabbit.vault.util.xml.serialize

Interface Serializer

All Known Implementing Classes:

BaseMarkupSerializer, XMLSerializer

public interface Serializer

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 DocumentHandler. If an I/O error occurs while serializing, it will be thrown by DocumentHandler.endDocument(). The SAX serializer may also be used as DTDHandler, DeclHandler and 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(boolean) 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.

See Also:

DocumentHandler, ContentHandler, OutputFormat, DOMSerializer

Method Summary

Methods

Modifier and Type	Method and Description
ContentHandler	asContentHandler() Return a ContentHandler interface into this serializer.
DocumentHandler	asDocumentHandler() Return a DocumentHandler interface into this serializer.
DOMSerializer	asDOMSerializer() Return a DOMSerializer interface into this serializer.
void	setOutputByteStream(OutputStream output) Specifies an output stream to which the document should be serialized.
void	setOutputCharStream(Writer output) Specifies a writer to which the document should be serialized.
void	setOutputFormat(OutputFormat format) Specifies an output format for this serializer.

Method Detail

setOutputByteStream

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.

setOutputCharStream

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.

setOutputFormat

void setOutputFormat(OutputFormat format)

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 - The output format to use

asDocumentHandler

DocumentHandler asDocumentHandler()
                                  throws IOException

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

Throws:

IOException

asContentHandler

ContentHandler asContentHandler()
                                throws IOException

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

Throws:

IOException

asDOMSerializer

DOMSerializer asDOMSerializer()
                              throws IOException

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

Throws:

IOException