Interface DTMAxisIterator

    • Field Summary

      Fields 
      Modifier and Type Field Description
      static int END
      Specifies the end of the iteration, and is the same as DTM.NULL.
    • Field Detail

      • END

        static final int END
        Specifies the end of the iteration, and is the same as DTM.NULL.
        See Also:
        Constant Field Values
    • Method Detail

      • next

        int next()
        Get the next node in the iteration.
        Returns:
        The next node handle in the iteration, or END.
      • reset

        void reset()
        Resets the iterator to the last start node.
      • setStartNode

        void setStartNode​(int node)
        Set start to END should 'close' the iterator, i.e. subsequent call to next() should return END.
        Parameters:
        node - Sets the root of the iteration.
      • isReverse

        boolean isReverse()
        Returns:
        true if this iterator has a reversed axis, else false.
      • cloneIterator

        DTMAxisIterator cloneIterator()
        Returns:
        a deep copy of this iterator. The clone should not be reset from its current position.