net.sf.saxon.tinytree
Class AncestorEnumeration

java.lang.Object
  extended by net.sf.saxon.om.AxisIteratorImpl
      extended by net.sf.saxon.tinytree.AncestorEnumeration
All Implemented Interfaces:
AxisIterator, SequenceIterator, UnfailingIterator

final class AncestorEnumeration
extends AxisIteratorImpl

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


Field Summary
 
Fields inherited from class net.sf.saxon.om.AxisIteratorImpl
current, position
 
Fields inherited from interface net.sf.saxon.om.SequenceIterator
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
 
Constructor Summary
AncestorEnumeration(TinyNodeImpl node, NodeTest nodeTest, boolean includeSelf)
           
 
Method Summary
 SequenceIterator getAnother()
          Get another enumeration of the same nodes
 Item next()
          Get the next item in the sequence.
 
Methods inherited from class net.sf.saxon.om.AxisIteratorImpl
atomize, close, current, getProperties, getStringValue, iterateAxis, moveNext, position
 
Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
 

Constructor Detail

AncestorEnumeration

public AncestorEnumeration(TinyNodeImpl node,
                           NodeTest nodeTest,
                           boolean includeSelf)
Method Detail

next

public Item next()
Description copied from interface: SequenceIterator
Get the next item in the sequence. This method changes the state of the iterator, in particular it affects the result of subsequent calls of position() and current().

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.

getAnother

public SequenceIterator getAnother()
Get another enumeration of the same nodes

Returns:
a SequenceIterator that iterates over the same items, positioned before the first item