| java.lang.Object
 net.sf.saxon.om.ClosingIterator
| ClosingIterator | | public class ClosingIterator implements SequenceIterator(Code) | | A closing iterator returns the items delivered by an underlying iterator unchanged, and
calls a user-supplied function when the underlying iterator hits the end of the sequence.
|
| Method Summary | |
| public Item | current()
Get the current value in the sequence (the one returned by the
most recent call on next()). | | public SequenceIterator | getAnother()
Get another SequenceIterator that iterates over the same items as the original,
but which is repositioned at the start of the sequence.
This method allows access to all the items in the sequence without disturbing the
current position of the iterator. | | public int | getProperties()
Get properties of this iterator, as a bit-significant integer.
the properties of this iterator. | | public Item | next()
Get the next item in the sequence. | | public int | position()
Get the current position. |
| current | | public Item current()(Code) | | Get the current value in the sequence (the one returned by the
most recent call on next()). This will be null before the first
call of next(). This method does not change the state of the iterator.
the current item, the one most recently returned by a call onnext(). Returns null if next() has not been called, or if the endof the sequence has been reached.
since:
8.4 |
| getAnother | | public SequenceIterator getAnother() throws XPathException(Code) | | Get another SequenceIterator that iterates over the same items as the original,
but which is repositioned at the start of the sequence.
This method allows access to all the items in the sequence without disturbing the
current position of the iterator. Internally, its main use is in evaluating the last()
function.
This method does not change the state of the iterator.
a SequenceIterator that iterates over the same items,positioned before the first item
throws:
net.sf.saxon.trans.XPathException - if any error occurs
since:
8.4 |
| getProperties | | public int getProperties()(Code) | | Get properties of this iterator, as a bit-significant integer.
the properties of this iterator. This will be some combination ofproperties such as GROUNDED, LAST_POSITION_FINDER,and LOOKAHEAD. It is alwaysacceptable 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.
since:
8.6 |
| next | | public Item next() throws XPathException(Code) | | Get 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().
the next item, or null if there are no more items. Once a callon next() has returned null, no further calls should be made. The preferredaction for an iterator if subsequent calls on next() are made is to returnnull again, and all implementations within Saxon follow this rule.
throws:
net.sf.saxon.trans.XPathException - if an error occurs retrieving the next item
since:
8.4 |
| position | | public int position()(Code) | | Get the current position. This will usually be zero before the first call
on next(), otherwise it will be the number of times that next() has
been called. Once next() has returned null, the preferred action is
for subsequent calls on position() to return -1, but not all existing
implementations follow this practice. (In particular, the EmptyIterator
is stateless, and always returns 0 as the value of position(), whether
or not next() has been called.)
This method does not change the state of the iterator.
the current position, the position of the item returned by themost recent call of next(). This is 1 after next() has been successfullycalled once, 2 after it has been called twice, and so on. If next() hasnever been called, the method returns zero. If the end of the sequencehas been reached, the value returned will always be <= 0; the preferredvalue is -1.
since:
8.4 |
|
|