Class BracketedDocumentIterator

java.lang.Object
net.sf.saxon.evpull.BracketedDocumentIterator
All Implemented Interfaces:
EventIterator, PullEvent
public class BracketedDocumentIterator extends Object implements EventIterator
The class is an EventIterator that handles the events arising from a document node constructor: that is, the start/end event pair for the document node, bracketing a sequence of events for the content of the document.

This class does not normalize the content (for example by merging adjacent text nodes). That is the job of the ComplexContentProcessor.

  • Constructor Details

    • BracketedDocumentIterator

      public BracketedDocumentIterator(EventIterator content)
      Constructor
      Parameters:
      content - iterator that delivers the content of the document

  • Method Details

    • next

      public PullEvent next() throws XPathException
      Get the next event in the sequence
      Specified by:
      next in interface EventIterator
      Returns:
      the next event, or null when the sequence is exhausted
      Throws:
      XPathException - if a dynamic evaluation error occurs

    • isFlatSequence

      public boolean isFlatSequence()
      Determine whether the EventIterator returns a flat sequence of events, or whether it can return nested event iterators
      Specified by:
      isFlatSequence in interface EventIterator
      Returns:
      true if the next() method is guaranteed never to return an EventIterator