public class

TextSerializer

extends BaseMarkupSerializer
java.lang.Object
   ↳ org.apache.xml.serialize.BaseMarkupSerializer
     ↳ org.apache.xml.serialize.TextSerializer

This class is 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.

Class Overview

Implements a text serializer supporting both DOM and SAX serializing. For usage instructions see Serializer.

If an output stream is used, the encoding is taken from the output format (defaults to UTF-8). If a writer is used, make sure the writer uses the same encoding (if applies) as specified in the output format.

The serializer supports both DOM and SAX. DOM serializing is done by calling serialize(Document) and SAX serializing is done by firing SAX events and using the serializer as a document handler.

If an I/O exception occurs while serializing, the serializer will not throw an exception directly, but only throw it at the end of serializing (either DOM or SAX's endDocument().

See Also

Summary

[Expand]
Inherited Fields
From class org.apache.xml.serialize.BaseMarkupSerializer
Public Constructors
TextSerializer()
Constructs a new serializer.
Public Methods
void characters(char[] chars, int start, int length)
void comment(String text)
void comment(char[] chars, int start, int length)
void endElement(String tagName)
void endElement(String namespaceURI, String localName, String rawName)
void endElementIO(String tagName)
void processingInstructionIO(String target, String code)
void setOutputFormat(OutputFormat format)
Specifies an output format for this serializer.
void startElement(String tagName, AttributeList attrs)
void startElement(String namespaceURI, String localName, String rawName, Attributes attrs)
Protected Methods
void characters(String text, boolean unescaped)
ElementState content()
Must be called by a method about to print any type of content.
String getEntityRef(int ch)
Returns the suitable entity reference for this character value, or null if no such entity exists.
void serializeElement(Element elem)
Called to serialize a DOM element.
void serializeNode(Node node)
Serialize the DOM node.
void startDocument(String rootTagName)
Called to serialize the document's DOCTYPE by the root element.
[Expand]
Inherited Methods
From class org.apache.xml.serialize.BaseMarkupSerializer
From class java.lang.Object
From interface org.apache.xml.serialize.DOMSerializer
From interface org.apache.xml.serialize.Serializer
From interface org.xml.sax.ContentHandler
From interface org.xml.sax.DTDHandler
From interface org.xml.sax.DocumentHandler
From interface org.xml.sax.ext.DeclHandler
From interface org.xml.sax.ext.LexicalHandler

Public Constructors

public TextSerializer ()

Constructs a new serializer. The serializer cannot be used without calling setOutputCharStream(Writer) or setOutputByteStream(OutputStream) first.

Public Methods

public void characters (char[] chars, int start, int length)

Throws
SAXException

public void comment (String text)

public void comment (char[] chars, int start, int length)

public void endElement (String tagName)

Throws
SAXException

public void endElement (String namespaceURI, String localName, String rawName)

Throws
SAXException

public void endElementIO (String tagName)

Throws
IOException

public void processingInstructionIO (String target, String code)

Throws
IOException

public 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

public void startElement (String tagName, AttributeList attrs)

Throws
SAXException

public void startElement (String namespaceURI, String localName, String rawName, Attributes attrs)

Throws
SAXException

Protected Methods

protected void characters (String text, boolean unescaped)

Throws
IOException

protected ElementState content ()

Must be called by a method about to print any type of content. If the element was just opened, the opening tag is closed and will be matched to a closing tag. Returns the current element state with empty and afterElement set to false.

Returns
  • The current element state

protected String getEntityRef (int ch)

Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&".

Parameters
ch Character value
Returns
  • Character entity name, or null

protected void serializeElement (Element elem)

Called to serialize a DOM element. Equivalent to calling startElement(String, String, String, Attributes), endElement(String) and serializing everything inbetween, but better optimized.

Parameters
elem The element to serialize
Throws
IOException

protected void serializeNode (Node node)

Serialize the DOM node. This method is unique to the Text serializer.

Parameters
node The node to serialize
Throws
IOException

protected void startDocument (String rootTagName)

Called to serialize the document's DOCTYPE by the root element.

This method will check if it has not been called before (_started), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see serializePreRoot()). Pre-root will be serialized even if this is not the first root element of the document.

Throws
IOException