org.apache.xml.serialize

Class XMLSerializer

public class XMLSerializer extends BaseMarkupSerializer

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 XMLSerializer or by using DOM Level 3 org.w3c.dom.ls.DOMSerializer and serializing with org.w3c.dom.ls.DOMSerializer#write, org.w3c.dom.ls.DOMSerializer#writeToString.

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 org.xml.sax.DocumentHandler#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.

Version: $Revision: 1.66 $ $Date: 2005/05/03 11:12:21 $

Author: Assaf Arkin Rahul Srivastava Elena Litani IBM

See Also: Serializer

Field Summary
protected static booleanDEBUG
protected NamespaceSupportfLocalNSBinder
stores all namespace bindings on the current element
protected booleanfNamespacePrefixes
Controls whether namespace prefixes will be printed out during serialization
protected booleanfNamespaces
Controls whether namespace fixup should be performed during the serialization.
protected NamespaceSupportfNSBinder
stores namespaces in scope
protected SymbolTablefSymbolTable
symbol table for serialization
protected static StringPREFIX
Constructor Summary
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.
Method Summary
protected voidcheckUnboundNamespacePrefixedNode(Node node)
DOM Level 3: Check a node to determine if it contains unbound namespace prefixes.
voidendElement(String namespaceURI, String localName, String rawName)
voidendElement(String tagName)
voidendElementIO(String namespaceURI, String localName, String rawName)
protected StringgetEntityRef(int ch)
protected voidprintEscaped(String source)
protected voidprintText(String text, boolean preserveSpace, boolean unescaped)
protected voidprintText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped)
protected voidprintXMLChar(int ch)
print text data
booleanreset()
protected voidserializeElement(Element elem)
Called to serialize a DOM element.
voidsetNamespaces(boolean namespaces)
This methods turns on namespace fixup algorithm during DOM serialization.
voidsetOutputFormat(OutputFormat format)
protected voidstartDocument(String rootTagName)
Called to serialize the document's DOCTYPE by the root element.
voidstartElement(String namespaceURI, String localName, String rawName, Attributes attrs)
voidstartElement(String tagName, AttributeList attrs)

Field Detail

DEBUG

protected static final boolean DEBUG

fLocalNSBinder

protected NamespaceSupport fLocalNSBinder
stores all namespace bindings on the current element

fNamespacePrefixes

protected boolean fNamespacePrefixes
Controls whether namespace prefixes will be printed out during serialization

fNamespaces

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

fNSBinder

protected NamespaceSupport fNSBinder
stores namespaces in scope

fSymbolTable

protected SymbolTable fSymbolTable
symbol table for serialization

PREFIX

protected static final String PREFIX

Constructor Detail

XMLSerializer

public XMLSerializer()
Constructs a new serializer. The serializer cannot be used without calling XMLSerializer or XMLSerializer first.

XMLSerializer

public XMLSerializer(OutputFormat format)
Constructs a new serializer. The serializer cannot be used without calling XMLSerializer or XMLSerializer first.

XMLSerializer

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

XMLSerializer

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

Method Detail

checkUnboundNamespacePrefixedNode

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

endElement

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

endElement

public void endElement(String tagName)

endElementIO

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

getEntityRef

protected String getEntityRef(int ch)

printEscaped

protected void printEscaped(String source)

printText

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

printText

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

printXMLChar

protected void printXMLChar(int ch)
print text data

reset

public boolean reset()

serializeElement

protected void serializeElement(Element elem)
Called to serialize a DOM element. Equivalent to calling XMLSerializer, XMLSerializer and serializing everything inbetween, but better optimized.

setNamespaces

public void setNamespaces(boolean namespaces)
This methods turns on namespace fixup algorithm during DOM serialization.

Parameters: namespaces

See Also: org.w3c.dom.ls.DOMSerializer

setOutputFormat

public void setOutputFormat(OutputFormat format)

startDocument

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 (XMLSerializer), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see XMLSerializer). Pre-root will be serialized even if this is not the first root element of the document.

startElement

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

startElement

public void startElement(String tagName, AttributeList attrs)
Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.