Skip navigation links
com.aspose.html.dom.xpath

Interface IXPathResult


  • @DOMObjectAttribute
 @DOMNameAttribute(name="XPathResult")
public interface IXPathResult

    The XPathResult interface represents the result of the evaluation of an XPath 1.0 expression within the context of a particular node. Since evaluation of an XPath expression can result in various result types, this object makes it possible to discover and manipulate the type and value of the result.

    • Method Detail

      • getResultType

        @DOMNameAttribute(name="resultType")
int getResultType()

        A code representing the type of this result, as defined by the http://www.w3.org/TR/DOM-Level-3-XPath/xpath.html#XPathResult XPathResultType enum.

      • getNumberValue

        @DOMNameAttribute(name="numberValue")
double getNumberValue()

        The value of this number result.

        Throws:
        DOMException - TYPE_ERR: raised if resultType is not Number type.

      • getBooleanValue

        @DOMNameAttribute(name="booleanValue")
boolean getBooleanValue()

        The value of this boolean result.

        Throws:
        DOMException - TYPE_ERR: raised if resultType is not Boolean type.

      • getInvalidIteratorState

        @DOMNameAttribute(name="invalidIteratorState")
boolean getInvalidIteratorState()

        Signifies that the iterator has become invalid. True if resultType is UnorderedNodeIterator type or OrderedNodeIterator type and the document has been modified since this result was returned.

      • getSnapshotLength

        @DOMNameAttribute(name="snapshotLength")
int getSnapshotLength()

        The number of nodes in the result snapshot. Valid values for snapshotItem indices are 0 to snapshotLength-1 inclusive.

        Throws:
        DOMException - TYPE_ERR: raised if resultType is not UnorderedNodeSnapshot type or OrderedNodeSnapshot type.

      • iterateNext

        @DOMNameAttribute(name="iterateNext")
Node iterateNext()

        Iterates and returns the next node from the node set or null if there are no more nodes.

        Returns:
        Returns the next node.
        Throws:
        DOMException - TYPE_ERR: raised if resultType is not UnorderedNodeIterator type or OrderedNodeIterator type.
        DOMException - INVALID_STATE_ERR: The document has been mutated since the result was returned.

      • snapshotItem

        @DOMNameAttribute(name="snapshotItem")
 @DOMNullableAttribute
Node snapshotItem(int index)

        Returns the indexth item in the snapshot collection. If index is greater than or equal to the number of nodes in the list, this method returns null. Unlike the iterator result, the snapshot does not become invalid, but may not correspond to the current document if it is mutated.

        Parameters:
        index - Index into the snapshot collection.
        Returns:
        The node at the indexth position in the NodeList, or null if that is not a valid index.
        Throws:
        DOMException - TYPE_ERR: raised if resultType is not UnorderedNodeSnapshot type or OrderedNodeSnapshot type.