net.sf.saxon.evpull

Class BracketedDocumentIterator

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 Summary
	BracketedDocumentIterator(EventIterator content) Constructor

Method Summary
boolean	isFlatSequence() Determine whether the EventIterator returns a flat sequence of events, or whether it can return nested event iterators
PullEvent	next() Get the next event in the sequence

Constructor Detail

BracketedDocumentIterator

public BracketedDocumentIterator(EventIterator content)

Constructor

Parameters: content iterator that delivers the content of the document

Method Detail

isFlatSequence

public boolean isFlatSequence()

Determine whether the EventIterator returns a flat sequence of events, or whether it can return nested event iterators

Returns: true if the next() method is guaranteed never to return an EventIterator

public PullEvent next()

Get the next event in the sequence

Returns: the next event, or null when the sequence is exhausted

Throws: net.sf.saxon.trans.XPathException if a dynamic evaluation error occurs