java.lang.Object
- org.apache.xml.serialize.BaseMarkupSerializer
- - org.apache.xml.serialize.TextSerializer

All Implemented Interfaces:

DOMSerializer, Serializer, org.xml.sax.ContentHandler, org.xml.sax.DocumentHandler, org.xml.sax.DTDHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler
```
public class TextSerializer
extends BaseMarkupSerializer
```
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.

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 BaseMarkupSerializer.serialize(org.w3c.dom.Element) 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 DocumentHandler.endDocument().

Version:

$Revision: 476047 $ $Date: 2006-11-17 09:57:45 +0530 (Fri, 17 Nov 2006) $

Author:

Assaf Arkin

See Also:

Serializer

Field Summary
- Fields inherited from class org.apache.xml.serialize.BaseMarkupSerializer
  _docTypePublicId, _docTypeSystemId, _encodingInfo, _format, _indenting, _prefixes, _printer, _started, fCurrentNode, fDOMError, fDOMErrorHandler, fDOMFilter, features, fStrBuffer

Constructor Summary

Constructors
Constructor Description

TextSerializer()
Deprecated.

Constructs a new serializer.

Method Summary

All Methods Instance Methods Concrete Methods Deprecated Methods
Modifier and Type	Method	Description
`void`	`characters(char[] chars, int start, int length)`	Deprecated.
`protected void`	`characters(java.lang.String text, boolean unescaped)`	Deprecated.
`void`	`comment(char[] chars, int start, int length)`	Deprecated.
`void`	`comment(java.lang.String text)`	Deprecated.
`protected ElementState`	`content()`	Deprecated. Must be called by a method about to print any type of content.
`void`	`endElement(java.lang.String tagName)`	Deprecated.
`void`	`endElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName)`	Deprecated.
`void`	`endElementIO(java.lang.String tagName)`	Deprecated.
`protected java.lang.String`	`getEntityRef(int ch)`	Deprecated. Returns the suitable entity reference for this character value, or null if no such entity exists.
`void`	`processingInstructionIO(java.lang.String target, java.lang.String code)`	Deprecated.
`protected void`	`serializeElement(org.w3c.dom.Element elem)`	Deprecated. Called to serialize a DOM element.
`protected void`	`serializeNode(org.w3c.dom.Node node)`	Deprecated. Serialize the DOM node.
`void`	`setOutputFormat(OutputFormat format)`	Deprecated. Specifies an output format for this serializer.
`protected void`	`startDocument(java.lang.String rootTagName)`	Deprecated. Called to serialize the document's DOCTYPE by the root element.
`void`	`startElement(java.lang.String namespaceURI, java.lang.String localName, java.lang.String rawName, org.xml.sax.Attributes attrs)`	Deprecated.
`void`	`startElement(java.lang.String tagName, org.xml.sax.AttributeList attrs)`	Deprecated.

Methods inherited from class org.apache.xml.serialize.BaseMarkupSerializer
asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, characters, checkUnboundNamespacePrefixedNode, cleanup, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, enterElementState, externalEntityDecl, fatalError, getElementState, getPrefix, ignorableWhitespace, internalEntityDecl, isDocumentState, leaveElementState, modifyDOMError, notationDecl, prepare, printCDATAText, printDoctypeURL, printEscaped, printEscaped, printText, printText, processingInstruction, reset, serialize, serialize, serialize, serializePreRoot, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, surrogates, unparsedEntityDecl

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

- Constructor Detail
  - TextSerializer
```
public TextSerializer()
```
    Deprecated.
    
    Constructs a new serializer. The serializer cannot be used without calling BaseMarkupSerializer.setOutputCharStream(java.io.Writer) or BaseMarkupSerializer.setOutputByteStream(java.io.OutputStream) first.
- Method Detail
  - setOutputFormat
```
public void setOutputFormat(OutputFormat format)
```
    Deprecated.
    
    Description copied from interface: 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.
    
    Specified by:
    
    setOutputFormat in interface Serializer
    
    Overrides:
    
    setOutputFormat in class BaseMarkupSerializer
    
    Parameters:
    
    format - The output format to use
  - startElement
```
public void startElement(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName,
                         org.xml.sax.Attributes attrs)
                  throws org.xml.sax.SAXException
```
    Deprecated.
    
    Throws:
    
    org.xml.sax.SAXException
  - endElement
```
public void endElement(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String rawName)
                throws org.xml.sax.SAXException
```
    Deprecated.
    
    Throws:
    
    org.xml.sax.SAXException
  - startElement
```
public void startElement(java.lang.String tagName,
                         org.xml.sax.AttributeList attrs)
                  throws org.xml.sax.SAXException
```
    Deprecated.
    
    Throws:
    
    org.xml.sax.SAXException
  - endElement
```
public void endElement(java.lang.String tagName)
                throws org.xml.sax.SAXException
```
    Deprecated.
    
    Throws:
    
    org.xml.sax.SAXException
  - endElementIO
```
public void endElementIO(java.lang.String tagName)
                  throws java.io.IOException
```
    Deprecated.
    
    Throws:
    
    java.io.IOException
  - processingInstructionIO
```
public void processingInstructionIO(java.lang.String target,
                                    java.lang.String code)
                             throws java.io.IOException
```
    Deprecated.
    
    Overrides:
    
    processingInstructionIO in class BaseMarkupSerializer
    
    Throws:
    
    java.io.IOException
  - comment
```
public void comment(java.lang.String text)
```
    Deprecated.
    
    Overrides:
    
    comment in class BaseMarkupSerializer
  - comment
```
public void comment(char[] chars,
                    int start,
                    int length)
```
    Deprecated.
    
    Specified by:
    
    comment in interface org.xml.sax.ext.LexicalHandler
    
    Overrides:
    
    comment in class BaseMarkupSerializer
  - characters
```
public void characters(char[] chars,
                       int start,
                       int length)
                throws org.xml.sax.SAXException
```
    Deprecated.
    
    Specified by:
    
    characters in interface org.xml.sax.ContentHandler
    
    Specified by:
    
    characters in interface org.xml.sax.DocumentHandler
    
    Overrides:
    
    characters in class BaseMarkupSerializer
    
    Throws:
    
    org.xml.sax.SAXException
  - characters
```
protected void characters(java.lang.String text,
                          boolean unescaped)
                   throws java.io.IOException
```
    Deprecated.
    
    Throws:
    
    java.io.IOException
  - startDocument
```
protected void startDocument(java.lang.String rootTagName)
                      throws java.io.IOException
```
    Deprecated.
    
    Called to serialize the document's DOCTYPE by the root element.
    This method will check if it has not been called before (BaseMarkupSerializer._started), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see BaseMarkupSerializer.serializePreRoot()). Pre-root will be serialized even if this is not the first root element of the document.
    
    Throws:
    
    java.io.IOException
  - serializeElement
```
protected void serializeElement(org.w3c.dom.Element elem)
                         throws java.io.IOException
```
    Deprecated.
    
    Called to serialize a DOM element. Equivalent to calling startElement(java.lang.String, java.lang.String, java.lang.String, org.xml.sax.Attributes), endElement(java.lang.String, java.lang.String, java.lang.String) and serializing everything inbetween, but better optimized.
    
    Specified by:
    
    serializeElement in class BaseMarkupSerializer
    
    Parameters:
    
    elem - The element to serialize
    
    Throws:
    
    java.io.IOException - An I/O exception occured while serializing
  - serializeNode
```
protected void serializeNode(org.w3c.dom.Node node)
                      throws java.io.IOException
```
    Deprecated.
    
    Serialize the DOM node. This method is unique to the Text serializer.
    
    Overrides:
    
    serializeNode in class BaseMarkupSerializer
    
    Parameters:
    
    node - The node to serialize
    
    Throws:
    
    java.io.IOException - An I/O exception occured while serializing
    
    See Also:
    
    BaseMarkupSerializer.serializeElement(org.w3c.dom.Element)
  - content
```
protected ElementState content()
```
    Deprecated.
    
    Description copied from class: BaseMarkupSerializer
    
    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.
    
    Overrides:
    
    content in class BaseMarkupSerializer
    
    Returns:
    
    The current element state
  - getEntityRef
```
protected java.lang.String getEntityRef(int ch)
```
    Deprecated.
    
    Description copied from class: BaseMarkupSerializer
    
    Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&".
    
    Specified by:
    
    getEntityRef in class BaseMarkupSerializer
    
    Parameters:
    
    ch - Character value
    
    Returns:
    
    Character entity name, or null

Class TextSerializer

Field Summary

Fields inherited from class org.apache.xml.serialize.BaseMarkupSerializer

Constructor Summary

Method Summary

Methods inherited from class org.apache.xml.serialize.BaseMarkupSerializer

Methods inherited from class java.lang.Object

Constructor Detail

TextSerializer

Method Detail

setOutputFormat

startElement

endElement

startElement

endElement

endElementIO

processingInstructionIO

comment

comment

characters

characters

startDocument

serializeElement

serializeNode

content

getEntityRef