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: 476047 $ $Date: 2006-11-16 23:27:45 -0500 (Thu, 16 Nov 2006) $

Author:

Assaf Arkin, Rahul Srivastava, Elena Litani IBM

See Also:

Serializer

Constructor Summary

XML11Serializer()
Deprecated. Constructs a new serializer.

XML11Serializer(OutputFormat format)
Deprecated. Constructs a new serializer.

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

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

Method Summary

void	characters(char[] chars, int start, int length) Deprecated. Receive notification of character data.
boolean	reset() Deprecated.

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

endElement, endElement, endElementIO, setNamespaces, setOutputFormat, startElement, startElement

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

asContentHandler, asDocumentHandler, asDOMSerializer, attributeDecl, comment, comment, elementDecl, endCDATA, endDocument, endDTD, endEntity, endNonEscaping, endPrefixMapping, endPreserving, externalEntityDecl, ignorableWhitespace, internalEntityDecl, notationDecl, processingInstruction, processingInstructionIO, serialize, serialize, serialize, setDocumentLocator, setOutputByteStream, setOutputCharStream, skippedEntity, startCDATA, startDocument, startDTD, startEntity, startNonEscaping, startPrefixMapping, startPreserving, unparsedEntityDecl

Methods inherited from class java.lang.Object

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

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(java.io.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(java.io.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.

Description copied from interface: ContentHandler

Receive notification of character data.

The Parser will call this method to report each chunk of character data. SAX parsers may return all contiguous character data in a single chunk, or they may split it into several chunks; however, all of the characters in any single event must come from the same external entity so that the Locator provides useful information.

The application must not attempt to read from the array outside of the specified range.

Individual characters may consist of more than one Java char value. There are two important cases where this happens, because characters can't be represented in just sixteen bits. In one case, characters are represented in a Surrogate Pair, using two special Unicode values. Such characters are in the so-called "Astral Planes", with a code point above U+FFFF. A second case involves composite characters, such as a base character combining with one or more accent characters.

Your code should not assume that algorithms using char-at-a-time idioms will be working in character units; in some cases they will split characters. This is relevant wherever XML permits arbitrary characters, such as attribute values, processing instruction data, and comments as well as in data reported from this method. It's also generally relevant whenever Java code manipulates internationalized text; the issue isn't unique to XML.

Note that some parsers will report whitespace in element content using the ignorableWhitespace method rather than this one (validating parsers must do so).

Specified by:

characters in interface ContentHandler

Specified by:

characters in interface DocumentHandler

Overrides:

characters in class BaseMarkupSerializer

Parameters:

chars - the characters from the XML document

start - the start position in the array

length - the number of characters to read from the array

Throws:

SAXException - Any SAX exception, possibly wrapping another exception.

See Also:

ContentHandler.ignorableWhitespace(char[], int, int), Locator

reset

public boolean reset()

Deprecated.

Overrides:

reset in class XMLSerializer