Package com.thoughtworks.xstream.io.xml

Class SaxWriter

    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      void addAttribute​(java.lang.String name, java.lang.String value)  
      void close()
      Close the writer, if necessary.
      private void endDocument​(boolean multiObjectMode)
      Fires the SAX endDocument event towards the configured ContentHandler.
      void endNode()  
      void flush()
      Flush the writer, if necessary.
      private void flushStartTag()
      Fires any pending SAX startElement event towards the configured ContentHandler.
      org.xml.sax.ContentHandler getContentHandler()
      Returns the current content handler.
      org.xml.sax.DTDHandler getDTDHandler()
      Returns the current DTD handler.
      org.xml.sax.EntityResolver getEntityResolver()
      Returns the current entity resolver.
      org.xml.sax.ErrorHandler getErrorHandler()
      Returns the current error handler.
      boolean getFeature​(java.lang.String name)
      Looks up the value of a feature.
      java.lang.Object getProperty​(java.lang.String name)
      Looks up the value of a property.
      private void parse()
      Serializes the Java objects of the configured list into a flow of SAX events.
      void parse​(java.lang.String systemId)
      Parses an XML document from a system identifier (URI).
      void parse​(org.xml.sax.InputSource input)
      Parse an XML document.
      void setContentHandler​(org.xml.sax.ContentHandler handler)
      Allows an application to register a content event handler.
      void setDTDHandler​(org.xml.sax.DTDHandler handler)
      Allows an application to register a DTD event handler.
      void setEntityResolver​(org.xml.sax.EntityResolver resolver)
      Allows an application to register an entity resolver.
      void setErrorHandler​(org.xml.sax.ErrorHandler handler)
      Allows an application to register an error event handler.
      void setFeature​(java.lang.String name, boolean value)
      Sets the state of a feature.
      void setProperty​(java.lang.String name, java.lang.Object value)
      Sets the value of a property.
      void setValue​(java.lang.String text)
      Write the value (text content) of the current node.
      private void startDocument​(boolean multiObjectMode)
      Fires the SAX startDocument event towards the configured ContentHandler.
      void startNode​(java.lang.String name)  

      • Methods inherited from class java.lang.Object

        clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

    • Field Detail

      • CONFIGURED_XSTREAM_PROPERTY

        public static final java.lang.String CONFIGURED_XSTREAM_PROPERTY
        The SAX property to configure the XStream facade to be used for object serialization. If the property is not set, a new XStream facade will be allocated for each parse.
        See Also:
        Constant Field Values

      • entityResolver

        private org.xml.sax.EntityResolver entityResolver
        The SAX EntityResolver associated to this XMLReader.

      • dtdHandler

        private org.xml.sax.DTDHandler dtdHandler
        The SAX DTDHandler associated to this XMLReader.

      • contentHandler

        private org.xml.sax.ContentHandler contentHandler
        The SAX ContentHandler associated to this XMLReader.

      • errorHandler

        private org.xml.sax.ErrorHandler errorHandler
        The SAX ErrorHandler associated to this XMLReader.

      • features

        private java.util.Map features
        The SAX features defined for this XMLReader.

        This class does not define any feature (yet) and ignores the SAX mandatory feature. Thus, this member is present only to support the mandatory feature setting and retrieval logic defined by SAX.

      • properties

        private final java.util.Map properties
        The SAX properties defined for this XMLReader.

      • includeEnclosingDocument

        private final boolean includeEnclosingDocument

      • depth

        private int depth

      • elementStack

        private java.util.List elementStack

      • buffer

        private char[] buffer

      • startTagInProgress

        private boolean startTagInProgress

      • attributeList

        private final org.xml.sax.helpers.AttributesImpl attributeList

    • Method Detail

      • setFeature

        public void setFeature​(java.lang.String name,
                       boolean value)
                throws org.xml.sax.SAXNotRecognizedException
        Sets the state of a feature.

        The feature name is any fully-qualified URI.

        All XMLReaders are required to support setting http://xml.org/sax/features/namespaces to true and http://xml.org/sax/features/namespace-prefixes to false.

        Some feature values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

        Note: This implementation only supports the two mandatory SAX features.

        Specified by:
        setFeature in interface org.xml.sax.XMLReader
        Parameters:
        name - the feature name, which is a fully-qualified URI.
        value - the requested state of the feature (true or false).
        Throws:
        org.xml.sax.SAXNotRecognizedException - when the XMLReader does not recognize the feature name.
        See Also:
        getFeature(java.lang.String)

      • getFeature

        public boolean getFeature​(java.lang.String name)
                   throws org.xml.sax.SAXNotRecognizedException
        Looks up the value of a feature.

        The feature name is any fully-qualified URI. It is possible for an XMLReader to recognize a feature name but to be unable to return its value; this is especially true in the case of an adapter for a SAX1 Parser, which has no way of knowing whether the underlying parser is performing validation or expanding external entities.

        All XMLReaders are required to recognize the http://xml.org/sax/features/namespaces and the http://xml.org/sax/features/namespace-prefixes feature names.

        Some feature values may be available only in specific contexts, such as before, during, or after a parse.

        Implementors are free (and encouraged) to invent their own features, using names built on their own URIs.

        Specified by:
        getFeature in interface org.xml.sax.XMLReader
        Parameters:
        name - the feature name, which is a fully-qualified URI.
        Returns:
        the current state of the feature (true or false).
        Throws:
        org.xml.sax.SAXNotRecognizedException - when the XMLReader does not recognize the feature name.
        See Also:
        setFeature(java.lang.String, boolean)

      • setProperty

        public void setProperty​(java.lang.String name,
                        java.lang.Object value)
                 throws org.xml.sax.SAXNotRecognizedException,
                        org.xml.sax.SAXNotSupportedException
        Sets the value of a property.

        The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to set its value.

        XMLReaders are not required to recognize setting any specific property names, though a core set is provided with SAX2.

        Some property values may be immutable or mutable only in specific contexts, such as before, during, or after a parse.

        This method is also the standard mechanism for setting extended handlers.

        Note: This implementation only supports two (proprietary) properties: CONFIGURED_XSTREAM_PROPERTY and SOURCE_OBJECT_LIST_PROPERTY.

        Specified by:
        setProperty in interface org.xml.sax.XMLReader
        Parameters:
        name - the property name, which is a fully-qualified URI.
        value - the requested value for the property.
        Throws:
        org.xml.sax.SAXNotRecognizedException - when the XMLReader does not recognize the property name.
        org.xml.sax.SAXNotSupportedException - when the XMLReader recognizes the property name but cannot set the requested value.
        See Also:
        getProperty(java.lang.String)

      • getProperty

        public java.lang.Object getProperty​(java.lang.String name)
                             throws org.xml.sax.SAXNotRecognizedException
        Looks up the value of a property.

        The property name is any fully-qualified URI. It is possible for an XMLReader to recognize a property name but to be unable to return its state.

        XMLReaders are not required to recognize any specific property names, though an initial core set is documented for SAX2.

        Some property values may be available only in specific contexts, such as before, during, or after a parse.

        Implementors are free (and encouraged) to invent their own properties, using names built on their own URIs.

        Specified by:
        getProperty in interface org.xml.sax.XMLReader
        Parameters:
        name - the property name, which is a fully-qualified URI.
        Returns:
        the current value of the property.
        Throws:
        org.xml.sax.SAXNotRecognizedException - when the XMLReader does not recognize the property name.
        See Also:
        getProperty(java.lang.String)

      • setEntityResolver

        public void setEntityResolver​(org.xml.sax.EntityResolver resolver)
        Allows an application to register an entity resolver.

        If the application does not register an entity resolver, the XMLReader will perform its own default resolution.

        Applications may register a new or different resolver in the middle of a parse, and the SAX parser must begin using the new resolver immediately.

        Specified by:
        setEntityResolver in interface org.xml.sax.XMLReader
        Parameters:
        resolver - the entity resolver.
        Throws:
        java.lang.NullPointerException - if the resolver argument is null.
        See Also:
        getEntityResolver()

      • getEntityResolver

        public org.xml.sax.EntityResolver getEntityResolver()
        Returns the current entity resolver.
        Specified by:
        getEntityResolver in interface org.xml.sax.XMLReader
        Returns:
        the current entity resolver, or null if none has been registered.
        See Also:
        setEntityResolver(org.xml.sax.EntityResolver)

      • setDTDHandler

        public void setDTDHandler​(org.xml.sax.DTDHandler handler)
        Allows an application to register a DTD event handler.

        If the application does not register a DTD handler, all DTD events reported by the SAX parser will be silently ignored.

        Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

        Specified by:
        setDTDHandler in interface org.xml.sax.XMLReader
        Parameters:
        handler - the DTD handler.
        Throws:
        java.lang.NullPointerException - if the handler argument is null.
        See Also:
        getDTDHandler()

      • getDTDHandler

        public org.xml.sax.DTDHandler getDTDHandler()
        Returns the current DTD handler.
        Specified by:
        getDTDHandler in interface org.xml.sax.XMLReader
        Returns:
        the current DTD handler, or null if none has been registered.
        See Also:
        setDTDHandler(org.xml.sax.DTDHandler)

      • setContentHandler

        public void setContentHandler​(org.xml.sax.ContentHandler handler)
        Allows an application to register a content event handler.

        If the application does not register a content handler, all content events reported by the SAX parser will be silently ignored.

        Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

        Specified by:
        setContentHandler in interface org.xml.sax.XMLReader
        Parameters:
        handler - the content handler.
        Throws:
        java.lang.NullPointerException - if the handler argument is null.
        See Also:
        getContentHandler()

      • getContentHandler

        public org.xml.sax.ContentHandler getContentHandler()
        Returns the current content handler.
        Specified by:
        getContentHandler in interface org.xml.sax.XMLReader
        Returns:
        the current content handler, or null if none has been registered.
        See Also:
        setContentHandler(org.xml.sax.ContentHandler)

      • setErrorHandler

        public void setErrorHandler​(org.xml.sax.ErrorHandler handler)
        Allows an application to register an error event handler.

        If the application does not register an error handler, all error events reported by the SAX parser will be silently ignored; however, normal processing may not continue. It is highly recommended that all SAX applications implement an error handler to avoid unexpected bugs.

        Applications may register a new or different handler in the middle of a parse, and the SAX parser must begin using the new handler immediately.

        Specified by:
        setErrorHandler in interface org.xml.sax.XMLReader
        Parameters:
        handler - the error handler.
        Throws:
        java.lang.NullPointerException - if the handler argument is null.
        See Also:
        getErrorHandler()

      • getErrorHandler

        public org.xml.sax.ErrorHandler getErrorHandler()
        Returns the current error handler.
        Specified by:
        getErrorHandler in interface org.xml.sax.XMLReader
        Returns:
        the current error handler, or null if none has been registered.
        See Also:
        setErrorHandler(org.xml.sax.ErrorHandler)

      • parse

        public void parse​(java.lang.String systemId)
           throws org.xml.sax.SAXException
        Parses an XML document from a system identifier (URI).

        This method is a shortcut for the common case of reading a document from a system identifier. It is the exact equivalent of the following:

            parse(new InputSource(systemId));

        If the system identifier is a URL, it must be fully resolved by the application before it is passed to the parser.

        Note: As a custom SAX parser, this class ignores the systemId argument of this method and relies on the proprietary SAX property SOURCE_OBJECT_LIST_PROPERTY) to define the list of objects to serialize.

        Specified by:
        parse in interface org.xml.sax.XMLReader
        Parameters:
        systemId - the system identifier (URI).
        Throws:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        parse(org.xml.sax.InputSource)

      • parse

        public void parse​(org.xml.sax.InputSource input)
           throws org.xml.sax.SAXException
        Parse an XML document.

        The application can use this method to instruct the XML reader to begin parsing an XML document from any valid input source (a character stream, a byte stream, or a URI).

        Applications may not invoke this method while a parse is in progress (they should create a new XMLReader instead for each nested XML document). Once a parse is complete, an application may reuse the same XMLReader object, possibly with a different input source.

        During the parse, the XMLReader will provide information about the XML document through the registered event handlers.

        This method is synchronous: it will not return until parsing has ended. If a client application wants to terminate parsing early, it should throw an exception.

        Note: As a custom SAX parser, this class ignores the source argument of this method and relies on the proprietary SAX property SOURCE_OBJECT_LIST_PROPERTY) to define the list of objects to serialize.

        Specified by:
        parse in interface org.xml.sax.XMLReader
        Parameters:
        input - The input source for the top-level of the XML document.
        Throws:
        org.xml.sax.SAXException - Any SAX exception, possibly wrapping another exception.
        See Also:
        InputSource, parse(java.lang.String), setEntityResolver(org.xml.sax.EntityResolver), setDTDHandler(org.xml.sax.DTDHandler), setContentHandler(org.xml.sax.ContentHandler), setErrorHandler(org.xml.sax.ErrorHandler)

      • parse

        private void parse()
            throws org.xml.sax.SAXException
        Serializes the Java objects of the configured list into a flow of SAX events.
        Throws:
        org.xml.sax.SAXException - if the configured object list is invalid or object serialization failed.

      • startDocument

        private void startDocument​(boolean multiObjectMode)
                    throws org.xml.sax.SAXException
        Fires the SAX startDocument event towards the configured ContentHandler.
        Parameters:
        multiObjectMode - whether serialization of several object will be merge into a single SAX document.
        Throws:
        org.xml.sax.SAXException - if thrown by the ContentHandler.

      • endDocument

        private void endDocument​(boolean multiObjectMode)
                  throws org.xml.sax.SAXException
        Fires the SAX endDocument event towards the configured ContentHandler.
        Parameters:
        multiObjectMode - whether serialization of several object will be merge into a single SAX document.
        Throws:
        org.xml.sax.SAXException - if thrown by the ContentHandler.

      • flushStartTag

        private void flushStartTag()
                    throws org.xml.sax.SAXException
        Fires any pending SAX startElement event towards the configured ContentHandler.
        Throws:
        org.xml.sax.SAXException - if thrown by the ContentHandler.