Package org.htmlunit.javascript.host.dom
Class XPathResult
java.lang.Object
org.htmlunit.corejs.javascript.ScriptableObject
org.htmlunit.javascript.HtmlUnitScriptable
org.htmlunit.javascript.host.dom.XPathResult
- All Implemented Interfaces:
Serializable
,Cloneable
,org.htmlunit.corejs.javascript.ConstProperties
,org.htmlunit.corejs.javascript.debug.DebuggableObject
,org.htmlunit.corejs.javascript.Scriptable
,org.htmlunit.corejs.javascript.SymbolScriptable
A JavaScript object for
XPathResult
.- See Also:
-
Nested Class Summary
Nested classes/interfaces inherited from class org.htmlunit.corejs.javascript.ScriptableObject
org.htmlunit.corejs.javascript.ScriptableObject.KeyComparator
-
Field Summary
FieldsModifier and TypeFieldDescriptionstatic final int
This code does not represent a specific type.static final int
The result is a node set and will be accessed as a single node, which may be null if the node set is empty.static final int
The result is a boolean.static final int
The result is a node set and will be accessed as a single node, which may be null if the node set is empty.private int
The index of the next result.static final int
The result is a number.static final int
The result is a node set that will be accessed iteratively, which will produce document-ordered nodes.static final int
The result is a node set that will be accessed as a snapshot list of nodes that will be in original document order.private List
<?> private int
static final int
The result is a string.static final int
The result is a node set that will be accessed iteratively, which may not produce nodes in a particular order.static final int
The result is a node set that will be accessed as a snapshot list of nodes that may not be in a particular order.Fields inherited from class org.htmlunit.corejs.javascript.ScriptableObject
CONST, DONTENUM, EMPTY, PERMANENT, READONLY, UNINITIALIZED_CONST
Fields inherited from interface org.htmlunit.corejs.javascript.Scriptable
NOT_FOUND
-
Constructor Summary
Constructors -
Method Summary
Modifier and TypeMethodDescriptionprivate String
asString()
boolean
Returns the value of this boolean result.boolean
double
Returns the value of this number result.int
The code representing the type of this result, as defined by the type constants.The value of this single node result, which may be null.int
The number of nodes in the result snapshot.Returns the value of this string result.(package private) void
Iterates and returns the next node from the node set ornull
if there are no more nodes.void
Creates an instance.snapshotItem
(int index) Returns the indexth item in the snapshot collection.Methods inherited from class org.htmlunit.javascript.HtmlUnitScriptable
clone, equivalentValues, get, getBrowserVersion, getClassName, getDefaultValue, getDomNodeOrDie, getDomNodeOrNull, getPrototype, getScriptableFor, getStartingScope, getWindow, getWindow, getWithPreemption, has, hasInstance, initParentScope, makeScriptableFor, put, setClassName, setDomNode, setDomNode, setParentScope, setupPromise, setupRejectedPromise
Methods inherited from class org.htmlunit.corejs.javascript.ScriptableObject
applyDescriptorToAttributeBitset, associateValue, avoidObjectDetection, buildDataDescriptor, callMethod, callMethod, checkPropertyChange, checkPropertyDefinition, defineClass, defineClass, defineClass, defineConst, defineConstProperty, defineFunctionProperties, defineOwnProperties, defineOwnProperty, defineOwnProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, defineProperty, delete, delete, delete, deleteProperty, deleteProperty, deleteProperty, ensureScriptable, ensureScriptableObject, ensureSymbolScriptable, get, get, get, getAllIds, getArrayPrototype, getAssociatedValue, getAttributes, getAttributes, getAttributes, getAttributes, getAttributes, getClassPrototype, getDefaultValue, getExternalArrayData, getExternalArrayLength, getFunctionPrototype, getGeneratorFunctionPrototype, getGetterOrSetter, getGetterOrSetter, getIds, getObjectPrototype, getOwnPropertyDescriptor, getParentScope, getProperty, getProperty, getProperty, getPropertyIds, getPrototype, getTopLevelScope, getTopScopeValue, getTypedProperty, getTypedProperty, getTypeOf, has, has, hasProperty, hasProperty, hasProperty, isAccessorDescriptor, isConst, isDataDescriptor, isEmpty, isExtensible, isFalse, isGenericDescriptor, isGetterOrSetter, isSealed, isTrue, preventExtensions, put, put, putConst, putConstProperty, putProperty, putProperty, putProperty, querySlot, redefineProperty, sameValue, sealObject, setAttributes, setAttributes, setAttributes, setAttributes, setAttributes, setCommonDescriptorProperties, setExternalArrayData, setGetterOrSetter, setPrototype, size
-
Field Details
-
ANY_TYPE
public static final int ANY_TYPEThis 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.- See Also:
-
NUMBER_TYPE
public static final int NUMBER_TYPEThe result is a number.- See Also:
-
STRING_TYPE
public static final int STRING_TYPEThe result is a string.- See Also:
-
BOOLEAN_TYPE
public static final int BOOLEAN_TYPEThe result is a boolean.- See Also:
-
UNORDERED_NODE_ITERATOR_TYPE
public static final int UNORDERED_NODE_ITERATOR_TYPEThe result is a node set that will be accessed iteratively, which may not produce nodes in a particular order. This is the default type returned if the result is a node set andANY_TYPE
is requested.- See Also:
-
ORDERED_NODE_ITERATOR_TYPE
public static final int ORDERED_NODE_ITERATOR_TYPEThe result is a node set that will be accessed iteratively, which will produce document-ordered nodes.- See Also:
-
UNORDERED_NODE_SNAPSHOT_TYPE
public static final int UNORDERED_NODE_SNAPSHOT_TYPEThe result is a node set that will be accessed as a snapshot list of nodes that may not be in a particular order.- See Also:
-
ORDERED_NODE_SNAPSHOT_TYPE
public static final int ORDERED_NODE_SNAPSHOT_TYPEThe result is a node set that will be accessed as a snapshot list of nodes that will be in original document order.- See Also:
-
ANY_UNORDERED_NODE_TYPE
public static final int ANY_UNORDERED_NODE_TYPEThe result is a node set and will be accessed as a single node, which may be null if the node set is empty. If there is more than one node in the actual result, the single node returned might not be the first in document order.- See Also:
-
FIRST_ORDERED_NODE_TYPE
public static final int FIRST_ORDERED_NODE_TYPEThe result is a node set and will be accessed as a single node, which may be null if the node set is empty. If there are more than one node in the actual result, the single node returned will be the first in document order.- See Also:
-
result_
-
resultType_
private int resultType_ -
iteratorIndex_
private int iteratorIndex_The index of the next result.
-
-
Constructor Details
-
XPathResult
public XPathResult()Creates an instance.
-
-
Method Details
-
jsConstructor
public void jsConstructor()Creates an instance. -
init
- Parameters:
result
- the evaluation resulttype
- If a specific type is specified, then the result will be returned as the corresponding type
-
getResultType
public int getResultType()The code representing the type of this result, as defined by the type constants.- Returns:
- the code representing the type of this result
-
getSnapshotLength
public int getSnapshotLength()The number of nodes in the result snapshot.- Returns:
- the number of nodes in the result snapshot
-
getSingleNodeValue
The value of this single node result, which may be null.- Returns:
- the value of this single node result, which may be null
-
getInvalidIteratorState
public boolean getInvalidIteratorState()- Returns:
- 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.
-
iterateNext
Iterates and returns the next node from the node set ornull
if there are no more nodes.- Returns:
- the next node
-
snapshotItem
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.- Parameters:
index
- Index into the snapshot collection- Returns:
- the node at the indexth position in the NodeList, or null if that is not a valid index
-
getNumberValue
public double getNumberValue()Returns the value of this number result.- Returns:
- the value of this number result
-
getBooleanValue
public boolean getBooleanValue()Returns the value of this boolean result.- Returns:
- the value of this boolean result
-
getStringValue
Returns the value of this string result.- Returns:
- the value of this string result
-
asString
-