Package org.apache.xml.serializer

Class ToXMLStream

  • All Implemented Interfaces:
    DOMSerializer, ExtendedContentHandler, ExtendedLexicalHandler, SerializationHandler, Serializer, org.xml.sax.ContentHandler, org.xml.sax.DTDHandler, org.xml.sax.ErrorHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler
    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.

    • Field Detail

      • CDATA_CONTINUE

        public static final java.lang.String CDATA_CONTINUE
        To insert ]]> in a CDATA section by ending the last CDATA section with ]] and starting the next CDATA section with >
        See Also:
        Constant Field Values

      • CDATA_DELIMITER_CLOSE

        public static final java.lang.String CDATA_DELIMITER_CLOSE
        The constant "]]>"
        See Also:
        Constant Field Values

      • CDATA_DELIMITER_OPEN

        public static final java.lang.String CDATA_DELIMITER_OPEN
        See Also:
        Constant Field Values

      • DEFAULT_SAX_SERIALIZER

        public static final java.lang.String DEFAULT_SAX_SERIALIZER

      • XMLVERSION11

        public static final java.lang.String XMLVERSION11
        Define the XML version.
        See Also:
        Constant Field Values

    • 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 org.xml.sax.SAXException
        Receive notification of the beginning of a document.
        Throws:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        org.xml.sax.SAXException

      • endDocument

        public void endDocument()
                 throws org.xml.sax.SAXException
        Receive notification of the end of a document.
        Throws:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        org.xml.sax.SAXException

      • startPreserving

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

      • endPreserving

        public void endPreserving()
                   throws org.xml.sax.SAXException
        Ends a whitespace preserving section.
        Throws:
        org.xml.sax.SAXException
        See Also:
        startPreserving()

      • processingInstruction

        public void processingInstruction​(java.lang.String target,
                                  java.lang.String data)
                           throws org.xml.sax.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:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        org.xml.sax.SAXException

      • entityReference

        public void entityReference​(java.lang.String name)
                     throws org.xml.sax.SAXException
        Receive notivication of a entityReference.
        Specified by:
        entityReference in interface ExtendedContentHandler
        Overrides:
        entityReference in class SerializerBase
        Parameters:
        name - The name of the entity.
        Throws:
        org.xml.sax.SAXException

      • addUniqueAttribute

        public void addUniqueAttribute​(java.lang.String name,
                               java.lang.String value,
                               int flags)
                        throws org.xml.sax.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.
        Throws:
        org.xml.sax.SAXException

      • 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 org.xml.sax.SAXException
        Add an attribute to the current element.
        Specified by:
        addAttribute in interface ExtendedContentHandler
        Overrides:
        addAttribute in class SerializerBase
        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:
        org.xml.sax.SAXException
        See Also:
        ExtendedContentHandler.addAttribute(String, String, String, String, String)

      • namespaceAfterStartElement

        public void namespaceAfterStartElement​(java.lang.String prefix,
                                       java.lang.String uri)
                                throws org.xml.sax.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.
        Specified by:
        namespaceAfterStartElement in interface ExtendedContentHandler
        Overrides:
        namespaceAfterStartElement in class SerializerBase
        Parameters:
        prefix - the URI of the namespace
        uri - the prefix associated with the given URI.
        Throws:
        org.xml.sax.SAXException
        See Also:
        ExtendedContentHandler.namespaceAfterStartElement(String, String)

      • 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 class ToStream
        Returns:
        true if the class was successfuly reset.