com.puppycrawl.tools.checkstyle.xpath.iterators

Class DescendantIterator

java.lang.Object

com.puppycrawl.tools.checkstyle.xpath.iterators.DescendantIterator

All Implemented Interfaces:

java.io.Closeable, java.lang.AutoCloseable, net.sf.saxon.om.SequenceIterator, net.sf.saxon.tree.iter.AxisIterator, net.sf.saxon.tree.iter.UnfailingIterator

public class DescendantIterator
extends java.lang.Object
implements net.sf.saxon.tree.iter.AxisIterator

Recursive-free implementation of the descendant axis iterator.

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	DescendantIterator.StartWith Enum defines starting node for iterator.

Nested classes/interfaces inherited from interface net.sf.saxon.om.SequenceIterator

net.sf.saxon.om.SequenceIterator.Property

Field Summary

Fields

Modifier and Type	Field and Description
private net.sf.saxon.tree.iter.AxisIterator	descendantEnum Descendant axis iterator.
private java.util.Queue<net.sf.saxon.om.NodeInfo>	queue Queue for sibling nodes.

Constructor Summary

Constructors

Constructor and Description
DescendantIterator(net.sf.saxon.om.NodeInfo start, DescendantIterator.StartWith startWith) Create an iterator over the "descendant" axis.

Method Summary

Modifier and Type	Method and Description
net.sf.saxon.om.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.tree.iter.AxisIterator

asIterator, forEachNode

Methods inherited from interface net.sf.saxon.tree.iter.UnfailingIterator

forEach, toList

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

close, forEachOrFail, getProperties, materialize

Field Detail

queue

private final java.util.Queue<net.sf.saxon.om.NodeInfo> queue

Queue for sibling nodes.

descendantEnum

private net.sf.saxon.tree.iter.AxisIterator descendantEnum

Descendant axis iterator.

Constructor Detail

DescendantIterator

public DescendantIterator(net.sf.saxon.om.NodeInfo start,
                          DescendantIterator.StartWith startWith)

Create an iterator over the "descendant" axis.

Parameters:

start - the initial context node.

startWith - mode of the iterator, see DescendantIterator.StartWith.

Method Detail

next

public net.sf.saxon.om.NodeInfo next()

Get the next item in the sequence.

Specified by:

next in interface net.sf.saxon.om.SequenceIterator

Specified by:

next in interface net.sf.saxon.tree.iter.AxisIterator

Specified by:

next in interface net.sf.saxon.tree.iter.UnfailingIterator

Returns:

the next Item. If there are no more nodes, return null.