@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.
| Modifier and Type | Method and Description |
|---|---|
boolean |
getBooleanValue()
The value of this boolean result.
|
boolean |
getInvalidIteratorState()
Signifies that the iterator has become invalid.
|
double |
getNumberValue()
The value of this number result.
|
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. |
Node |
getSingleNodeValue()
The value of this single node result, which may be
null. |
int |
getSnapshotLength()
The number of nodes in the result snapshot.
|
java.lang.String |
getStringValue()
The value of this string result.
|
Node |
iterateNext()
Iterates and returns the next node from the node set or
null if there are no more nodes. |
Node |
snapshotItem(int index)
Returns the
indexth item in the snapshot collection. |
@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.
@DOMNameAttribute(name="numberValue") double getNumberValue()
The value of this number result.
DOMException - TYPE_ERR: raised if resultType is not
Number type.@DOMNameAttribute(name="stringValue") java.lang.String getStringValue()
The value of this string result.
DOMException - TYPE_ERR: raised if resultType is not
String type.@DOMNameAttribute(name="booleanValue") boolean getBooleanValue()
The value of this boolean result.
DOMException - TYPE_ERR: raised if resultType is not
Boolean type.@DOMNameAttribute(name="singleNodeValue") @DOMNullableAttribute Node getSingleNodeValue()
The value of this single node result, which may be null.
DOMException - TYPE_ERR: raised if resultType is not
AnyUnorderedNode type or FirstOrderedNode type.@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.
@DOMNameAttribute(name="snapshotLength") int getSnapshotLength()
The number of nodes in the result snapshot. Valid values for snapshotItem
indices are 0 to snapshotLength-1 inclusive.
DOMException - TYPE_ERR: raised if resultType is not
UnorderedNodeSnapshot type or OrderedNodeSnapshot type.@DOMNameAttribute(name="iterateNext") Node iterateNext()
Iterates and returns the next node from the node set or null if there are no more nodes.
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.@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.
index - Index into the snapshot collection.indexth position in the NodeList, or null if
that is not a valid index.DOMException - TYPE_ERR: raised if resultType is not
UnorderedNodeSnapshot type or OrderedNodeSnapshot type.