net.sf.saxon.evpull

Class SingletonEventIterator

public class SingletonEventIterator extends Object implements EventIterator

This class represents an EventIterator over a sequence containing a single pull event.
Constructor Summary
SingletonEventIterator(PullEvent event)
Create an iterator over a sequence containing a single pull event
Method Summary
booleanisFlatSequence()
Determine whether the EventIterator returns a flat sequence of events, or whether it can return nested event iterators
PullEventnext()
Get the next event in the sequence

Constructor Detail

SingletonEventIterator

public SingletonEventIterator(PullEvent event)
Create an iterator over a sequence containing a single pull event

Parameters: event the single event. This must not be an EventIterator

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

next

public PullEvent next()
Get the next event in the sequence

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

Throws: XPathException if a dynamic evaluation error occurs