net.sf.saxon.s9api

Class XdmSequenceIterator

public class XdmSequenceIterator extends Object implements Iterator<XdmItem>

An iterator over an XPath sequence.

This class implements the standard Java Iterator interface.

Because the Iterator interface does not define any checked exceptions, the hasNext() method of this iterator throws an unchecked exception if a dynamic error occurs while evaluating the expression. Applications wishing to control error handling should take care to catch this exception.

Constructor Summary
protected XdmSequenceIterator(SequenceIterator base)
Method Summary
booleanhasNext()
Returns true if the iteration has more elements.
XdmItemnext()
Returns the next element in the iteration.
voidremove()
Not supported on this implementation.

Constructor Detail

XdmSequenceIterator

protected XdmSequenceIterator(SequenceIterator base)

Method Detail

hasNext

public boolean hasNext()
Returns true if the iteration has more elements. (In other words, returns true if next would return an element rather than throwing an exception.)

Returns: true if the iterator has more elements.

Throws: SaxonApiUncheckedException if a dynamic error occurs during XPath evaluation that is detected at this point.

next

public XdmItem next()
Returns the next element in the iteration. Calling this method repeatedly until the hasNext method returns false will return each element in the underlying collection exactly once.

Returns: the next element in the iteration.

Throws: java.util.NoSuchElementException iteration has no more elements.

remove

public void remove()
Not supported on this implementation.

Throws: UnsupportedOperationException always