< prev index next >

src/jdk.xml.dom/share/classes/org/w3c/dom/xpath/XPathExpression.java

Print this page




  31  * Copyright (c) 2002 World Wide Web Consortium,
  32  * (Massachusetts Institute of Technology, Institut National de
  33  * Recherche en Informatique et en Automatique, Keio University). All
  34  * Rights Reserved. This program is distributed under the W3C's Software
  35  * Intellectual Property License. This program is distributed in the
  36  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  37  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  38  * PURPOSE.
  39  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  40  */
  41 
  42 package org.w3c.dom.xpath;
  43 
  44 
  45 import org.w3c.dom.Node;
  46 import org.w3c.dom.DOMException;
  47 
  48 /**
  49  * The <code>XPathExpression</code> interface represents a parsed and resolved
  50  * XPath expression.
  51  * <p>See also the <a href='http://www.w3.org/2002/08/WD-DOM-Level-3-XPath-20020820'>Document Object Model (DOM) Level 3 XPath Specification</a>.
  52  */
  53 public interface XPathExpression {
  54     /**
  55      * Evaluates this XPath expression and returns a result.
  56      * @param contextNode The <code>context</code> is context node for the
  57      *   evaluation of this XPath expression.If the XPathEvaluator was
  58      *   obtained by casting the <code>Document</code> then this must be
  59      *   owned by the same document and must be a <code>Document</code>,
  60      *   <code>Element</code>, <code>Attribute</code>, <code>Text</code>,
  61      *   <code>CDATASection</code>, <code>Comment</code>,
  62      *   <code>ProcessingInstruction</code>, or <code>XPathNamespace</code>
  63      *   node.If the context node is a <code>Text</code> or a
  64      *   <code>CDATASection</code>, then the context is interpreted as the
  65      *   whole logical text node as seen by XPath, unless the node is empty
  66      *   in which case it may not serve as the XPath context.
  67      * @param type If a specific <code>type</code> is specified, then the
  68      *   result will be coerced to return the specified type relying on
  69      *   XPath conversions and fail if the desired coercion is not possible.
  70      *   This must be one of the type codes of <code>XPathResult</code>.
  71      * @param result The <code>result</code> specifies a specific result




  31  * Copyright (c) 2002 World Wide Web Consortium,
  32  * (Massachusetts Institute of Technology, Institut National de
  33  * Recherche en Informatique et en Automatique, Keio University). All
  34  * Rights Reserved. This program is distributed under the W3C's Software
  35  * Intellectual Property License. This program is distributed in the
  36  * hope that it will be useful, but WITHOUT ANY WARRANTY; without even
  37  * the implied warranty of MERCHANTABILITY or FITNESS FOR A PARTICULAR
  38  * PURPOSE.
  39  * See W3C License http://www.w3.org/Consortium/Legal/ for more details.
  40  */
  41 
  42 package org.w3c.dom.xpath;
  43 
  44 
  45 import org.w3c.dom.Node;
  46 import org.w3c.dom.DOMException;
  47 
  48 /**
  49  * The <code>XPathExpression</code> interface represents a parsed and resolved
  50  * XPath expression.
  51  * <p>See also the <a href='https://www.w3.org/TR/DOM-Level-3-XPath/'>Document Object Model (DOM) Level 3 XPath Specification</a>.
  52  */
  53 public interface XPathExpression {
  54     /**
  55      * Evaluates this XPath expression and returns a result.
  56      * @param contextNode The <code>context</code> is context node for the
  57      *   evaluation of this XPath expression.If the XPathEvaluator was
  58      *   obtained by casting the <code>Document</code> then this must be
  59      *   owned by the same document and must be a <code>Document</code>,
  60      *   <code>Element</code>, <code>Attribute</code>, <code>Text</code>,
  61      *   <code>CDATASection</code>, <code>Comment</code>,
  62      *   <code>ProcessingInstruction</code>, or <code>XPathNamespace</code>
  63      *   node.If the context node is a <code>Text</code> or a
  64      *   <code>CDATASection</code>, then the context is interpreted as the
  65      *   whole logical text node as seen by XPath, unless the node is empty
  66      *   in which case it may not serve as the XPath context.
  67      * @param type If a specific <code>type</code> is specified, then the
  68      *   result will be coerced to return the specified type relying on
  69      *   XPath conversions and fail if the desired coercion is not possible.
  70      *   This must be one of the type codes of <code>XPathResult</code>.
  71      * @param result The <code>result</code> specifies a specific result


< prev index next >