Navigator.AncestorIterator

java.lang.Object

net.sf.saxon.tree.util.Navigator.AncestorIterator

All Implemented Interfaces:: Closeable, AutoCloseable, SequenceIterator

Enclosing class:: Navigator

public static final class Navigator.AncestorIterator extends Object implements SequenceIterator

General-purpose implementation of the ancestor and ancestor-or-self axes

Constructor Summary

Constructors

Constructor

Description

AncestorIterator(GNode start, boolean includeSelf)

Create an iterator over the ancestor or ancestor-or-self axis
Method Summary

Modifier and Type

Method

Description

final GNode

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(GNode start, boolean includeSelf)
  
  Create an iterator over the ancestor or ancestor-or-self axis
  
  Parameters:
  
  start - the initial context node
  
  includeSelf - true if the "self" node is to be included
Method Details
- next
  
  public final GNode 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 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.