Interface EventReader

  • All Known Implementing Classes:
    DocumentReader, PullReader, StreamReader

    interface EventReader
    The EventReader interface is used to represent an XML reader that can be used to read a source document. This provides a convenient abstraction that can be used by any number of parser implementations. In essence it is similar to the Streaming API for XML, however other implementations can easily be adapted.
    • Method Detail

      • next

        EventNode next()
                throws java.lang.Exception
        This is used to take the next node from the document. This will scan through the document, ignoring any comments to find the next relevant XML event to acquire. Typically events will be the start and end of an element, as well as any text nodes.
        Returns:
        this returns the next event taken from the source XML
        Throws:
        java.lang.Exception
      • peek

        EventNode peek()
                throws java.lang.Exception
        This is used to peek at the node from the document. This will scan through the document, ignoring any comments to find the next relevant XML event to acquire. Typically events will be the start and end of an element, as well as any text nodes.
        Returns:
        this returns the next event taken from the source XML
        Throws:
        java.lang.Exception