public interface XPathResult
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. See also the Document Object Model (DOM) Level 3 XPath Specification.
Modifier and Type | Field | Description |
---|---|---|
static final short |
ANY_TYPE |
This code does not represent a specific type. |
static final short |
ANY_UNORDERED_NODE_TYPE |
The result is a node set as defined by and will be accessed as a single node, which may be null if the node set is empty. |
static final short |
BOOLEAN_TYPE |
The result is a boolean as defined by . |
static final short |
FIRST_ORDERED_NODE_TYPE |
The result is a node set as defined by and will be accessed as a single node, which may be null if the node set is empty. |
static final short |
NUMBER_TYPE |
The result is a number as defined by . |
static final short |
ORDERED_NODE_ITERATOR_TYPE |
The result is a node set as defined by that will be accessed iteratively, which will produce document-ordered nodes. |
static final short |
ORDERED_NODE_SNAPSHOT_TYPE |
The result is a node set as defined by that will be accessed as a snapshot list of nodes that will be in original document order. |
static final short |
STRING_TYPE |
The result is a string as defined by . |
static final short |
UNORDERED_NODE_ITERATOR_TYPE |
The result is a node set as defined by that will be accessed iteratively, which may not produce nodes in a particular order. |
static final short |
UNORDERED_NODE_SNAPSHOT_TYPE |
The result is a node set as defined by that will be accessed as a snapshot list of nodes that may not be in a particular order. |
Modifier and Type | Method | 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. |
short |
getResultType() |
A code representing the type of this result, as defined by the type constants. |
Node |
getSingleNodeValue() |
The value of this single node result, which may be null . |
int |
getSnapshotLength() |
The number of nodes in the result snapshot. |
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 |
Returns the index th item in the snapshot collection. |
static final short ANY_TYPE
ANY_TYPE
was requested, then UNORDERED_NODE_ITERATOR_TYPE
is always the resulting type. Any other representation of a node set must be explicitly requested.static final short NUMBER_TYPE
static final short STRING_TYPE
static final short BOOLEAN_TYPE
static final short UNORDERED_NODE_ITERATOR_TYPE
ANY_TYPE
is requested.static final short ORDERED_NODE_ITERATOR_TYPE
static final short UNORDERED_NODE_SNAPSHOT_TYPE
static final short ORDERED_NODE_SNAPSHOT_TYPE
static final short ANY_UNORDERED_NODE_TYPE
null
if the node set is empty. Document modification does not invalidate the node, but may mean that the result node no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once any node in the in the resulting set has been found. static final short FIRST_ORDERED_NODE_TYPE
null
if the node set is empty. Document modification does not invalidate the node, but may mean that the result node no longer corresponds to the current document. This is a convenience that permits optimization since the implementation can stop once the first node in document order of the resulting set has been found. short getResultType()
double getNumberValue() throws XPathException
XPathException
- TYPE_ERR: raised if resultType
is not NUMBER_TYPE
.String getStringValue() throws XPathException
XPathException
- TYPE_ERR: raised if resultType
is not STRING_TYPE
.boolean getBooleanValue() throws XPathException
XPathException
- TYPE_ERR: raised if resultType
is not BOOLEAN_TYPE
.Node getSingleNodeValue() throws XPathException
null
.XPathException
- TYPE_ERR: raised if resultType
is not ANY_UNORDERED_NODE_TYPE
or FIRST_ORDERED_NODE_TYPE
.boolean getInvalidIteratorState()
resultType
is UNORDERED_NODE_ITERATOR_TYPE
or ORDERED_NODE_ITERATOR_TYPE
and the document has been modified since this result was returned.int getSnapshotLength() throws XPathException
0
to snapshotLength-1
inclusive.XPathException
- TYPE_ERR: raised if resultType
is not UNORDERED_NODE_SNAPSHOT_TYPE
or ORDERED_NODE_SNAPSHOT_TYPE
.Node iterateNext() throws XPathException, DOMException
null
if there are no more nodes.XPathException
- TYPE_ERR: raised if resultType
is not UNORDERED_NODE_ITERATOR_TYPE
or ORDERED_NODE_ITERATOR_TYPE
.DOMException
- INVALID_STATE_ERR: The document has been mutated since the result was returned.Node snapshotItem(int index) throws XPathException
index
th 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.index
th position in the NodeList
, or null
if that is not a valid index.XPathException
- TYPE_ERR: raised if resultType
is not UNORDERED_NODE_SNAPSHOT_TYPE
or ORDERED_NODE_SNAPSHOT_TYPE
.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/jdk.xml.dom/org/w3c/dom/xpath/XPathResult.html