net.sf.saxon.om

Interface AxisIterator

public interface AxisIterator extends UnfailingIterator

A SequenceIterator is used to iterate over a sequence. An AxisIterator is a SequenceIterator that throws no exceptions, and that always returns nodes. The nodes should all be in the same document (though there are some cases, such as PrependIterator, where this is the responsibility of the user of the class and is not enforced.)
Method Summary
Valueatomize()
Return the atomized value of the current node.
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.

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

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.