Package com.teamdev.jxbrowser.dom

Interface XPathResult

public interface XPathResult

An implementation of the DOM W3C XPathResult interface that represents the result of the XPath expression evaluation.

See Also:

• Node.evaluate(String)
• Node.evaluate(String, XPathResultType)

Method Summary

Modifier and Type	Method	Description
boolean	asBoolean()	Returns the XPath result represented as a boolean.
double	asNumber()	Returns the XPath result represented as a number.
Optional<Node>	asSingleNode()	Returns an Optional that contains the XPath result represented as a single node or an empty Optional if it does not exist.
List<Node>	asSnapshotNodes()	Returns the XPath result represented as an immutable list of the snapshot nodes.
String	asString()	Returns the XPath result represented as a string.
boolean	isBoolean()	Returns true if the result type is XPathResultType.BOOLEAN.
boolean	isIterator()	Returns true if the result type is XPathResultType.UNORDERED_NODE_ITERATOR or XPathResultType.ORDERED_NODE_ITERATOR.
boolean	isNumber()	Returns true if the result type is XPathResultType.NUMBER.
boolean	isSingleNode()	Returns true if the result type is XPathResultType.FIRST_ORDERED_NODE or XPathResultType.ANY_UNORDERED_NODE.
boolean	isSnapshotNodes()	Returns true if the result type is XPathResultType.ORDERED_NODE_SNAPSHOT or XPathResultType.UNORDERED_NODE_SNAPSHOT.
boolean	isString()	Returns true if the result type is XPathResultType.STRING.
Optional<Node>	iterateNext()	Moves the iterator to the next node in the result set and returns an Optional that contains the Node object referenced by the current iterator.
XPathResultType	type()	Returns the result type.

Method Details

type

XPathResultType type()

Returns the result type.

asNumber

double asNumber()

Returns the XPath result represented as a number.

Throws:

XPathException - if the result is not of a number type (see isNumber())

ObjectClosedException - when the document this instance belongs to is closed

isNumber

boolean isNumber()

Returns true if the result type is XPathResultType.NUMBER.

asString

String asString()

Returns the XPath result represented as a string.

Throws:

XPathException - if the result is not of a string type (see isString())

ObjectClosedException - when the document this instance belongs to is closed

isString

boolean isString()

Returns true if the result type is XPathResultType.STRING.

asBoolean

boolean asBoolean()

Returns the XPath result represented as a boolean.

Throws:

XPathException - if the result is not of a boolean type (see isBoolean())

ObjectClosedException - when the document this instance belongs to is closed

isBoolean

boolean isBoolean()

Returns true if the result type is XPathResultType.BOOLEAN.

asSingleNode

Optional<Node> asSingleNode()

Returns an Optional that contains the XPath result represented as a single node or an empty Optional if it does not exist.

Throws:

XPathException - if the result is not of a single node type (see isSingleNode())

ObjectClosedException - when the document this instance belongs to is closed

isSingleNode

boolean isSingleNode()

Returns true if the result type is XPathResultType.FIRST_ORDERED_NODE or XPathResultType.ANY_UNORDERED_NODE.

iterateNext

Optional<Node> iterateNext()

Moves the iterator to the next node in the result set and returns an Optional that contains the Node object referenced by the current iterator. When iteration is over, returns an empty Optional.

Throws:

XPathException - if the current result is not of an iterator type (see isIterator())

ObjectClosedException - when the document this instance belongs to is closed

isIterator

boolean isIterator()

Returns true if the result type is XPathResultType.UNORDERED_NODE_ITERATOR or XPathResultType.ORDERED_NODE_ITERATOR.

asSnapshotNodes

List<Node> asSnapshotNodes()

Returns the XPath result represented as an immutable list of the snapshot nodes.

Throws:

XPathException - if the current result is not of a list of the snapshot nodes (see isSnapshotNodes())

ObjectClosedException - when the document this instance belongs to is closed

isSnapshotNodes

boolean isSnapshotNodes()

Returns true if the result type is XPathResultType.ORDERED_NODE_SNAPSHOT or XPathResultType.UNORDERED_NODE_SNAPSHOT.