org.apache.xml.serializer

Class ToXMLStream

public final class ToXMLStream extends ToStream

This class converts SAX or SAX-like calls to a serialized xml document. The xsl:output method is "xml". This class is used explicitly in code generated by XSLTC, so it is "public", but it should be viewed as internal or package private, this is not an API.

UNKNOWN: internal

Constructor Summary
ToXMLStream()
Default constructor.
Method Summary
voidaddAttribute(String uri, String localName, String rawName, String type, String value, boolean xslAttribute)
Add an attribute to the current element.
voidaddUniqueAttribute(String name, String value, int flags)
This method is used to add an attribute to the currently open element.
voidCopyFrom(ToXMLStream xmlListener)
Copy properties from another SerializerToXML.
voidendDocument()
Receive notification of the end of a document.
voidendElement(String elemName)
voidendPreserving()
Ends a whitespace preserving section.
voidentityReference(String name)
Receive notivication of a entityReference.
voidnamespaceAfterStartElement(String prefix, String uri)
This method is used to notify the serializer of a namespace mapping (or node) that applies to the current element whose startElement() call has already been seen.
voidprocessingInstruction(String target, String data)
Receive notification of a processing instruction.
booleanreset()
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).
voidstartDocumentInternal()
Receive notification of the beginning of a document.
voidstartPreserving()
Starts a whitespace preserving section.

Constructor Detail

ToXMLStream

public ToXMLStream()
Default constructor.

Method Detail

addAttribute

public void addAttribute(String uri, String localName, String rawName, String type, String value, boolean xslAttribute)
Add an attribute to the current element.

Parameters: uri the URI associated with the element name localName local part of the attribute name rawName prefix:localName type value the value of the attribute xslAttribute true if this attribute is from an xsl:attribute, false if declared within the elements opening tag.

Throws: SAXException

addUniqueAttribute

public void addUniqueAttribute(String name, String value, int flags)
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.

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.

CopyFrom

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

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

endDocument

public void endDocument()
Receive notification of the end of a document.

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException

endElement

public void endElement(String elemName)

See Also: endElement

endPreserving

public void endPreserving()
Ends a whitespace preserving section.

Throws: org.xml.sax.SAXException

See Also: ToXMLStream

entityReference

public void entityReference(String name)
Receive notivication of a entityReference.

Parameters: name The name of the entity.

Throws: org.xml.sax.SAXException

namespaceAfterStartElement

public void namespaceAfterStartElement(String prefix, String uri)
This method is used to notify the serializer of a namespace mapping (or node) that applies to the current element whose startElement() call has already been seen. The official SAX startPrefixMapping(prefix,uri) is to define a mapping for a child element that is soon to be seen with a startElement() call. The official SAX call does not apply to the current element, hence the reason for this method.

processingInstruction

public void processingInstruction(String target, String data)
Receive notification of a processing instruction.

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

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.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).

Returns: true if the class was successfuly reset.

startDocumentInternal

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

Throws: org.xml.sax.SAXException Any SAX exception, possibly wrapping another exception. org.xml.sax.SAXException

startPreserving

public void startPreserving()
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: org.xml.sax.SAXException

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