Class AxisIteratorImpl

  • All Implemented Interfaces:
    AxisIterator, SequenceIterator, UnfailingIterator
    Direct Known Subclasses:
    Navigator.AxisFilter, Navigator.BaseEnumeration

    public abstract class AxisIteratorImpl
    extends java.lang.Object
    implements AxisIterator
    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 Detail

      • position

        protected int position
    • Constructor Detail

      • AxisIteratorImpl

        public AxisIteratorImpl()
    • Method Detail

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

        public Value atomize()
                      throws XPathException
        Return the atomized value of the current node.
        Specified by:
        atomize in interface AxisIterator
        Returns:
        the atomized value.
        Throws:
        java.lang.NullPointerException - if there is no current node
        XPathException
      • getStringValue

        public java.lang.CharSequence getStringValue()
        Return the string value of the current node.
        Specified by:
        getStringValue in interface AxisIterator
        Returns:
        the string value, as an instance of CharSequence.
        Throws:
        java.lang.NullPointerException - if there is no current node