OpenJDK 27 · org.w3c.dom.xpath.XPathResult · APIdia, the JavaDoc alternative

Field Summary

Modifier and Type	Field and Description
public static final short	ANY_TYPE This code does not represent a specific type.
public 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.
public static final short	BOOLEAN_TYPE The result is a boolean as defined by .
public 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.
public static final short	NUMBER_TYPE The result is a number as defined by .
public 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.
public 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.
public static final short	STRING_TYPE The result is a string as defined by .
public 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.
public 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.

Method Summary

Modifier and Type	Method and Description
public boolean	getBooleanValue() The value of this boolean result.
public boolean	getInvalidIteratorState() Signifies that the iterator has become invalid.
public double	getNumberValue() The value of this number result.
public short	getResultType() A code representing the type of this result, as defined by the type constants.
public Node	getSingleNodeValue() The value of this single node result, which may be `null`.
public int	getSnapshotLength() The number of nodes in the result snapshot.
public String	getStringValue() The value of this string result.
public Node	Returns: Returns the next node. iterateNext() Iterates and returns the next node from the node set or `null`if there are no more nodes.
public Node	Returns: The node at the `index`th position in the `NodeList`, or `null` if that is not a valid index. snapshotItem(int Index into the snapshot collection. index) Returns the `index`th item in the snapshot collection.

Field Detail

ANY_TYPE back to summary

ANY_TYPE	back to summary
public static final short ANY_TYPE This code does not represent a specific type. An evaluation of an XPath expression will never produce this type. If this type is requested, then the evaluation returns whatever type naturally results from evaluation of the expression. If the natural result is a node set when `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.

public static final short ANY_TYPE

This code does not represent a specific type. An evaluation of an XPath expression will never produce this type. If this type is requested, then the evaluation returns whatever type naturally results from evaluation of the expression.
If the natural result is a node set when 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.

ANY_UNORDERED_NODE_TYPE back to summary

ANY_UNORDERED_NODE_TYPE	back to summary
public 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. 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. If there are more than one node in the actual result, the single node returned might not be the first in document order.

public 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 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 in the resulting set has been found.
If there are more than one node in the actual result, the single node returned might not be the first in document order.

BOOLEAN_TYPE	back to summary
public static final short BOOLEAN_TYPE The result is a boolean as defined by . Document modification does not invalidate the boolean, but may mean that reevaluation would not yield the same boolean.

FIRST_ORDERED_NODE_TYPE back to summary

FIRST_ORDERED_NODE_TYPE	back to summary
public 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. 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. If there are more than one node in the actual result, the single node returned will be the first in document order.

public 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. 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.
If there are more than one node in the actual result, the single node returned will be the first in document order.

NUMBER_TYPE	back to summary
public static final short NUMBER_TYPE The result is a number as defined by . Document modification does not invalidate the number, but may mean that reevaluation would not yield the same number.

ORDERED_NODE_ITERATOR_TYPE	back to summary
public 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. Document modification invalidates the iteration.

ORDERED_NODE_SNAPSHOT_TYPE	back to summary
public 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. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and nodes in the snapshot may have been altered, moved, or removed from the document.

STRING_TYPE	back to summary
public static final short STRING_TYPE The result is a string as defined by . Document modification does not invalidate the string, but may mean that the string no longer corresponds to the current document.

UNORDERED_NODE_ITERATOR_TYPE	back to summary
public 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. Document modification invalidates the iteration. This is the default type returned if the result is a node set and `ANY_TYPE` is requested.

UNORDERED_NODE_SNAPSHOT_TYPE	back to summary
public 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. Document modification does not invalidate the snapshot but may mean that reevaluation would not yield the same snapshot and nodes in the snapshot may have been altered, moved, or removed from the document.

Method Detail

getBooleanValue back to summary

getBooleanValue	back to summary
public boolean getBooleanValue() throws XPathException The value of this boolean result. Exceptions XPathException: TYPE_ERR: raised if `resultType` is not `BOOLEAN_TYPE`.

public boolean getBooleanValue() throws XPathException

The value of this boolean result.

Exceptions

XPathException:: TYPE_ERR: raised if resultType is not BOOLEAN_TYPE.

getInvalidIteratorState	back to summary
public boolean getInvalidIteratorState() Signifies that the iterator has become invalid. True if `resultType` is `UNORDERED_NODE_ITERATOR_TYPE` or `ORDERED_NODE_ITERATOR_TYPE` and the document has been modified since this result was returned.

getNumberValue back to summary

getNumberValue	back to summary
public double getNumberValue() throws XPathException The value of this number result. If the native double type of the DOM binding does not directly support the exact IEEE 754 result of the XPath expression, then it is up to the definition of the binding binding to specify how the XPath number is converted to the native binding number. Exceptions XPathException: TYPE_ERR: raised if `resultType` is not `NUMBER_TYPE`.

public double getNumberValue() throws XPathException

The value of this number result. If the native double type of the DOM binding does not directly support the exact IEEE 754 result of the XPath expression, then it is up to the definition of the binding binding to specify how the XPath number is converted to the native binding number.

Exceptions

XPathException:: TYPE_ERR: raised if resultType is not NUMBER_TYPE.

getResultType	back to summary
public short getResultType() A code representing the type of this result, as defined by the type constants.

getSingleNodeValue back to summary

getSingleNodeValue	back to summary
public Node getSingleNodeValue() throws XPathException The value of this single node result, which may be `null`. Exceptions XPathException: TYPE_ERR: raised if `resultType` is not `ANY_UNORDERED_NODE_TYPE` or `FIRST_ORDERED_NODE_TYPE`.

public Node getSingleNodeValue() throws XPathException

The value of this single node result, which may be null.

Exceptions

XPathException:: TYPE_ERR: raised if resultType is not ANY_UNORDERED_NODE_TYPE or FIRST_ORDERED_NODE_TYPE.

getSnapshotLength back to summary

getSnapshotLength	back to summary
public int getSnapshotLength() throws XPathException The number of nodes in the result snapshot. Valid values for snapshotItem indices are `0` to `snapshotLength-1` inclusive. Exceptions XPathException: TYPE_ERR: raised if `resultType` is not `UNORDERED_NODE_SNAPSHOT_TYPE` or `ORDERED_NODE_SNAPSHOT_TYPE`.

public int getSnapshotLength() throws XPathException

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

Exceptions

XPathException:: TYPE_ERR: raised if resultType is not UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE.

getStringValue back to summary

getStringValue	back to summary
public String getStringValue() throws XPathException The value of this string result. Exceptions XPathException: TYPE_ERR: raised if `resultType` is not `STRING_TYPE`.

public String getStringValue() throws XPathException

The value of this string result.

Exceptions

XPathException:: TYPE_ERR: raised if resultType is not STRING_TYPE.

iterateNext back to summary

iterateNext	back to summary
public Node iterateNext() throws XPathException, DOMException Iterates and returns the next node from the node set or `null`if there are no more nodes. Returns:Node Returns the next node. Exceptions 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.

public Node iterateNext() throws XPathException, DOMException

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

Returns:Node

Returns the next node.

Exceptions

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.

snapshotItem back to summary

snapshotItem	back to summary
public Node snapshotItem(int index) throws XPathException Returns the `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. Parameters index:int Index into the snapshot collection. Returns:Node The node at the `index`th position in the `NodeList`, or `null` if that is not a valid index. Exceptions XPathException: TYPE_ERR: raised if `resultType` is not `UNORDERED_NODE_SNAPSHOT_TYPE` or `ORDERED_NODE_SNAPSHOT_TYPE`.

public Node snapshotItem(int index) throws XPathException

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:int: Index into the snapshot collection.

Returns:Node

The node at the indexth position in the NodeList, or null if that is not a valid index.

Exceptions

XPathException:: TYPE_ERR: raised if resultType is not UNORDERED_NODE_SNAPSHOT_TYPE or ORDERED_NODE_SNAPSHOT_TYPE.

public Interface XPathResult

Field Summary

Method Summary

Field Detail

Method Detail