## org.apache.xml.serializer
Class ToXMLStream

    java.lang.Object
      |
      +--org.apache.xml.serializer.SerializerBase
            |
            +--org.apache.xml.serializer.ToStream
                  |
                  +--org.apache.xml.serializer.ToXMLStream

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

Usage:
  **For internal use only**

Fields inherited from class org.apache.xml.serializer.SerializerBase
`PKG_NAME, PKG_PATH`

Constructor Summary
`ToXMLStream()` Default constructor.

Method Summary
`void` `addAttribute(java.lang.String uri, java.lang.String localName, java.lang.String rawName, java.lang.String type, java.lang.String value, boolean xslAttribute)` Add an attribute to the current element.
`void` `addUniqueAttribute(java.lang.String name, java.lang.String value, int flags)` This method is used to add an attribute to the currently open element.
`void` `CopyFrom(ToXMLStream xmlListener)` Copy properties from another SerializerToXML.
`void` `endDocument()` Receive notification of the end of a document.
`void` `endElement(java.lang.String elemName)`
`void` `endPreserving()` Ends a whitespace preserving section.
`void` `entityReference(java.lang.String name)` Receive notivication of a entityReference.
`void` `namespaceAfterStartElement(java.lang.String prefix, java.lang.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.
`void` `processingInstruction(java.lang.String target, java.lang.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, addCdataSectionElements, attributeDecl, characters, characters, comment, elementDecl, endCDATA, endDTD, endElement, endNonEscaping, endPrefixMapping, externalEntityDecl, flushPending, getIndentAmount, getOutputFormat, getOutputStream, getWriter, ignorableWhitespace, internalEntityDecl, notationDecl, processAttributes, serialize, setCdataSectionElements, setContentHandler, setDTDEntityExpansion, setEncoding, setEscaping, setIndentAmount, setLineSepUse, setNewLine, setOutputFormat, setOutputStream, setTransformer, setWriter, skippedEntity, startCDATA, startDTD, startElement, startElement, startElement, startEntity, startNonEscaping, startPrefixMapping, startPrefixMapping, unparsedEntityDecl, writeAttrString`

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

`addAttribute, addAttribute, addAttributes, addXSLAttribute, asContentHandler, asDOM3Serializer, asDOMSerializer, characters, close, comment, documentIsEmpty, endEntity, error, fatalError, fireEndEntity, getDoctypePublic, getDoctypeSystem, getEncoding, getIndent, getMediaType, getNamespaceMappings, getNamespaceURI, getNamespaceURIFromPrefix, getOmitXMLDeclaration, getOutputProperty, getOutputPropertyDefault, getOutputPropertyNonDefault, getPrefix, getStandalone, getTransformer, getVersion, setDoctype, setDoctypePublic, setDoctypeSystem, setDocumentLocator, setIndent, setMediaType, setNamespaceMappings, setOmitXMLDeclaration, setOutputProperty, setOutputPropertyDefault, setSourceLocator, setStandalone, setVersion, startDocument, warning`

Methods inherited from class java.lang.Object
`equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait`

Constructor Detail

### ToXMLStream

    public ToXMLStream()

  Default constructor.

Method Detail

### CopyFrom

    public void CopyFrom(ToXMLStream xmlListener)

  Copy properties from another SerializerToXML.
  Parameters:
    `xmlListener` - non-null reference to a SerializerToXML object.

### startDocumentInternal

    public void startDocumentInternal()
                               throws SAXException

  Receive notification of the beginning of a document.
  Throws:
    SAXException - Any SAX exception, possibly wrapping another exception.
    SAXException -

### endDocument

    public void endDocument()
                     throws SAXException

  Receive notification of the end 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 -

### endPreserving

    public void endPreserving()
                       throws SAXException

  Ends a whitespace preserving section.
  Throws:
    SAXException -
  See Also:
    `startPreserving()`

### processingInstruction

    public void processingInstruction(java.lang.String target,
                                      java.lang.String data)
                               throws SAXException

  Receive notification of a processing instruction.
  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 -

### entityReference

    public void entityReference(java.lang.String name)
                         throws SAXException

  Receive notivication of a entityReference.
  Parameters:
    `name` - The name of the entity.
  Throws:
    SAXException -
  Overrides:
    entityReference in class SerializerBase

### addUniqueAttribute

    public void addUniqueAttribute(java.lang.String name,
                                   java.lang.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.
  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.

### addAttribute

    public void addAttribute(java.lang.String uri,
                             java.lang.String localName,
                             java.lang.String rawName,
                             java.lang.String type,
                             java.lang.String value,
                             boolean xslAttribute)
                      throws SAXException

  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 -
  Overrides:
    addAttribute in class SerializerBase

### endElement

    public void endElement(java.lang.String elemName)
                    throws SAXException

  Overrides:
    endElement in class ToStream
  See Also:
    `ExtendedContentHandler.endElement(String)`

### namespaceAfterStartElement

    public void namespaceAfterStartElement(java.lang.String prefix,
                                           java.lang.String uri)
                                    throws SAXException

  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.
  Overrides:
    namespaceAfterStartElement in class SerializerBase

### 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.
  Overrides:
    reset in class ToStream

Copyright © 2006 Apache XML Project. All Rights Reserved.