akasha

Class XPathResult

java.lang.Object

akasha.core.JsObject

akasha.XPathResult

@Generated(value="org.realityforge.webtack")
 @JsType(isNative=true,
        namespace="<global>",
        name="XPathResult")
public class XPathResult
extends JsObject

The XPathResult interface represents the results generated by evaluating an XPath expression within the context of a given node.

See Also:

XPathResult - MDN, (DOM) # interface-xpathresult

Field Summary

Fields

Modifier and Type	Field and Description
static int	ANY_TYPE
static int	ANY_UNORDERED_NODE_TYPE
static int	BOOLEAN_TYPE
static int	FIRST_ORDERED_NODE_TYPE
static int	NUMBER_TYPE
static int	ORDERED_NODE_ITERATOR_TYPE
static int	ORDERED_NODE_SNAPSHOT_TYPE
static int	STRING_TYPE
static int	UNORDERED_NODE_ITERATOR_TYPE
static int	UNORDERED_NODE_SNAPSHOT_TYPE

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	XPathResult()

Method Summary

Modifier and Type	Method and Description
boolean	booleanValue() The read-only booleanValue property of the XPathResult interface returns the boolean value of a result with XPathResult.resultType being BOOLEAN_TYPE.
boolean	invalidIteratorState() The read-only invalidIteratorState property of the XPathResult interface signifies that the iterator has become invalid.
Node	iterateNext() The iterateNext() method of the XPathResult interface iterates over a node set result and returns the next node from it or null if there are no more nodes.
double	numberValue() The read-only numberValue property of the XPathResult interface returns the numeric value of a result with XPathResult.resultType being NUMBER_TYPE.
int	resultType() The read-only resultType property of the XPathResult interface represents the type of the result, as defined by the type constants.
Node	singleNodeValue() The read-only singleNodeValue property of the XPathResult interface returns a Node value or null in case no node was matched of a result with XPathResult.resultType being ANY_UNORDERED_NODE_TYPE or FIRST_ORDERED_NODE_TYPE.
Node	snapshotItem(int index) The snapshotItem() method of the XPathResult interface returns an item of the snapshot collection or null in case the index is not within the range of nodes.
int	snapshotLength() The read-only snapshotLength property of the XPathResult interface represents the number of nodes in the result snapshot.
java.lang.String	stringValue() The read-only stringValue property of the XPathResult interface returns the string value of a result with XPathResult.resultType being STRING_TYPE.

Methods inherited from class akasha.core.JsObject

assign, create, create, defineProperties, defineProperty, defineProperty, entries, freeze, fromEntries, getOwnPropertyDescriptor, getOwnPropertyDescriptor, getOwnPropertyDescriptors, getOwnPropertyNames, getOwnPropertySymbols, getPrototypeOf, is, isExtensible, isFrozen, isSealed, keys, preventExtensions, seal, setPrototypeOf, valueOf_, values

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

ANY_TYPE

@JsOverlay
public static final int ANY_TYPE

See Also:

Constant Field Values

ANY_UNORDERED_NODE_TYPE

@JsOverlay
public static final int ANY_UNORDERED_NODE_TYPE

See Also:

Constant Field Values

BOOLEAN_TYPE

@JsOverlay
public static final int BOOLEAN_TYPE

See Also:

Constant Field Values

FIRST_ORDERED_NODE_TYPE

@JsOverlay
public static final int FIRST_ORDERED_NODE_TYPE

See Also:

Constant Field Values

NUMBER_TYPE

@JsOverlay
public static final int NUMBER_TYPE

See Also:

Constant Field Values

ORDERED_NODE_ITERATOR_TYPE

@JsOverlay
public static final int ORDERED_NODE_ITERATOR_TYPE

See Also:

Constant Field Values

ORDERED_NODE_SNAPSHOT_TYPE

@JsOverlay
public static final int ORDERED_NODE_SNAPSHOT_TYPE

See Also:

Constant Field Values

STRING_TYPE

@JsOverlay
public static final int STRING_TYPE

See Also:

Constant Field Values

UNORDERED_NODE_ITERATOR_TYPE

@JsOverlay
public static final int UNORDERED_NODE_ITERATOR_TYPE

See Also:

Constant Field Values

UNORDERED_NODE_SNAPSHOT_TYPE

@JsOverlay
public static final int UNORDERED_NODE_SNAPSHOT_TYPE

See Also:

Constant Field Values

Constructor Detail

XPathResult

protected XPathResult()

Method Detail

booleanValue

@JsProperty(name="booleanValue")
public boolean booleanValue()

The read-only booleanValue property of the XPathResult interface returns the boolean value of a result with XPathResult.resultType being BOOLEAN_TYPE.

See Also:

XPathResult.booleanValue - MDN, XPathResult.booleanValue - Document Object Model (DOM) Level 3 XPath Specification

invalidIteratorState

@JsProperty(name="invalidIteratorState")
public boolean invalidIteratorState()

The read-only invalidIteratorState property of the XPathResult interface signifies that the iterator has become invalid. It is true if XPathResult.resultType is UNORDERED_NODE_ITERATOR_TYPE or ORDERED_NODE_ITERATOR_TYPE and the document has been modified since this result was returned.

See Also:

XPathResult.invalidIteratorState - MDN, XPathResult.invalidIteratorState - Document Object Model (DOM) Level 3 XPath Specification

numberValue

@JsProperty(name="numberValue")
public double numberValue()

The read-only numberValue property of the XPathResult interface returns the numeric value of a result with XPathResult.resultType being NUMBER_TYPE.

See Also:

XPathResult.numberValue - MDN, XPathResult.numberValue - Document Object Model (DOM) Level 3 XPath Specification

resultType

@JsProperty(name="resultType")
 @XPathResultResultType
public int resultType()

The read-only resultType property of the XPathResult interface represents the type of the result, as defined by the type constants.

See Also:

XPathResult.resultType - MDN, XPathResult.resultType - Document Object Model (DOM) Level 3 XPath Specification

singleNodeValue

@JsProperty(name="singleNodeValue")
 @Nullable
public Node singleNodeValue()

The read-only singleNodeValue property of the XPathResult interface returns a Node value or null in case no node was matched of a result with XPathResult.resultType being ANY_UNORDERED_NODE_TYPE or FIRST_ORDERED_NODE_TYPE.

See Also:

XPathResult.singleNodeValue - MDN, XPathResult.singleNodeValue - Document Object Model (DOM) Level 3 XPath Specification

snapshotLength

@JsProperty(name="snapshotLength")
public int snapshotLength()

The read-only snapshotLength property of the XPathResult interface represents the number of nodes in the result snapshot.

See Also:

XPathResult.snapshotLength - MDN, XPathResult.snapshotLength - Document Object Model (DOM) Level 3 XPath Specification

stringValue

@JsProperty(name="stringValue")
 @Nonnull
public java.lang.String stringValue()

The read-only stringValue property of the XPathResult interface returns the string value of a result with XPathResult.resultType being STRING_TYPE.

See Also:

XPathResult.stringValue - MDN, XPathResult.stringValue - Document Object Model (DOM) Level 3 XPath Specification

iterateNext

@Nullable
public Node iterateNext()

The iterateNext() method of the XPathResult interface iterates over a node set result and returns the next node from it or null if there are no more nodes.

See Also:

XPathResult.iterateNext - MDN, XPathResult.iterateNext() - Document Object Model (DOM) Level 3 XPath Specification

snapshotItem

@Nullable
public Node snapshotItem(int index)

The snapshotItem() method of the XPathResult interface returns an item of the snapshot collection or null in case the index is not within the range of nodes. Unlike the iterator result, the snapshot does not become invalid, but may not correspond to the current document if it is mutated.

See Also:

XPathResult.snapshotItem - MDN, XPathResult.snapshotItem() - Document Object Model (DOM) Level 3 XPath Specification