Class XPathEvaluator

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Cloneable, org.htmlunit.corejs.javascript.ConstProperties, org.htmlunit.corejs.javascript.debug.DebuggableObject, org.htmlunit.corejs.javascript.Scriptable, org.htmlunit.corejs.javascript.SymbolScriptable

    public class XPathEvaluator
    extends HtmlUnitScriptable
    A JavaScript object for XPathEvaluator.
    See Also:
    Serialized Form
    • Nested Class Summary

      • Nested classes/interfaces inherited from class org.htmlunit.corejs.javascript.ScriptableObject

        org.htmlunit.corejs.javascript.ScriptableObject.KeyComparator
    • Field Summary

      • 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 
      Constructor Description
      XPathEvaluator()
      Default constructor.
    • Method Summary

      All Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      XPathNSResolver createNSResolver​(Node nodeResolver)
      Adapts any DOM node to resolve namespaces so that an XPath expression can be easily evaluated relative to the context of the node where it appeared within the document.
      XPathResult evaluate​(java.lang.String expression, java.lang.Object contextNodeObj, java.lang.Object resolver, int type, java.lang.Object result)
      Evaluates an XPath expression string and returns a result of the specified type if possible.
      void jsConstructor()
      JavaScript constructor.
      • 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
      • Methods inherited from class java.lang.Object

        equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
    • Constructor Detail

      • XPathEvaluator

        public XPathEvaluator()
        Default constructor.
    • Method Detail

      • jsConstructor

        public void jsConstructor()
        JavaScript constructor.
      • createNSResolver

        public XPathNSResolver createNSResolver​(Node nodeResolver)
        Adapts any DOM node to resolve namespaces so that an XPath expression can be easily evaluated relative to the context of the node where it appeared within the document.
        Parameters:
        nodeResolver - the node to be used as a context for namespace resolution
        Returns:
        an XPathNSResolver which resolves namespaces with respect to the definitions in scope for a specified node
      • evaluate

        public XPathResult evaluate​(java.lang.String expression,
                                    java.lang.Object contextNodeObj,
                                    java.lang.Object resolver,
                                    int type,
                                    java.lang.Object result)
        Evaluates an XPath expression string and returns a result of the specified type if possible.
        Parameters:
        expression - the XPath expression string to be parsed and evaluated
        contextNodeObj - the context node for the evaluation of this XPath expression
        resolver - the resolver permits translation of all prefixes, including the XML namespace prefix, within the XPath expression into appropriate namespace URIs.
        type - If a specific type is specified, then the result will be returned as the corresponding type
        result - the result object which may be reused and returned by this method
        Returns:
        the result of the evaluation of the XPath expression