Package net.sf.saxon.tree.iter

Class AxisIteratorOverSequence<T extends NodeInfo>

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

    • Constructor Detail

      • AxisIteratorOverSequence

        public AxisIteratorOverSequence​(SequenceIterator<T> base)

    • Method Detail

      • 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 interface AxisIterator<T extends NodeInfo>
        Specified by:
        getAnother in interface SequenceIterator<T extends NodeInfo>
        Specified by:
        getAnother in interface UnfailingIterator<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 interface AxisIterator<T extends NodeInfo>
        Returns:
        true if there is a next node, false if the end of the sequence has been reached

      • 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 interface SequenceIterator<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 interface AxisIterator<T extends NodeInfo>
        Parameters:
        axis - the axis to iterate over, using a constant such as Axis.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 interface AxisIterator<T extends NodeInfo>
        Returns:
        the atomized value.
        Throws:
        java.lang.NullPointerException - if there is no current node
        XPathException - 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 interface AxisIterator<T extends NodeInfo>
        Returns:
        the string value, as an instance of CharSequence.
        Throws:
        java.lang.NullPointerException - if there is no current node