Class NamespaceIterator

    • Method Detail

      • makeIterator

        public static AxisIterator makeIterator​(NodeInfo element,
                                                NodeTest test)
        Factory method to create an iterator over the in-scope namespace nodes
        Parameters:
        element - the node whose namespaces are required
        test - used to filter the returned nodes
        Returns:
        an iterator over the namespace nodes that satisfy the test
      • advance

        public void advance()
        Get the next item in the 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
      • next

        public Item next()
        Get the next item in the sequence.
        Specified by:
        next in interface SequenceIterator
        Specified by:
        next in interface UnfailingIterator
        Returns:
        the next Item. If there are no more nodes, return null.
      • current

        public Item current()
        Get the current item in the sequence.
        Specified by:
        current in interface SequenceIterator
        Specified by:
        current in interface UnfailingIterator
        Returns:
        the current item, that is, the item most recently returned by next()
      • position

        public int position()
        Get the current position
        Specified by:
        position in interface SequenceIterator
        Specified by:
        position in interface UnfailingIterator
        Returns:
        the position of the current item (the item most recently returned by next()), starting at 1 for the first node
      • 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.
        Throws:
        java.lang.NullPointerException - if there is no current node
      • 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
      • getInScopeNamespaceCodes

        public static int[] getInScopeNamespaceCodes​(NodeInfo element)
        Get a list of in-scope namespace codes. If an array of namespace codes is needed, without actually constructing the namespace nodes, this factory method can be used directly. The result is an array of integers, each containing a prefix code in the top half and a uri code in the bottom half. Note that calling this method is destructive: the iterator is consumed and cannot be used again.
        Parameters:
        element - the element whose nodes are required
        Returns:
        the list of in scope namespaces