Package net.sf.saxon.tree.tiny

Class AncestorIterator

java.lang.Object

net.sf.saxon.tree.tiny.AncestorIterator

All Implemented Interfaces:

Closeable, AutoCloseable, SequenceIterator, AxisIterator

public final class AncestorIterator
extends Object
implements AxisIterator

This class enumerates the ancestor:: or ancestor-or-self:: axes, starting at a given node. The start node will never be the root.

Constructor Summary

Constructors

Constructor	Description
AncestorIterator(NodeInfo node, NodeTest nodeTest)

Method Summary

Modifier and Type	Method	Description
NodeInfo	next()	Get the next item in the sequence.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface net.sf.saxon.om.SequenceIterator

close

Constructor Details

AncestorIterator

public AncestorIterator(NodeInfo node,
 NodeTest nodeTest)

Method Details

next

public NodeInfo next()

Description copied from interface: SequenceIterator

Get the next item in the sequence. This method changes the state of the iterator.

Specified by:

next in interface AxisIterator

Specified by:

next in interface SequenceIterator

Returns:

the next item, or null if there are no more items. Once a call on next() has returned null, no further calls should be made. The preferred action for an iterator if subsequent calls on next() are made is to return null again, and all implementations within Saxon follow this rule.