public class UntypedAtomizingIterator extends java.lang.Object implements SequenceIterator<AtomicValue>, LastPositionFinder, LookaheadIterator<AtomicValue>
This UntypedAtomizingIterator is used only when it is known that the input sequence consists entirely of nodes, and that all nodes will be untyped.
ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Constructor and Description |
---|
UntypedAtomizingIterator(SequenceIterator base)
Construct an AtomizingIterator that will atomize the values returned by the base iterator.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
int |
getLength()
Get the last position (that is, the number of items in the sequence).
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
boolean |
hasNext()
Determine whether there are more items to come.
|
AtomicValue |
next()
Get the next item in the sequence.
|
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
forEachOrFail, materialize
public UntypedAtomizingIterator(SequenceIterator base)
base
- the base iteratorpublic AtomicValue next() throws XPathException
SequenceIterator
next
in interface SequenceIterator<AtomicValue>
XPathException
- if an error occurs retrieving the next itempublic void close()
SequenceIterator
For example, the iterator returned by the unparsed-text-lines() function has a close() method that causes the underlying input stream to be closed, whether or not the file has been read to completion.
Closing an iterator is important when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.
close
in interface java.io.Closeable
close
in interface java.lang.AutoCloseable
close
in interface SequenceIterator<AtomicValue>
public int getProperties()
getProperties
in interface SequenceIterator<AtomicValue>
SequenceIterator.GROUNDED
, SequenceIterator.LAST_POSITION_FINDER
,
and SequenceIterator.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.public int getLength() throws XPathException
LastPositionFinder
SequenceIterator.LAST_POSITION_FINDER
getLength
in interface LastPositionFinder
XPathException
- if an error occurs evaluating the sequence in order to determine
the number of itemspublic boolean hasNext()
LookaheadIterator
This method must not be called unless the result of getProperties() on the iterator
includes the bit setting SequenceIterator.LOOKAHEAD
hasNext
in interface LookaheadIterator<AtomicValue>
Copyright (c) 2004-2020 Saxonica Limited. All rights reserved.