Package net.sf.saxon.tree.iter
Class AxisIteratorOverSequence<T extends NodeInfo>
- java.lang.Object
-
- net.sf.saxon.tree.iter.AxisIteratorOverSequence<T>
-
- All Implemented Interfaces:
SequenceIterator<T>
,AxisIterator<T>
,UnfailingIterator<T>
public class AxisIteratorOverSequence<T extends NodeInfo> extends java.lang.Object implements AxisIterator<T>
This class wraps any SequenceIterator as an AxisIterator. It must only be used if it is known that the underlying SequenceIterator will always return nodes, and will never throw an exception.
-
-
Field Summary
-
Fields inherited from interface net.sf.saxon.om.SequenceIterator
GROUNDED, LAST_POSITION_FINDER, LOOKAHEAD
-
-
Constructor Summary
Constructors Constructor Description AxisIteratorOverSequence(SequenceIterator<T> base)
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description Value
atomize()
Return the atomized value of the current node.void
close()
Close the iterator.T
current()
Get the current node in the sequence.AxisIterator<T>
getAnother()
Get another iterator over the same sequence of items, positioned at the start of the sequence.int
getProperties()
Get properties of this iterator, as a bit-significant integer.java.lang.CharSequence
getStringValue()
Return the string value of the current node.AxisIterator
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.T
next()
Get the next item in the sequence.int
position()
Get the current position
-
-
-
Constructor Detail
-
AxisIteratorOverSequence
public AxisIteratorOverSequence(SequenceIterator<T> base)
-
-
Method Detail
-
next
public T next()
Description copied from interface:UnfailingIterator
Get the next item in the sequence.- Specified by:
next
in interfaceAxisIterator<T extends NodeInfo>
- Specified by:
next
in interfaceSequenceIterator<T extends NodeInfo>
- Specified by:
next
in interfaceUnfailingIterator<T extends NodeInfo>
- Returns:
- the next Item. If there are no more nodes, return null.
-
getAnother
public AxisIterator<T> getAnother()
Description copied from interface:UnfailingIterator
Get another iterator over the same sequence of items, positioned at the start of the sequence. It must be possible to call this method at any time, whether none, some, or all of the items in the original iterator have been read. The method is non-destructive: it does not change the state of the original iterator.- Specified by:
getAnother
in interfaceAxisIterator<T extends NodeInfo>
- Specified by:
getAnother
in interfaceSequenceIterator<T extends NodeInfo>
- Specified by:
getAnother
in interfaceUnfailingIterator<T extends NodeInfo>
- Returns:
- a new iterator over the same sequence
-
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<T extends NodeInfo>
- Returns:
- true if there is a next node, false if the end of the sequence has been reached
-
current
public T current()
Get the current node in the sequence.- Specified by:
current
in interfaceAxisIterator<T extends NodeInfo>
- Specified by:
current
in interfaceSequenceIterator<T extends NodeInfo>
- Specified by:
current
in interfaceUnfailingIterator<T extends NodeInfo>
- 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<T extends NodeInfo>
- Specified by:
position
in interfaceUnfailingIterator<T extends NodeInfo>
- 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<T extends NodeInfo>
-
iterateAxis
public AxisIterator iterateAxis(byte axis, NodeTest test)
Return an iterator over an axis, starting at the current node.- Specified by:
iterateAxis
in interfaceAxisIterator<T extends NodeInfo>
- 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
public Value atomize() throws XPathException
Return the atomized value of the current node.- Specified by:
atomize
in interfaceAxisIterator<T extends NodeInfo>
- Returns:
- the atomized value.
- Throws:
java.lang.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
public java.lang.CharSequence getStringValue()
Return the string value of the current node.- Specified by:
getStringValue
in interfaceAxisIterator<T extends NodeInfo>
- Returns:
- the string value, as an instance of CharSequence.
- Throws:
java.lang.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<T extends NodeInfo>
- 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.
-
-