org.docx4j.org.apache.xalan.serialize

Interface Serializer

Deprecated.

Use org.docx4j.org.apache.xml.serializer.Serializer

public interface Serializer

The Serializer interface is implemented by Serializers to publish methods to get and set streams and writers, to set the output properties, and get the Serializer as a ContentHandler or DOMSerializer.

Method Summary

Modifier and Type	Method and Description
ContentHandler	asContentHandler() Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer
DOMSerializer	asDOMSerializer() Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer
Properties	getOutputFormat() Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer
OutputStream	getOutputStream() Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer
Writer	getWriter() Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer
boolean	reset() Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer
void	setOutputFormat(Properties format) Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer
void	setOutputStream(OutputStream output) Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer
void	setWriter(Writer writer) Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer

Method Detail

setOutputStream

void setOutputStream(OutputStream output)

Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer

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.

The encoding specified in the output Properties is used, or if no encoding was specified, the default for the selected output method.

Parameters:

output - The output stream

getOutputStream

OutputStream getOutputStream()

Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer

Get the output stream where the events will be serialized to.

Returns:

reference to the result stream, or null of only a writer was set.

setWriter

void setWriter(Writer writer)

Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer

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.

The encoding specified for the output Properties must be identical to the output format used with the writer.

Parameters:

writer - The output writer stream

getWriter

Writer getWriter()

Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer

Get the character stream where the events will be serialized to.

Returns:

Reference to the result Writer, or null.

setOutputFormat

void setOutputFormat(Properties format)

Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer

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

getOutputFormat

Properties getOutputFormat()

Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer

Returns the output format for this serializer.

Returns:

The output format in use

asContentHandler

ContentHandler asContentHandler()
                         throws IOException

Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer

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

Returns:

A ContentHandler interface into this serializer, or null if the serializer is not SAX 2 capable

Throws:

IOException - An I/O exception occured

asDOMSerializer

DOMSerializer asDOMSerializer()
                       throws IOException

Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer

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

Returns:

A DOMSerializer interface into this serializer, or null if the serializer is not DOM capable

Throws:

IOException - An I/O exception occured

reset

boolean reset()

Deprecated. Use org.docx4j.org.apache.xml.serializer.Serializer

Resets the serializer. If this method returns true, the serializer may be used for subsequent serialization of new documents. It is possible to change the output format and output stream prior to serializing, or to use the existing output format and output stream.

Returns:

True if serializer has been reset and can be reused