org.apache.xml.serialize

Class XML11Serializer

java.lang.Object

org.apache.xml.serialize.BaseMarkupSerializer

org.apache.xml.serialize.XMLSerializer

org.apache.xml.serialize.XML11Serializer

All Implemented Interfaces:

DOMSerializer, Serializer, ContentHandler, DocumentHandler, DTDHandler, DeclHandler, LexicalHandler

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.

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 BaseMarkupSerializer.serialize(Document) or by using DOM Level 3 LSSerializer and serializing with LSSerializer.write(org.w3c.dom.Node, org.w3c.dom.ls.LSOutput), LSSerializer.writeToString(org.w3c.dom.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 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$ $Date$

Author:

Assaf Arkin, Rahul Srivastava, Elena Litani IBM

See Also:

Serializer

Field Summary

Fields

Modifier and Type	Field and Description
protected static boolean	DEBUG Deprecated.
protected boolean	fDOML1 Deprecated.
protected NamespaceSupport	fLocalNSBinder Deprecated. stores all namespace bindings on the current element
protected int	fNamespaceCounter Deprecated.
protected boolean	fNamespaces Deprecated. Controls whether namespace fixup should be performed during the serialization.
protected NamespaceSupport	fNSBinder Deprecated. stores namespaces in scope
protected SymbolTable	fSymbolTable Deprecated. symbol table for serialization
protected static String	PREFIX Deprecated.

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

fNamespacePrefixes

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 and Description
XML11Serializer() Deprecated. Constructs a new serializer.
XML11Serializer(OutputFormat format) Deprecated. Constructs a new serializer.
XML11Serializer(OutputStream output, OutputFormat format) Deprecated. Constructs a new serializer that writes to the specified output stream using the specified output format.
XML11Serializer(Writer writer, OutputFormat format) Deprecated. Constructs a new serializer that writes to the specified writer using the specified output format.

Method Summary

Methods

Modifier and Type	Method and Description
void	characters(char[] chars, int start, int length) Deprecated.
protected void	printCDATAText(String text) Deprecated.
protected void	printEscaped(String source) Deprecated. Escapes a string so it may be printed as text content or attribute value.
protected void	printText(char[] chars, int start, int length, boolean preserveSpace, boolean unescaped) Deprecated. Called to print additional text with whitespace handling.
protected void	printText(String text, boolean preserveSpace, boolean unescaped) Deprecated.
protected void	printXMLChar(int ch) Deprecated. print text data
boolean	reset() Deprecated.
protected void	surrogates(int high, int low, boolean inContent) Deprecated.

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

checkUnboundNamespacePrefixedNode, endElement, endElement, endElementIO, getEntityRef, serializeElement, setNamespaces, setOutputFormat, startDocument, startElement, startElement

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

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

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEBUG

protected static final boolean DEBUG

Deprecated.

See Also:

Constant Field Values

fNSBinder

protected NamespaceSupport fNSBinder

Deprecated.

stores namespaces in scope

fLocalNSBinder

protected NamespaceSupport fLocalNSBinder

Deprecated.

stores all namespace bindings on the current element

fSymbolTable

protected SymbolTable fSymbolTable

Deprecated.

symbol table for serialization

fDOML1

protected boolean fDOML1

Deprecated.

fNamespaceCounter

protected int fNamespaceCounter

Deprecated.

PREFIX

protected static final String PREFIX

Deprecated.

See Also:

Constant Field Values

fNamespaces

protected boolean fNamespaces

Deprecated.

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.

Constructor Detail

XML11Serializer

public XML11Serializer()

Deprecated.

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

XML11Serializer

public XML11Serializer(OutputFormat format)

Deprecated.

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

XML11Serializer

public XML11Serializer(Writer writer,
               OutputFormat format)

Deprecated.

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(OutputStream output,
               OutputFormat format)

Deprecated.

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

characters

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

Deprecated.

Specified by:

characters in interface ContentHandler

Specified by:

characters in interface DocumentHandler

Overrides:

characters in class BaseMarkupSerializer

Throws:

SAXException

printEscaped

protected void printEscaped(String source)
                     throws IOException

Deprecated.

Description copied from class: BaseMarkupSerializer

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

Overrides:

printEscaped in class XMLSerializer

Parameters:

source - The string to escape

Throws:

IOException

printCDATAText

protected final void printCDATAText(String text)
                             throws IOException

Deprecated.

Overrides:

printCDATAText in class BaseMarkupSerializer

Throws:

IOException

printXMLChar

protected final void printXMLChar(int ch)
                           throws IOException

Deprecated.

Description copied from class: XMLSerializer

print text data

Overrides:

printXMLChar in class XMLSerializer

Throws:

IOException

surrogates

protected final void surrogates(int high,
              int low,
              boolean inContent)
                         throws IOException

Deprecated.

Overrides:

surrogates in class BaseMarkupSerializer

Throws:

IOException

printText

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

Deprecated.

Overrides:

printText in class XMLSerializer

Throws:

IOException

printText

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

Deprecated.

Description copied from class: BaseMarkupSerializer

Called to print additional text with whitespace handling. If spaces are preserved, the text is printed as if by calling BaseMarkupSerializer.printText(String,boolean,boolean) with a call to Printer.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.

Overrides:

printText in class XMLSerializer

Parameters:

chars - The text to print

start - The start offset

length - The number of characters

preserveSpace - Space preserving flag

unescaped - Print unescaped

Throws:

IOException

reset

public boolean reset()

Deprecated.

Overrides:

reset in class XMLSerializer