- All Implemented Interfaces:
- Enclosing class:
public static class MultiIndex.SelectedItemsIterator extends java.lang.Object implements SequenceIterator, LastPositionFinder, LookaheadIteratorIterator over a subset of the items in this IndexedValue, identified by an IntSet holding the positions of the items in the selected subset (zero-based)
All Methods Instance Methods Concrete Methods Modifier and Type Method Description
getLength()Get the last position (that is, the number of items in the sequence).
getProperties()Get properties of this iterator, as a bit-significant integer.
hasNext()Determine whether there are more items to come.
next()Get the next item in the sequence.
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
public boolean hasNext()Determine whether there are more items to come. Note that this operation is stateless and it is not necessary (or usual) to call it before calling next(). It is used only when there is an explicit need to tell if we are at the last element.
This method must not be called unless the result of getProperties() on the iterator includes the bit setting
public Item next() throws XPathExceptionGet the next item in the sequence. This method changes the state of the iterator, in particular it affects the result of subsequent calls of position() and current().
- Specified by:
- the next item, or null if there are no more items. Once a call on next() has returned null, no further calls should be made. The preferred action for an iterator if subsequent calls on next() are made is to return null again, and all implementations within Saxon follow this rule.
XPathException- if an error occurs retrieving the next item
public int getLength() throws XPathExceptionGet the last position (that is, the number of items in the sequence). This method is non-destructive: it does not change the state of the iterator. The result is undefined if the next() method of the iterator has already returned null. This method must not be called unless the result of getProperties() on the iterator includes the bit setting
public java.util.EnumSet<SequenceIterator.Property> getProperties()Get properties of this iterator, as a bit-significant integer.
- Specified by:
- the properties of this iterator. This will be some combination of
properties such as
SequenceIterator.Property.LOOKAHEAD. It is always acceptable to return the value zero, indicating that there are no known special properties. It is acceptable for the properties of the iterator to change depending on its state.