public class

XMLSerializer

extends BaseMarkupSerializer
java.lang.Object
   ↳ org.apache.xml.serialize.BaseMarkupSerializer
     ↳ org.apache.xml.serialize.XMLSerializer
Known Direct Subclasses

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. See the Xerces documentation for more information.

Class Overview

Implements an XML serializer supporting both DOM and SAX pretty 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. SAX serializing is done by firing SAX events and using the serializer as a document handler. DOM serializing is done by calling serialize(Document) or by using DOM Level 3 org.w3c.dom.ls.LSSerializer and serializing with write(Node, LSOutput), writeToString(Node).

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().

For elements that are not specified as whitespace preserving, the serializer will potentially break long text lines at space boundaries, indent lines, and serialize elements on separate lines. Line terminators will be regarded as spaces, and spaces at beginning of line will be stripped.

See Also

Summary

Constants
boolean DEBUG
String PREFIX
Fields
protected NamespaceSupport fLocalNSBinder stores all namespace bindings on the current element
protected NamespaceSupport fNSBinder stores namespaces in scope
protected boolean fNamespacePrefixes Controls whether namespace prefixes will be printed out during serialization
protected boolean fNamespaces Controls whether namespace fixup should be performed during the serialization.
protected SymbolTable fSymbolTable symbol table for serialization
[Expand]
Inherited Fields
From class org.apache.xml.serialize.BaseMarkupSerializer
Public Constructors
XMLSerializer()
Constructs a new serializer.
XMLSerializer(OutputFormat format)
Constructs a new serializer.
XMLSerializer(Writer writer, OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format.
XMLSerializer(OutputStream output, OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format.
Public Methods
void endElement(String tagName)
void endElement(String namespaceURI, String localName, String rawName)
void endElementIO(String namespaceURI, String localName, String rawName)
boolean reset()
void setNamespaces(boolean namespaces)
This methods turns on namespace fixup algorithm during DOM serialization.
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 checkUnboundNamespacePrefixedNode(Node node)
DOM Level 3: Check a node to determine if it contains unbound namespace prefixes.
String getEntityRef(int ch)
Returns the suitable entity reference for this character value, or null if no such entity exists.
void printEscaped(String source)
Escapes a string so it may be printed as text content or attribute value.
void printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped)
Called to print additional text with whitespace handling.
void printText(String text, boolean preserveSpace, boolean unescaped)
void printXMLChar(int ch)
print text data
void serializeElement(Element elem)
Called to serialize a DOM element.
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

Constants

protected static final boolean DEBUG

Constant Value: false

protected static final String PREFIX

Constant Value: "NS"

Fields

protected NamespaceSupport fLocalNSBinder

stores all namespace bindings on the current element

protected NamespaceSupport fNSBinder

stores namespaces in scope

protected boolean fNamespacePrefixes

Controls whether namespace prefixes will be printed out during serialization

protected boolean fNamespaces

Controls whether namespace fixup should be performed during the serialization. NOTE: if this field is set to true the following fields need to be initialized: fNSBinder, fLocalNSBinder, fSymbolTable, XMLSymbols.EMPTY_STRING, fXmlSymbol, fXmlnsSymbol

protected SymbolTable fSymbolTable

symbol table for serialization

Public Constructors

public XMLSerializer ()

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

public XMLSerializer (OutputFormat format)

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

public XMLSerializer (Writer writer, OutputFormat format)

Constructs a new serializer that writes to the specified writer using the specified output format. If format is null, will use a default output format.

Parameters
writer The writer to use
format The output format to use, null for the default

public XMLSerializer (OutputStream output, OutputFormat format)

Constructs a new serializer that writes to the specified output stream using the specified output format. If format is null, will use a default output format.

Parameters
output The output stream to use
format The output format to use, null for the default

Public Methods

public void endElement (String tagName)

Throws
SAXException

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

Throws
SAXException

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

Throws
IOException

public boolean reset ()

public void setNamespaces (boolean namespaces)

This methods turns on namespace fixup algorithm during DOM serialization.

See Also
  • org.w3c.dom.ls.LSSerializer

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 checkUnboundNamespacePrefixedNode (Node node)

DOM Level 3: Check a node to determine if it contains unbound namespace prefixes.

Parameters
node The node to check for unbound namespace prefices
Throws
IOException

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 printEscaped (String source)

Escapes a string so it may be printed as text content or attribute value. Non printable characters are escaped using character references. Where the format specifies a deault entity reference, that reference is used (e.g. <).

Parameters
source The string to escape
Throws
IOException

protected void printText (char[] chars, int start, int length, boolean preserveSpace, boolean unescaped)

Called to print additional text with whitespace handling. If spaces are preserved, the text is printed as if by calling printText(String, boolean, boolean) with a call to breakLine() for each new line. If spaces are not preserved, the text is broken at space boundaries if longer than the line width; Multiple spaces are printed as such, but spaces at beginning of line are removed.

Parameters
chars The text to print
start The start offset
length The number of characters
preserveSpace Space preserving flag
unescaped Print unescaped
Throws
IOException

protected void printText (String text, boolean preserveSpace, boolean unescaped)

Throws
IOException

protected void printXMLChar (int ch)

print text data

Throws
IOException

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 startDocument (String rootTagName)

Called to serialize the document's DOCTYPE by the root element. The document type declaration must name the root element, but the root element is only known when that element is serialized, and not at the start of the document.

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