net.sf.saxon.tree.util

Class Navigator.PrecedingEnumeration

java.lang.Object

net.sf.saxon.tree.util.Navigator.PrecedingEnumeration

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, SequenceIterator, AxisIterator

Enclosing class:

Navigator

public static final class Navigator.PrecedingEnumeration
extends java.lang.Object
implements AxisIterator

Helper method to iterate over the preceding axis, or Saxon's internal preceding-or-ancestor axis, by making use of the ancestor, descendant, and preceding-sibling axes.

Constructor Summary

Constructors

Constructor and Description
PrecedingEnumeration(NodeInfo start, boolean includeAncestors) Create an iterator for the preceding or "preceding-or-ancestor" axis (the latter being used internall to support xsl:number)

Method Summary

Modifier and Type	Method and 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, discharge

Constructor Detail

PrecedingEnumeration

public PrecedingEnumeration(NodeInfo start,
                            boolean includeAncestors)

Create an iterator for the preceding or "preceding-or-ancestor" axis (the latter being used internall to support xsl:number)

Parameters:

start - the initial context node

includeAncestors - true if ancestors of the initial context node are to be included in the result

Method Detail

next

public final 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 SequenceIterator

Specified by:

next in interface AxisIterator

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.