Package net.sf.saxon.tree.linked
Class TreeEnumeration
- java.lang.Object
-
- net.sf.saxon.tree.linked.TreeEnumeration
-
- All Implemented Interfaces:
java.io.Closeable
,java.lang.AutoCloseable
,SequenceIterator
,AxisIterator
,LookaheadIterator
,UnfailingIterator
- Direct Known Subclasses:
AncestorEnumeration
,ChildEnumeration
,FollowingEnumeration
,FollowingSiblingEnumeration
,PrecedingEnumeration
,PrecedingOrAncestorEnumeration
,PrecedingSiblingEnumeration
abstract class TreeEnumeration extends java.lang.Object implements AxisIterator, LookaheadIterator
-
-
Nested Class Summary
-
Nested classes/interfaces inherited from interface net.sf.saxon.om.SequenceIterator
SequenceIterator.Property
-
-
Constructor Summary
Constructors Constructor Description TreeEnumeration(NodeImpl origin, java.util.function.Predicate<? super NodeInfo> nodeTest)
Create an axis enumeration for a given type and name of node, from a given origin node
-
Method Summary
All Methods Instance Methods Abstract Methods Concrete Methods Modifier and Type Method Description protected void
advance()
Advance along the axis until a node is found that matches the required criteriaprotected boolean
conforms(NodeImpl node)
Test whether a node conforms to the node type and name constraints.java.util.EnumSet<SequenceIterator.Property>
getProperties()
Get properties of this iterator, as a bit-significant integer.boolean
hasNext()
Determine whether there are more items to come.NodeInfo
next()
Return the next node in the sequenceprotected abstract void
step()
Advance one step along the axis: the resulting node might not meet the required criteria for inclusion-
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
-
-
-
-
Constructor Detail
-
TreeEnumeration
public TreeEnumeration(NodeImpl origin, java.util.function.Predicate<? super NodeInfo> nodeTest)
Create an axis enumeration for a given type and name of node, from a given origin node- Parameters:
origin
- the node from which the axis originatesnodeTest
- test to be satisfied by the returned nodes, or null if all nodes are to be returned.
-
-
Method Detail
-
conforms
protected boolean conforms(NodeImpl node)
Test whether a node conforms to the node type and name constraints. Note that this returns true if the supplied node is null, this is a way of terminating a loop.- Parameters:
node
- the node to be tested- Returns:
- true if the node matches the requested node type and name
-
advance
protected final void advance()
Advance along the axis until a node is found that matches the required criteria
-
step
protected abstract void step()
Advance one step along the axis: the resulting node might not meet the required criteria for inclusion
-
hasNext
public boolean hasNext()
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.- Specified by:
hasNext
in interfaceLookaheadIterator
- Returns:
- true if there are more items in the sequence
-
next
public final NodeInfo next()
Return the next node in the sequence- Specified by:
next
in interfaceAxisIterator
- Specified by:
next
in interfaceSequenceIterator
- Specified by:
next
in interfaceUnfailingIterator
- Returns:
- the next Item. If there are no more items, return null.
-
getProperties
public java.util.EnumSet<SequenceIterator.Property> getProperties()
Get properties of this iterator, as a bit-significant integer.- Specified by:
getProperties
in 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.
-
-