public class ArrayIterator extends java.lang.Object implements UnfailingIterator, LastPositionFinder, LookaheadIterator, GroundedIterator
Modifier and Type | Class and Description |
---|---|
static class |
ArrayIterator.OfNodes |
Modifier and Type | Field and Description |
---|---|
protected int |
end |
protected Item[] |
items |
protected int |
start |
ATOMIZING, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
Constructor and Description |
---|
ArrayIterator(Item[] nodes)
Create an iterator over all the items in an array
|
ArrayIterator(Item[] items,
int start,
int end)
Create an iterator over a range of an array.
|
Modifier and Type | Method and Description |
---|---|
void |
close()
Close the iterator.
|
Item[] |
getArray()
Get the underlying array
|
int |
getEndPosition()
Get the end position in the array
|
int |
getLength()
Get the number of items in the part of the array being processed
|
int |
getProperties()
Get properties of this iterator, as a bit-significant integer.
|
GroundedValue |
getResidue()
Return a GroundedValue containing all the remaining items in the sequence returned by this
SequenceIterator, starting at the current position.
|
int |
getStartPosition()
Get the initial start position
|
boolean |
hasNext()
Test whether there are any more items
|
SequenceIterator |
makeSliceIterator(int min,
int max)
Create a new ArrayIterator over the same items,
with a different start point and end point
|
GroundedValue |
materialize()
Return a SequenceValue containing all the items in the sequence returned by this
SequenceIterator
|
Item |
next()
Get the next item in the array
|
protected Item[] items
protected int start
protected int end
public ArrayIterator(Item[] nodes)
nodes
- the array (of any items, not necessarily nodes) to be
processed by the iteratorpublic ArrayIterator(Item[] items, int start, int end)
items
- the array (of nodes or simple values) to be processed by
the iteratorstart
- the position of the first item to be processed
(numbering from zero). Must be between zero and nodes.length-1; if not,
undefined exceptions are likely to occur.end
- position of first item that is NOT returned, zero-based. Must be
beween 1 and nodes.length; if not, undefined exceptions are likely to occur.public SequenceIterator makeSliceIterator(int min, int max)
min
- the start position (1-based) of the new ArrayIterator
relative to the originalmax
- the end position (1-based) of the last item to be delivered
by the new ArrayIterator, relative to the original. For example, min=2, max=3
delivers the two items ($base[2], $base[3]). Set this to Integer.MAX_VALUE if
there is no end limit.public boolean hasNext()
hasNext
in interface LookaheadIterator
public Item next()
next
in interface SequenceIterator
next
in interface UnfailingIterator
public int getLength()
getLength
in interface LastPositionFinder
public void close()
SequenceIterator
(Currently, closing an iterator is important only 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 SequenceIterator
public Item[] getArray()
public int getStartPosition()
public int getEndPosition()
public GroundedValue materialize()
materialize
in interface GroundedIterator
public GroundedValue getResidue() throws XPathException
GroundedIterator
getResidue
in interface GroundedIterator
XPathException
- in the cases of subclasses (such as the iterator over a MemoClosure)
which cause evaluation of expressions while materializing the value.public int getProperties()
getProperties
in interface SequenceIterator
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.Copyright (c) 2004-2018 Saxonica Limited. All rights reserved.