net.sf.saxon.om

Class PrependIterator

public class PrependIterator extends 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
AxisIteratorbase
intposition
NodeInfostart
Constructor Summary
PrependIterator(NodeInfo start, AxisIterator base)
Method Summary
Valueatomize()
Return the atomized value of the current node.
voidclose()
Itemcurrent()
Get the current item in the sequence.
SequenceIteratorgetAnother()
Get another iterator over the same sequence of items, positioned at the start of the sequence
intgetProperties()
Get properties of this iterator, as a bit-significant integer.
CharSequencegetStringValue()
Return the string value of the current node.
AxisIteratoriterateAxis(byte axis, NodeTest test)
Return an iterator over an axis, starting at the current node.
booleanmoveNext()
Move to the next node, without returning it.
Itemnext()
Get the next item in the sequence.
intposition()
Get the current position

Field Detail

base

AxisIterator base

position

int position

start

NodeInfo start

Constructor Detail

PrependIterator

public PrependIterator(NodeInfo start, AxisIterator base)

Method Detail

atomize

public Value atomize()
Return the atomized value of the current node.

Returns: the atomized value.

Throws: NullPointerException if there is no current node

close

public void close()

current

public Item current()
Get the current item in the sequence.

Returns: the current item, that is, the item most recently returned by next()

getAnother

public SequenceIterator getAnother()
Get another iterator over the same sequence of items, positioned at the start of the sequence

Returns: a new iterator over the same sequence

getProperties

public int getProperties()
Get properties of this iterator, as a bit-significant integer.

Returns: the properties of this iterator. This will be some combination of properties such as PrependIterator, PrependIterator, and PrependIterator. 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.

getStringValue

public CharSequence getStringValue()
Return the string value of the current node.

Returns: the string value, as an instance of CharSequence.

Throws: NullPointerException if there is no current node

iterateAxis

public AxisIterator iterateAxis(byte axis, NodeTest test)
Return an iterator over an axis, starting at the current node.

Parameters: axis the axis to iterate over, using a constant such as CHILD test a predicate to apply to the nodes before returning them.

Throws: NullPointerException if there is no current node

moveNext

public boolean moveNext()
Move to the next node, without returning it. Returns true if there is a next node, false if the end of the sequence has been reached. After calling this method, the current node may be retrieved using the current() function.

next

public Item next()
Get the next item in the sequence.

Returns: the next Item. If there are no more nodes, return null.

position

public int position()
Get the current position

Returns: the position of the current item (the item most recently returned by next()), starting at 1 for the first node