Package net.sf.saxon.om
Class PrependIterator
- java.lang.Object
-
- net.sf.saxon.om.PrependIterator
-
- All Implemented Interfaces:
AxisIterator
,SequenceIterator
public class PrependIterator extends java.lang.Object implements AxisIterator
An iterator over nodes, that prepends a given node to the nodes returned by another iterator. Used to modify an iterator over axis A to one that iterates over A-OR-SELF.
-
-
Field Summary
Fields Modifier and Type Field Description (package private) AxisIterator
base
(package private) int
position
(package private) NodeInfo
start
-
Fields inherited from interface net.sf.saxon.om.SequenceIterator
ATOMIZABLE, GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
-
-
Constructor Summary
Constructors Constructor Description PrependIterator(NodeInfo start, AxisIterator base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Item
current()
Get the current item in the sequence.SequenceIterator
getAnother()
Get another iterator over the same sequence of items, positioned at the start of the sequenceint
getProperties()
Get properties of this iterator, as a bit-significant integer.Item
next()
Get the next item in the sequence.int
position()
Get the current position
-
-
-
Field Detail
-
start
NodeInfo start
-
base
AxisIterator base
-
position
int position
-
-
Constructor Detail
-
PrependIterator
public PrependIterator(NodeInfo start, AxisIterator base)
-
-
Method Detail
-
next
public Item next()
Get the next item in the sequence.- Specified by:
next
in interfaceAxisIterator
- Specified by:
next
in interfaceSequenceIterator
- Returns:
- the next Item. If there are no more nodes, return null.
-
current
public Item current()
Get the current item in the sequence.- Specified by:
current
in interfaceAxisIterator
- Specified by:
current
in interfaceSequenceIterator
- Returns:
- the current item, that is, the item most recently returned by next()
-
position
public int position()
Get the current position- Specified by:
position
in interfaceAxisIterator
- Specified by:
position
in interfaceSequenceIterator
- Returns:
- the position of the current item (the item most recently returned by next()), starting at 1 for the first node
-
getAnother
public SequenceIterator getAnother()
Get another iterator over the same sequence of items, positioned at the start of the sequence- Specified by:
getAnother
in interfaceAxisIterator
- Specified by:
getAnother
in interfaceSequenceIterator
- Returns:
- a new iterator over the same sequence
-
getProperties
public int getProperties()
Get properties of this iterator, as a bit-significant integer.- Specified by:
getProperties
in interfaceSequenceIterator
- Returns:
- the properties of this iterator. This will be some combination of
properties such as
SequenceIterator.GROUNDED
,SequenceIterator.LAST_POSITION_FINDER
, andSequenceIterator.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.
-
-