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:

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

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

An AxisIterator that wraps a Java Iterator.

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
java.util.Iterator<? extends B>	getBaseIterator()
NodeWrappingFunction<? super B,NodeInfo>	getNodeWrappingFunction()
boolean	hasNext() Determine whether there are more items to come.
boolean	isIgnorable(B node)
NodeInfo	next() Get the next item in the sequence.
boolean	supportsHasNext() Ask whether the hasNext() method can be called.

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

NodeWrappingAxisIterator

public NodeWrappingAxisIterator(java.util.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 java.util.Iterator<? extends B> getBaseIterator()

getNodeWrappingFunction

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

supportsHasNext

public boolean supportsHasNext()

Description copied from interface: LookaheadIterator

Ask whether the hasNext() method can be called. This method must be called before calling hasNext(), because some iterators implement this interface, but only support look-ahead under particular circumstances (this is usually because they delegate to another iterator)

Specified by:

supportsHasNext in interface LookaheadIterator

Returns:

true if the LookaheadIterator.hasNext() method is available

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 LookaheadIterator.supportsHasNext() is true.

Specified by:

hasNext in interface LookaheadIterator

Returns:

true if there are more items in the sequence

next

public 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.

isIgnorable

public boolean isIgnorable(B node)