org.apache.xml.serializer

Class ToXMLStream

Implemented Interfaces:
ContentHandler, DeclHandler, DOM2DTM.CharacterNodeHandler, DOMSerializer, ErrorHandler, ExtendedContentHandler, ExtendedLexicalHandler, LexicalHandler, SerializationHandler, Serializer, SerializerConstants, XSLOutputAttributes

public class ToXMLStream
extends ToStream

Authors:
Santiago Pericas-Geertsen
G. Todd Miller

Fields inherited from interface org.apache.xml.serializer.ExtendedContentHandler

HTML_ATTREMPTY, HTML_ATTRURL, NO_BAD_CHARS

Fields inherited from interface org.apache.xml.serializer.SerializerConstants

BEGCDATA, CDATA_CONTINUE, CDATA_DELIMITER_CLOSE, CDATA_DELIMITER_OPEN, CNTCDATA, DEFAULT_SAX_SERIALIZER, EMPTYSTRING, ENDCDATA, ENTITY_AMP, ENTITY_CRLF, ENTITY_GT, ENTITY_LT, ENTITY_QUOT, XMLNS_PREFIX, XMLNS_URI, XML_PREFIX

Constructor Summary

ToXMLStream()
Default constructor.

Method Summary

void
CopyFrom(ToXMLStream xmlListener)
Copy properties from another SerializerToXML.
void
addAttribute(String uri, String localName, String rawName, String type, String value)
Add at attribute to the current element
void
addUniqueAttribute(String name, String value, int flags)
This method is used to add an attribute to the currently open element.
void
endDocument()
Receive notification of the end of a document.
void
endElement(String elemName)
void
endPreserving()
Ends a whitespace preserving section.
void
entityReference(String name)
Receive notivication of a entityReference.
void
namespaceAfterStartElement(String prefix, String uri)
From XSLTC Related to startPrefixMapping ?
void
processingInstruction(String target, String data)
Receive notification of a processing instruction.
boolean
reset()
Try's to reset the super class and reset this class for re-use, so that you don't need to create a new serializer (mostly for performance reasons).
void
startDocumentInternal()
Receive notification of the beginning of a document.
void
startPreserving()
Starts a whitespace preserving section.

Methods inherited from class org.apache.xml.serializer.ToStream

addAttributeAlways, attributeDecl, characters, characters, comment, elementDecl, endCDATA, endDTD, endElement, endElement, endNonEscaping, endPrefixMapping, externalEntityDecl, flushPending, getIndentAmount, getOutputFormat, getOutputStream, getWriter, ignorableWhitespace, internalEntityDecl, processAttributes, reset, serialize, setCdataSectionElements, setContentHandler, setEscaping, setIndentAmount, setLineSepUse, setOutputFormat, setOutputStream, setTransformer, setWriter, skippedEntity, startCDATA, startDTD, startElement, startElement, startElement, startEntity, startNonEscaping, startPrefixMapping, startPrefixMapping, writeAttrString

Methods inherited from class org.apache.xml.serializer.SerializerBase

addAttribute, addAttribute, addAttributeAlways, addAttributes, asContentHandler, asDOMSerializer, characters, close, comment, endEntity, entityReference, error, fatalError, fireEndEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getIndentAmount, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getPrefix, getStandalone, getTransformer, getVersion, namespaceAfterStartElement, reset, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setEncoding, setIndent, setIndentAmount, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setSourceLocator, setStandalone, setTransformer, setVersion, startDocument, warning

Constructor Details

ToXMLStream

public ToXMLStream()
Default constructor.

Method Details

CopyFrom

public void CopyFrom(ToXMLStream xmlListener)
Copy properties from another SerializerToXML.

Parameters:
xmlListener - non-null reference to a SerializerToXML object.


addAttribute

public void addAttribute(String uri,
                         String localName,
                         String rawName,
                         String type,
                         String value)
            throws SAXException
Add at attribute to the current element
Specified by:
addAttribute in interface ExtendedContentHandler
Overrides:
addAttribute in interface SerializerBase

Parameters:
uri - the namespace URI of the attribute name
localName - the local name of the attribute (without prefix)
rawName - the qualified name of the attribute
type - the attribute type typically character data (CDATA)
value - the value of the attribute

Throws:
SAXException -


addUniqueAttribute

public void addUniqueAttribute(String name,
                               String value,
                               int flags)
            throws SAXException
This method is used to add an attribute to the currently open element. The caller has guaranted that this attribute is unique, which means that it not been seen before and will not be seen again.
Specified by:
addUniqueAttribute in interface ExtendedContentHandler

Parameters:
name - the qualified name of the attribute
value - the value of the attribute which can contain only ASCII printable characters characters in the range 32 to 127 inclusive.
flags - the bit values of this integer give optimization information.


endDocument

public void endDocument()
            throws SAXException
Receive notification of the end of a document.
Specified by:
endDocument in interface ContentHandler

Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
SAXException -


endElement

public void endElement(String elemName)
            throws SAXException
Specified by:
endElement in interface ExtendedContentHandler
Overrides:
endElement in interface ToStream

See Also:
ExtendedContentHandler.endElement(String)


endPreserving

public void endPreserving()
            throws SAXException
Ends a whitespace preserving section.

Throws:
SAXException -

See Also:
startPreserving()


entityReference

public void entityReference(String name)
            throws SAXException
Receive notivication of a entityReference.
Specified by:
entityReference in interface ExtendedContentHandler
Overrides:
entityReference in interface SerializerBase

Parameters:
name - The name of the entity.

Throws:
SAXException -


namespaceAfterStartElement

public void namespaceAfterStartElement(String prefix,
                                       String uri)
            throws SAXException
From XSLTC Related to startPrefixMapping ???
Specified by:
namespaceAfterStartElement in interface ExtendedContentHandler
Overrides:
namespaceAfterStartElement in interface SerializerBase


processingInstruction

public void processingInstruction(String target,
                                  String data)
            throws SAXException
Receive notification of a processing instruction.
Specified by:
processingInstruction in interface ContentHandler

Parameters:
target - The processing instruction target.
data - The processing instruction data, or null if none was supplied.

Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
SAXException -


reset

public boolean reset()
Try's to reset the super class and reset this class for re-use, so that you don't need to create a new serializer (mostly for performance reasons).
Specified by:
reset in interface Serializer
Overrides:
reset in interface ToStream

Returns:
true if the class was successfuly reset.


startDocumentInternal

public void startDocumentInternal()
            throws SAXException
Receive notification of the beginning of a document.

Throws:
SAXException - Any SAX exception, possibly wrapping another exception.
SAXException -


startPreserving

public void startPreserving()
            throws SAXException
Starts a whitespace preserving section. All characters printed within a preserving section are printed without indentation and without consolidating multiple spaces. This is equivalent to the xml:space="preserve" attribute. Only XML and HTML serializers need to support this method.

The contents of the whitespace preserving section will be delivered through the regular characters event.

Throws:
SAXException -


Copyright B) 2004 Apache XML Project. All Rights Reserved.