org.apache.xml.serialize

Class XML11Serializer

Implemented Interfaces:
ContentHandler, DeclHandler, DocumentHandler, DTDHandler, LexicalHandler, DOMSerializer, Serializer

public class XML11Serializer
extends XMLSerializer

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.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.14 $ $Date: 2005/05/03 11:12:21 $
Authors:
Assaf Arkin
Rahul Srivastava
Elena Litani IBM
See Also:
Serializer

Field Summary

protected static boolean
DEBUG
protected static String
PREFIX
protected boolean
fDOML1
protected org.apache.xerces.util.NamespaceSupport
fLocalNSBinder
stores all namespace bindings on the current element
protected org.apache.xerces.util.NamespaceSupport
fNSBinder
stores namespaces in scope
protected int
fNamespaceCounter
protected boolean
fNamespaces
Controls whether namespace fixup should be performed during the serialization.
protected org.apache.xerces.util.SymbolTable
fSymbolTable
symbol table for serialization

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

DEBUG, PREFIX, fLocalNSBinder, fNSBinder, fNamespacePrefixes, fNamespaces, fSymbolTable

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

_docTypePublicId, _docTypeSystemId, _encodingInfo, _format, _indenting, _prefixes, _printer, _started, fCurrentNode, fDOMError, fDOMErrorHandler, fDOMFilter, fStrBuffer, features

Constructor Summary

XML11Serializer()
Constructs a new serializer.
XML11Serializer(OutputStream output, OutputFormat format)
Constructs a new serializer that writes to the specified output stream using the specified output format.
XML11Serializer(Writer writer, OutputFormat format)
Constructs a new serializer that writes to the specified writer using the specified output format.
XML11Serializer(OutputFormat format)
Constructs a new serializer.

Method Summary

void
characters(char[] chars, int start, int length)
protected void
printCDATAText(String text)
protected void
printEscaped(String source)
protected void
printText(String text, boolean preserveSpace, boolean unescaped)
protected void
printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped)
protected void
printXMLChar(int ch)
print text data
boolean
reset()
protected void
surrogates(int high, int low)

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

checkUnboundNamespacePrefixedNode, endElement, endElement, endElementIO, getEntityRef, printEscaped, printText, printText, printXMLChar, reset, serializeElement, setNamespaces, setOutputFormat, startDocument, startElement, startElement

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

asContentHandler, asDOMSerializer, asDocumentHandler, attributeDecl, characters, characters, checkUnboundNamespacePrefixedNode, comment, comment, content, elementDecl, endCDATA, endDTD, endDocument, endEntity, endNonEscaping, endPrefixMapping, endPreserving, enterElementState, externalEntityDecl, fatalError, getElementState, getEntityRef, getPrefix, ignorableWhitespace, internalEntityDecl, isDocumentState, leaveElementState, modifyDOMError, notationDecl, prepare, printCDATAText, printDoctypeURL, printEscaped, printEscaped, printText, printText, processingInstruction, processingInstructionIO, reset, serialize, serialize, serialize, serializeElement, serializeNode, serializePreRoot, setDocumentLocator, setOutputByteStream, setOutputCharStream, setOutputFormat, skippedEntity, startCDATA, startDTD, startDocument, startEntity, startNonEscaping, startPrefixMapping, startPreserving, surrogates, unparsedEntityDecl

Field Details

DEBUG

protected static final boolean DEBUG
Field Value:
false

PREFIX

protected static final String PREFIX

fDOML1

protected boolean fDOML1

fLocalNSBinder

protected org.apache.xerces.util.NamespaceSupport fLocalNSBinder
stores all namespace bindings on the current element

fNSBinder

protected org.apache.xerces.util.NamespaceSupport fNSBinder
stores namespaces in scope

fNamespaceCounter

protected int fNamespaceCounter

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, fNamespaceCounter.

fSymbolTable

protected org.apache.xerces.util.SymbolTable fSymbolTable
symbol table for serialization

Constructor Details

XML11Serializer

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

XML11Serializer

public XML11Serializer(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

XML11Serializer

public XML11Serializer(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

XML11Serializer

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

Method Details

characters

public void characters(char[] chars,
                       int start,
                       int length)
            throws SAXException
Overrides:
characters in interface BaseMarkupSerializer

printCDATAText

protected final void printCDATAText(String text)
            throws IOException
Overrides:
printCDATAText in interface BaseMarkupSerializer

printEscaped

protected void printEscaped(String source)
            throws IOException
Overrides:
printEscaped in interface XMLSerializer

printText

protected void printText(String text,
                         boolean preserveSpace,
                         boolean unescaped)
            throws IOException
Overrides:
printText in interface XMLSerializer

printText

protected void printText(char[] chars,
                         int start,
                         int length,
                         boolean preserveSpace,
                         boolean unescaped)
            throws IOException
Overrides:
printText in interface XMLSerializer

printXMLChar

protected final void printXMLChar(int ch)
            throws IOException
print text data
Overrides:
printXMLChar in interface XMLSerializer

reset

public boolean reset()
Overrides:
reset in interface XMLSerializer

surrogates

protected final void surrogates(int high,
                                int low)
            throws IOException
Overrides:
surrogates in interface BaseMarkupSerializer

Copyright B) 1999-2005 Apache XML Project. All Rights Reserved.