Package net.sf.saxon.tree.iter

Class NodeWrappingAxisIterator<B>

java.lang.Object

net.sf.saxon.tree.iter.NodeWrappingAxisIterator<B>

Type Parameters:

B - the class of the external nodes being wrapped.

All Implemented Interfaces:

Closeable, AutoCloseable, SequenceIterator, AxisIterator, LookaheadIterator, UnfailingIterator

public class NodeWrappingAxisIterator<B>
extends Object
implements AxisIterator, LookaheadIterator

An AxisIterator that wraps a Java Iterator.

Nested Class Summary

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

SequenceIterator.Property

Field Summary

Fields

Modifier and Type	Field	Description
(package private) Iterator<? extends B>	base

Constructor Summary

Constructors

Constructor	Description
NodeWrappingAxisIterator(Iterator<? extends B> base, NodeWrappingFunction<? super B,NodeInfo> wrappingFunction)	Create a SequenceIterator over a given iterator

Method Summary

Modifier and Type	Method	Description
Iterator<? extends B>	getBaseIterator()
NodeWrappingFunction<? super B,NodeInfo>	getNodeWrappingFunction()
EnumSet<SequenceIterator.Property>	getProperties()	Get properties of this iterator, as a bit-significant integer.
boolean	hasNext()	Determine whether there are more items to come.
boolean	isIgnorable(B node)
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.om.SequenceIterator

close, forEachOrFail, materialize

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

forEach, toList

Field Detail

base

Iterator<? extends B> base

Constructor Detail

NodeWrappingAxisIterator

public NodeWrappingAxisIterator(Iterator<? extends B> base,
                                NodeWrappingFunction<? super B,NodeInfo> wrappingFunction)

Create a SequenceIterator over a given iterator

Parameters:

base - the base Iterator

wrappingFunction - a function that wraps objects of type B in a Saxon NodeInfo

Method Detail

getBaseIterator

public Iterator<? extends B> getBaseIterator()

getNodeWrappingFunction

public NodeWrappingFunction<? super B,NodeInfo> getNodeWrappingFunction()

hasNext

public boolean hasNext()

Description copied from interface: LookaheadIterator

Determine whether there are more items to come. Note that this operation is stateless and it is not necessary (or usual) to call it before calling next(). It is used only when there is an explicit need to tell if we are at the last element.

This method must not be called unless the result of getProperties() on the iterator includes the property SequenceIterator.Property.LOOKAHEAD

Specified by:

hasNext in interface LookaheadIterator

Returns:

true if there are more items in the sequence

next

public NodeInfo next()

Description copied from interface: UnfailingIterator

Get the next item in the sequence.

Specified by:

next in interface AxisIterator

Specified by:

next in interface SequenceIterator

Specified by:

next in interface UnfailingIterator

Returns:

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

isIgnorable

public boolean isIgnorable(B node)

getProperties

public EnumSet<SequenceIterator.Property> getProperties()

Get properties of this iterator, as a bit-significant integer.

Specified by:

getProperties in interface SequenceIterator

Returns:

the properties of this iterator. This will be some combination of properties such as SequenceIterator.Property.GROUNDED, SequenceIterator.Property.LAST_POSITION_FINDER, and SequenceIterator.Property.LOOKAHEAD. It is always acceptable to return the value zero, indicating that there are no known special properties. It is acceptable for the properties of the iterator to change depending on its state.