Interface AxisIterator<T extends NodeInfo>

    • Method Detail

      • moveNext

        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.
        Returns:
        true if there is a next node, false if the end of the sequence has been reached
      • getAnother

        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 SequenceIterator<T extends NodeInfo>
        Specified by:
        getAnother in interface UnfailingIterator<T extends NodeInfo>
        Returns:
        a new iterator over the same sequence
      • iterateAxis

        AxisIterator iterateAxis​(byte axis,
                                 NodeTest test)
        Return an iterator over an axis, starting at the current node.
        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
        Throws:
        java.lang.NullPointerException - if there is no current node
      • atomize

        Value atomize()
               throws XPathException
        Return the atomized value of the current node.
        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

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