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 and Description | 
|---|---|
| static short | ANY_TYPEThis code does not represent a specific type. | 
| static short | ANY_UNORDERED_NODE_TYPE | 
| static short | BOOLEAN_TYPE | 
| static short | FIRST_ORDERED_NODE_TYPE | 
| static short | NUMBER_TYPE | 
| static short | ORDERED_NODE_ITERATOR_TYPEThe result is a node set as defined by [XPath 1.0] that 
 will be accessed iteratively, which will produce document-ordered 
 nodes. | 
| static short | ORDERED_NODE_SNAPSHOT_TYPE | 
| static short | STRING_TYPE | 
| static short | UNORDERED_NODE_ITERATOR_TYPE | 
| static short | UNORDERED_NODE_SNAPSHOT_TYPE | 
| 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. | 
| 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. | 
| java.lang.String | getStringValue()The value of this string result. | 
| Node | iterateNext()Iterates and returns the next node from the node set or 
  nullif there are no more nodes. | 
| Node | snapshotItem(int index)Returns the  indexth 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
nullif 
 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 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.java.lang.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
nullif 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
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.XPathException - TYPE_ERR: raised if resultType is not 
   UNORDERED_NODE_SNAPSHOT_TYPE or 
   ORDERED_NODE_SNAPSHOT_TYPE.Copyright © 1999-2022 The Apache Software Foundation. All Rights Reserved.