Package net.sf.saxon.tree.iter
Class AxisIteratorImpl
java.lang.Object
net.sf.saxon.tree.iter.AxisIteratorImpl
- All Implemented Interfaces:
SequenceIterator
,AxisIterator
,UnfailingIterator
- Direct Known Subclasses:
AncestorEnumeration
,AttributeEnumeration
,AttributeEnumeration
,DescendantEnumeration
,FollowingEnumeration
,Navigator.AxisFilter
,Navigator.BaseEnumeration
,Navigator.EmptyTextFilter
,PrecedingEnumeration
,PrecedingSiblingEnumeration
,SiblingEnumeration
A SequenceIterator is used to iterate over a sequence. An AxisIterator
is a SequenceIterator that always iterates over a set of nodes, and that
throws no exceptions; it also supports the ability
to find the last() position, again with no exceptions.
This class is an abstract implementation of AxisIterator that is used
as a base class for many concrete implementations. The main functionality
that it provides is maintaining the current position.
-
Field Summary
FieldsFields inherited from interface net.sf.saxon.om.SequenceIterator
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionatomize()
Return the atomized value of the current node.void
close()
Close the iterator.current()
Get the current node in the sequence.int
Get properties of this iterator, as a bit-significant integer.Return the string value of the current node.iterateAxis
(byte axis, NodeTest test) Return an iterator over an axis, starting at the current node.boolean
moveNext()
Move to the next node, without returning it.final int
position()
Get the current positionMethods 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
getAnother, next
-
Field Details
-
position
protected int position -
current
-
-
Constructor Details
-
AxisIteratorImpl
public AxisIteratorImpl()
-
-
Method Details
-
moveNext
public boolean moveNext()Move to the next node, without returning it. Returns true if there is a next node, false if the end of the sequence has been reached. After calling this method, the current node may be retrieved using the current() function.- Specified by:
moveNext
in interfaceAxisIterator
- Returns:
- true if there is a next node, false if the end of the sequence has been reached
-
current
Get the current node in the sequence.- Specified by:
current
in interfaceAxisIterator
- Specified by:
current
in interfaceSequenceIterator
- Specified by:
current
in interfaceUnfailingIterator
- Returns:
- the node returned by the most recent call on next()
-
position
public final int position()Get the current position- Specified by:
position
in interfaceSequenceIterator
- Specified by:
position
in interfaceUnfailingIterator
- Returns:
- the position of the most recent node returned by next()
-
close
public void close()Description copied from interface:SequenceIterator
Close the iterator. This indicates to the supplier of the data that the client does not require any more items to be delivered by the iterator. This may enable the supplier to release resources. After calling close(), no further calls on the iterator should be made; if further calls are made, the effect of such calls is undefined.(Currently, closing an iterator is important only when the data is being "pushed" in another thread. Closing the iterator terminates that thread and means that it needs to do no additional work. Indeed, failing to close the iterator may cause the push thread to hang waiting for the buffer to be emptied.)
- Specified by:
close
in interfaceSequenceIterator
-
iterateAxis
Return an iterator over an axis, starting at the current node.- Specified by:
iterateAxis
in interfaceAxisIterator
- Parameters:
axis
- the axis to iterate over, using a constant such asAxis.CHILD
test
- a predicate to apply to the nodes before returning them.- Returns:
- an iterator over an axis, starting at the current node
-
atomize
Return the atomized value of the current node.- Specified by:
atomize
in interfaceAxisIterator
- Returns:
- the atomized value.
- Throws:
NullPointerException
- if there is no current nodeXPathException
- if the current node cannot be atomized, for example because it is an element node with element-only content.
-
getStringValue
Return the string value of the current node.- Specified by:
getStringValue
in interfaceAxisIterator
- Returns:
- the string value, as an instance of CharSequence.
- Throws:
NullPointerException
- if there is no current node
-
getProperties
public int 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.GROUNDED
,SequenceIterator.LAST_POSITION_FINDER
, andSequenceIterator.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.
-