Class StreamReaderFilter

  • All Implemented Interfaces:
    javax.xml.stream.XMLStreamConstants, javax.xml.stream.XMLStreamReader

    public class StreamReaderFilter
    extends ReaderDelegate

    Apply a filter to the StreamReader

    • Constructor Detail

      • StreamReaderFilter

        public StreamReaderFilter​(javax.xml.stream.XMLStreamReader reader)
      • StreamReaderFilter

        public StreamReaderFilter​(javax.xml.stream.XMLStreamReader reader,
                                  javax.xml.stream.StreamFilter filter)
    • Method Detail

      • setFilter

        public void setFilter​(javax.xml.stream.StreamFilter filter)
      • next

        public int next()
                 throws javax.xml.stream.XMLStreamException
        Description copied from interface: javax.xml.stream.XMLStreamReader
        Get next parsing event - a processor may return all contiguous character data in a single chunk, or it may split it into several chunks. If the property javax.xml.stream.isCoalescing is set to true element content must be coalesced and only one CHARACTERS event must be returned for contiguous element content or CDATA Sections. By default entity references must be expanded and reported transparently to the application. An exception will be thrown if an entity reference cannot be expanded. If element content is empty (i.e. content is "") then no CHARACTERS event will be reported.

        Given the following XML:
        <foo><!--description-->content text<![CDATA[<greeting>Hello</greeting>]]>other content</foo>
        The behavior of calling next() when being on foo will be:
        1- the comment (COMMENT)
        2- then the characters section (CHARACTERS)
        3- then the CDATA section (another CHARACTERS)
        4- then the next characters section (another CHARACTERS)
        5- then the END_ELEMENT

        NOTE: empty element (such as <tag/>) will be reported with two separate events: START_ELEMENT, END_ELEMENT - This preserves parsing equivalency of empty element to <tag></tag>. This method will throw an IllegalStateException if it is called after hasNext() returns false.

        Specified by:
        next in interface javax.xml.stream.XMLStreamReader
        Overrides:
        next in class ReaderDelegate
        Returns:
        the integer code corresponding to the current parse event
        Throws:
        javax.xml.stream.XMLStreamException - if there is an error processing the underlying XML source
        See Also:
        XMLEvent
      • hasNext

        public boolean hasNext()
                        throws javax.xml.stream.XMLStreamException
        Description copied from interface: javax.xml.stream.XMLStreamReader
        Returns true if there are more parsing events and false if there are no more events. This method will return false if the current state of the XMLStreamReader is END_DOCUMENT
        Specified by:
        hasNext in interface javax.xml.stream.XMLStreamReader
        Overrides:
        hasNext in class ReaderDelegate
        Returns:
        true if there are more events, false otherwise
        Throws:
        javax.xml.stream.XMLStreamException - if there is a fatal error detecting the next state
      • main

        public static void main​(java.lang.String[] args)
                         throws java.lang.Exception
        Throws:
        java.lang.Exception