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
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 -
Constructor Summary
ConstructorsConstructorDescriptionNodeWrappingAxisIterator(Iterator<? extends B> base, NodeWrappingFunction<? super B, NodeInfo> wrappingFunction) Create a SequenceIterator over a given iterator -
Method Summary
Modifier and TypeMethodDescriptionNodeWrappingFunction<? super B, NodeInfo> Get properties of this iterator, as a bit-significant integer.booleanhasNext()Determine whether there are more items to come.booleanisIgnorable(B node) 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, waitMethods inherited from interface net.sf.saxon.tree.iter.AxisIterator
asIterator, forEachNodeMethods inherited from interface net.sf.saxon.om.SequenceIterator
close, forEachOrFail, materializeMethods inherited from interface net.sf.saxon.tree.iter.UnfailingIterator
forEach, toList
-
Field Details
-
base
-
-
Constructor Details
-
NodeWrappingAxisIterator
public NodeWrappingAxisIterator(Iterator<? extends B> base, NodeWrappingFunction<? super B, NodeInfo> wrappingFunction) Create a SequenceIterator over a given iterator- Parameters:
base- the base IteratorwrappingFunction- a function that wraps objects of type B in a Saxon NodeInfo
-
-
Method Details
-
getBaseIterator
-
getNodeWrappingFunction
-
hasNext
public boolean hasNext()Description copied from interface:LookaheadIteratorDetermine 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:
hasNextin interfaceLookaheadIterator- Returns:
- true if there are more items in the sequence
-
next
Description copied from interface:UnfailingIteratorGet the next item in the sequence.- Specified by:
nextin interfaceAxisIterator- Specified by:
nextin interfaceSequenceIterator- Specified by:
nextin interfaceUnfailingIterator- Returns:
- the next Item. If there are no more items, return null.
-
isIgnorable
-
getProperties
Get properties of this iterator, as a bit-significant integer.- Specified by:
getPropertiesin interfaceSequenceIterator- Returns:
- the properties of this iterator. This will be some combination of
properties such as
SequenceIterator.Property.GROUNDED,SequenceIterator.Property.LAST_POSITION_FINDER, andSequenceIterator.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.
-