org.apache.xml.serializer

Interface SerializationHandler

public interface SerializationHandler extends ExtendedContentHandler, ExtendedLexicalHandler, XSLOutputAttributes, DeclHandler, DTDHandler, ErrorHandler, DOMSerializer, Serializer

This interface is the one that a serializer implements. It is a group of other interfaces, such as ExtendedContentHandler, ExtendedLexicalHandler etc. In addition there are other methods, such as reset(). This class is public only because it is used in another package, it is not a public API.

UNKNOWN: internal

Method Summary
void	close()
void	flushPending() Flush any pending events currently queued up in the serializer.
Transformer	getTransformer() Get the transformer associated with the serializer.
void	serialize(Node node) Notify that the serializer should take this DOM node as input to be serialized.
void	setContentHandler(ContentHandler ch) Set the SAX Content handler that the serializer sends its output to.
void	setDTDEntityExpansion(boolean expand) Default behavior is to expand DTD entities, that is the initall default value is true.
boolean	setEscaping(boolean escape) Turns special character escaping on/off.
void	setIndentAmount(int spaces) Set the number of spaces to indent for each indentation level.
void	setNamespaceMappings(NamespaceMappings mappings) Used only by TransformerSnapshotImpl to restore the serialization to a previous state.
void	setTransformer(Transformer transformer) Set the transformer associated with the serializer.

Method Detail

close

public void close()

flushPending

public void flushPending()

Flush any pending events currently queued up in the serializer. This will flush any input that the serializer has which it has not yet sent as output.

getTransformer

public Transformer getTransformer()

Get the transformer associated with the serializer.

Returns: Transformer the transformer associated with the serializer.

serialize

public void serialize(Node node)

Notify that the serializer should take this DOM node as input to be serialized.

Parameters: node the DOM node to be serialized.

Throws: IOException

setContentHandler

public void setContentHandler(ContentHandler ch)

Set the SAX Content handler that the serializer sends its output to. This method only applies to a ToSAXHandler, not to a ToStream serializer.

setDTDEntityExpansion

public void setDTDEntityExpansion(boolean expand)

Default behavior is to expand DTD entities, that is the initall default value is true.

Parameters: expand true if DTD entities are to be expanded, false if they are to be left as DTD entity references.

setEscaping

public boolean setEscaping(boolean escape)

Turns special character escaping on/off. Note that characters will never, even if this option is set to 'true', be escaped within CDATA sections in output XML documents.

Parameters: escape true if escaping is to be set on.

setIndentAmount

public void setIndentAmount(int spaces)

Set the number of spaces to indent for each indentation level.

Parameters: spaces the number of spaces to indent for each indentation level.

setNamespaceMappings

public void setNamespaceMappings(NamespaceMappings mappings)

Used only by TransformerSnapshotImpl to restore the serialization to a previous state.

Parameters: mappings NamespaceMappings

setTransformer

public void setTransformer(Transformer transformer)

Set the transformer associated with the serializer.

Parameters: transformer the transformer associated with the serializer.