Package org.apache.xml.serialize

Class XMLSerializer

  • All Implemented Interfaces:
    DOMSerializer, Serializer, org.xml.sax.ContentHandler, org.xml.sax.DocumentHandler, org.xml.sax.DTDHandler, org.xml.sax.ext.DeclHandler, org.xml.sax.ext.LexicalHandler
    Direct Known Subclasses:
    XML11Serializer
    public class XMLSerializer
extends BaseMarkupSerializer
    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.
    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: 704573 $ $Date: 2008-10-14 21:41:22 +0530 (Tue, 14 Oct 2008) $
    Author:
    Assaf Arkin, Rahul Srivastava, Elena Litani IBM
    See Also:
    Serializer

    • Field Detail

      • fNSBinder

        protected org.apache.xerces.util.NamespaceSupport fNSBinder
        Deprecated.
        stores namespaces in scope

      • fLocalNSBinder

        protected org.apache.xerces.util.NamespaceSupport fLocalNSBinder
        Deprecated.
        stores all namespace bindings on the current element

      • fSymbolTable

        protected org.apache.xerces.util.SymbolTable fSymbolTable
        Deprecated.
        symbol table for serialization

      • fNamespaces

        protected boolean fNamespaces
        Deprecated.
        Controls whether namespace fixup should be performed during the serialization. NOTE: if this field is set to true the following fields need to be initialized: fNSBinder, fLocalNSBinder, fSymbolTable, XMLSymbols.EMPTY_STRING, fXmlSymbol, fXmlnsSymbol

      • fNamespacePrefixes

        protected boolean fNamespacePrefixes
        Deprecated.
        Controls whether namespace prefixes will be printed out during serialization

    • Method Detail

      • setOutputFormat

        public void setOutputFormat​(OutputFormat format)
        Deprecated.
        Description copied from interface: Serializer
        Specifies an output format for this serializer. It the serializer has already been associated with an output format, it will switch to the new format. This method should not be called while the serializer is in the process of serializing a document.
        Specified by:
        setOutputFormat in interface Serializer
        Overrides:
        setOutputFormat in class BaseMarkupSerializer
        Parameters:
        format - The output format to use

      • setNamespaces

        public void setNamespaces​(boolean namespaces)
        Deprecated.
        This methods turns on namespace fixup algorithm during DOM serialization.
        Parameters:
        namespaces -
        See Also:
        LSSerializer

      • startElement

        public void startElement​(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName,
                         org.xml.sax.Attributes attrs)
                  throws org.xml.sax.SAXException
        Deprecated.
        Throws:
        org.xml.sax.SAXException

      • endElement

        public void endElement​(java.lang.String namespaceURI,
                       java.lang.String localName,
                       java.lang.String rawName)
                throws org.xml.sax.SAXException
        Deprecated.
        Throws:
        org.xml.sax.SAXException

      • endElementIO

        public void endElementIO​(java.lang.String namespaceURI,
                         java.lang.String localName,
                         java.lang.String rawName)
                  throws java.io.IOException
        Deprecated.
        Throws:
        java.io.IOException

      • startElement

        public void startElement​(java.lang.String tagName,
                         org.xml.sax.AttributeList attrs)
                  throws org.xml.sax.SAXException
        Deprecated.
        Throws:
        org.xml.sax.SAXException

      • endElement

        public void endElement​(java.lang.String tagName)
                throws org.xml.sax.SAXException
        Deprecated.
        Throws:
        org.xml.sax.SAXException

      • startDocument

        protected void startDocument​(java.lang.String rootTagName)
                      throws java.io.IOException
        Deprecated.
        Called to serialize the document's DOCTYPE by the root element. The document type declaration must name the root element, but the root element is only known when that element is serialized, and not at the start of the document.

        This method will check if it has not been called before (BaseMarkupSerializer._started), will serialize the document type declaration, and will serialize all pre-root comments and PIs that were accumulated in the document (see BaseMarkupSerializer.serializePreRoot()). Pre-root will be serialized even if this is not the first root element of the document.

        Throws:
        java.io.IOException

      • getEntityRef

        protected java.lang.String getEntityRef​(int ch)
        Deprecated.
        Description copied from class: BaseMarkupSerializer
        Returns the suitable entity reference for this character value, or null if no such entity exists. Calling this method with '&' will return "&".
        Specified by:
        getEntityRef in class BaseMarkupSerializer
        Parameters:
        ch - Character value
        Returns:
        Character entity name, or null

      • printEscaped

        protected void printEscaped​(java.lang.String source)
                     throws java.io.IOException
        Deprecated.
        Description copied from class: BaseMarkupSerializer
        Escapes a string so it may be printed as text content or attribute value. Non printable characters are escaped using character references. Where the format specifies a deault entity reference, that reference is used (e.g. <).
        Overrides:
        printEscaped in class BaseMarkupSerializer
        Parameters:
        source - The string to escape
        Throws:
        java.io.IOException

      • printXMLChar

        protected void printXMLChar​(int ch)
                     throws java.io.IOException
        Deprecated.
        print text data
        Throws:
        java.io.IOException

      • printText

        protected void printText​(java.lang.String text,
                         boolean preserveSpace,
                         boolean unescaped)
                  throws java.io.IOException
        Deprecated.
        Overrides:
        printText in class BaseMarkupSerializer
        Throws:
        java.io.IOException

      • printText

        protected void printText​(char[] chars,
                         int start,
                         int length,
                         boolean preserveSpace,
                         boolean unescaped)
                  throws java.io.IOException
        Deprecated.
        Description copied from class: BaseMarkupSerializer
        Called to print additional text with whitespace handling. If spaces are preserved, the text is printed as if by calling BaseMarkupSerializer.printText(String,boolean,boolean) with a call to Printer.breakLine() for each new line. If spaces are not preserved, the text is broken at space boundaries if longer than the line width; Multiple spaces are printed as such, but spaces at beginning of line are removed.
        Overrides:
        printText in class BaseMarkupSerializer
        Parameters:
        chars - The text to print
        start - The start offset
        length - The number of characters
        preserveSpace - Space preserving flag
        unescaped - Print unescaped
        Throws:
        java.io.IOException

      • checkUnboundNamespacePrefixedNode

        protected void checkUnboundNamespacePrefixedNode​(org.w3c.dom.Node node)
                                          throws java.io.IOException
        Deprecated.
        DOM Level 3: Check a node to determine if it contains unbound namespace prefixes.
        Overrides:
        checkUnboundNamespacePrefixedNode in class BaseMarkupSerializer
        Parameters:
        node - The node to check for unbound namespace prefices
        Throws:
        java.io.IOException