org.htmlunit.xpath.xml.dtm

Interface DTMAxisIterator

All Superinterfaces:

Cloneable

All Known Implementing Classes:

DTMAxisIteratorBase, DTMDefaultBaseIterators.AncestorIterator, DTMDefaultBaseIterators.AttributeIterator, DTMDefaultBaseIterators.ChildrenIterator, DTMDefaultBaseIterators.DescendantIterator, DTMDefaultBaseIterators.FollowingIterator, DTMDefaultBaseIterators.FollowingSiblingIterator, DTMDefaultBaseIterators.InternalAxisIteratorBase, DTMDefaultBaseIterators.NamespaceIterator, DTMDefaultBaseIterators.ParentIterator, DTMDefaultBaseIterators.PrecedingIterator, DTMDefaultBaseIterators.PrecedingSiblingIterator, DTMDefaultBaseIterators.RootIterator, DTMDefaultBaseIterators.SingletonIterator

public interface DTMAxisIterator
extends Cloneable

This class iterates over a single XPath Axis, and returns node handles.

Field Summary

Fields

Modifier and Type	Field and Description
static int	END Specifies the end of the iteration, and is the same as DTM.NULL.

Method Summary

Modifier and Type	Method and Description
DTMAxisIterator	cloneIterator()
boolean	isReverse()
int	next() Get the next node in the iteration.
void	reset() Resets the iterator to the last start node.
void	setStartNode(int node) Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Field Detail

END

static final int END

Specifies the end of the iteration, and is the same as DTM.NULL.

See Also:

Constant Field Values

Method Detail

next

int next()

Get the next node in the iteration.

Returns:

The next node handle in the iteration, or END.

reset

void reset()

Resets the iterator to the last start node.

setStartNode

void setStartNode(int node)

Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.

Parameters:

node - Sets the root of the iteration.

isReverse

boolean isReverse()

Returns:

true if this iterator has a reversed axis, else false.

cloneIterator

DTMAxisIterator cloneIterator()

Returns:

a deep copy of this iterator. The clone should not be reset from its current position.