/usr/share/doc/libjdom2-java/api/org/jdom2/xpath/XPathExpression.html is in libjdom2-java-doc 2.0.6-1.
This file is owned by root:root, with mode 0o644.
The actual contents of the file can be viewed below.
1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93 94 95 96 97 98 99 100 101 102 103 104 105 106 107 108 109 110 111 112 113 114 115 116 117 118 119 120 121 122 123 124 125 126 127 128 129 130 131 132 133 134 135 136 137 138 139 140 141 142 143 144 145 146 147 148 149 150 151 152 153 154 155 156 157 158 159 160 161 162 163 164 165 166 167 168 169 170 171 172 173 174 175 176 177 178 179 180 181 182 183 184 185 186 187 188 189 190 191 192 193 194 195 196 197 198 199 200 201 202 203 204 205 206 207 208 209 210 211 212 213 214 215 216 217 218 219 220 221 222 223 224 225 226 227 228 229 230 231 232 233 234 235 236 237 238 239 240 241 242 243 244 245 246 247 248 249 250 251 252 253 254 255 256 257 258 259 260 261 262 263 264 265 266 267 268 269 270 271 272 273 274 275 276 277 278 279 280 281 282 283 284 285 286 287 288 289 290 291 292 293 294 295 296 297 298 299 300 301 302 303 304 305 306 307 308 309 310 311 312 313 314 315 316 317 318 319 320 321 322 323 324 325 326 327 328 329 330 331 332 333 334 335 336 337 338 339 340 341 342 343 344 345 346 347 348 349 350 351 352 353 354 355 356 357 358 359 360 361 362 363 364 365 366 367 368 369 370 371 372 373 374 375 376 377 378 379 380 381 382 383 384 385 386 387 388 389 390 391 392 393 394 395 396 397 398 399 400 401 402 403 404 405 406 407 408 409 410 411 412 413 414 415 416 417 418 419 420 421 422 423 424 425 426 427 428 429 430 431 432 433 434 435 436 437 438 439 440 441 442 443 444 445 446 447 448 449 450 451 452 453 454 455 456 457 458 459 460 461 462 463 464 465 466 467 468 469 470 471 472 473 474 475 476 477 478 479 480 481 482 483 484 485 486 487 488 489 490 491 492 493 494 495 496 497 498 499 500 501 502 503 504 505 506 507 508 509 510 511 512 513 514 515 516 517 518 519 520 521 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html lang="en">
<head>
<!-- Generated by javadoc (version 1.7.0_55) on Sat May 24 05:15:00 UTC 2014 -->
<title>XPathExpression (JDOM v2.x)</title>
<meta name="date" content="2014-05-24">
<link rel="stylesheet" type="text/css" href="../../../stylesheet.css" title="Style">
</head>
<body>
<script type="text/javascript"><!--
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="XPathExpression (JDOM v2.x)";
}
//-->
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar_top">
<!-- -->
</a><a href="#skip-navbar_top" title="Skip navigation links"></a><a name="navbar_top_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XPathExpression.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>2.x</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/jdom2/xpath/XPathFactory.html" title="class in org.jdom2.xpath"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom2/xpath/XPathExpression.html" target="_top">Frames</a></li>
<li><a href="XPathExpression.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.jdom2.xpath</div>
<h2 title="Interface XPathExpression" class="title">Interface XPathExpression<T></h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The generic type of the results of the XPath query after being
processed by the JDOM <code>Filter<T></code></dd></dl>
<dl>
<dt>All Superinterfaces:</dt>
<dd>java.lang.Cloneable</dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/jdom2/xpath/util/AbstractXPathCompiled.html" title="class in org.jdom2.xpath.util">AbstractXPathCompiled</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">XPathExpression<T></span>
extends java.lang.Cloneable</pre>
<div class="block">XPathExpression is a representation of a compiled XPath query and any
Namespace or variable references the query may require.
<p>
Once an XPathExpression is created, the values associated with variable names
can be changed. But new variables may not be added.
<p>
<p>
XPathExpression is not thread-safe. XPath libraries allow variable values to
change between calls to their query routines, but require that the variable
value is constant for the duration of any particular evaluation. It is easier
to simply have separate XPathExpression instances in each thread than it is
to manage the synchronization of a single instance. XPathExpression thus
supports Cloneable to easily create another XPathExpression instance. It is
the responsibility of the JDOM caller to ensure appropriate synchronisation
of the XPathExpression if it is accessed from multiple threads.</div>
<dl><dt><span class="strong">Author:</span></dt>
<dd>Rolf Lear</dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span>Methods</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/jdom2/xpath/XPathExpression.html" title="interface in org.jdom2.xpath">XPathExpression</a><<a href="../../../org/jdom2/xpath/XPathExpression.html" title="type parameter in XPathExpression">T</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#clone()">clone</a></strong>()</code>
<div class="block">Create a new instance of this XPathExpression that duplicates this
instance.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath">XPathDiagnostic</a><<a href="../../../org/jdom2/xpath/XPathExpression.html" title="type parameter in XPathExpression">T</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#diagnose(java.lang.Object, boolean)">diagnose</a></strong>(java.lang.Object context,
boolean firstonly)</code>
<div class="block">Evaluate the XPath query against the supplied context, but return
additional data which may be useful for diagnosing problems with XPath
queries.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<<a href="../../../org/jdom2/xpath/XPathExpression.html" title="type parameter in XPathExpression">T</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#evaluate(java.lang.Object)">evaluate</a></strong>(java.lang.Object context)</code>
<div class="block">Process the compiled XPathExpression against the specified context.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom2/xpath/XPathExpression.html" title="type parameter in XPathExpression">T</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#evaluateFirst(java.lang.Object)">evaluateFirst</a></strong>(java.lang.Object context)</code>
<div class="block">Return the first value in the XPath query result set type-cast to the
return type of this XPathExpression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#getExpression()">getExpression</a></strong>()</code>
<div class="block">Get the XPath expression</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom2/filter/Filter.html" title="interface in org.jdom2.filter">Filter</a><<a href="../../../org/jdom2/xpath/XPathExpression.html" title="type parameter in XPathExpression">T</a>></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#getFilter()">getFilter</a></strong>()</code>
<div class="block">Get the <code>Filter<T></code> used to coerce the raw XPath results in to
the correct Generic type.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a></code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#getNamespace(java.lang.String)">getNamespace</a></strong>(java.lang.String prefix)</code>
<div class="block">Get the Namespace associated with a given prefix.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>[]</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#getNamespaces()">getNamespaces</a></strong>()</code>
<div class="block">Get the Namespaces that were used to compile this XPathExpression.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#getVariable(java.lang.String)">getVariable</a></strong>(java.lang.String qname)</code>
<div class="block">Get the variable value associated to the given variable qname.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#getVariable(java.lang.String, org.jdom2.Namespace)">getVariable</a></strong>(java.lang.String localname,
<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a> uri)</code>
<div class="block">Get the variable value associated to the given variable name.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#setVariable(java.lang.String, org.jdom2.Namespace, java.lang.Object)">setVariable</a></strong>(java.lang.String localname,
<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a> uri,
java.lang.Object value)</code>
<div class="block">Change the defined value for a variable to some new value.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../org/jdom2/xpath/XPathExpression.html#setVariable(java.lang.String, java.lang.Object)">setVariable</a></strong>(java.lang.String qname,
java.lang.Object value)</code>
<div class="block">Change the defined value for a variable to some new value.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="clone()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clone</h4>
<pre><a href="../../../org/jdom2/xpath/XPathExpression.html" title="interface in org.jdom2.xpath">XPathExpression</a><<a href="../../../org/jdom2/xpath/XPathExpression.html" title="type parameter in XPathExpression">T</a>> clone()</pre>
<div class="block">Create a new instance of this XPathExpression that duplicates this
instance.
<p>
The 'cloned' instance will have the same XPath query, namespace
declarations, and variables. Changing a value associated with a variable
on the cloned instance will not change this instance's values, and it is
safe to run the evaluate methods on the cloned copy at the same time as
this copy.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a new XPathExpression instance that shares the same core details
as this.</dd></dl>
</li>
</ul>
<a name="getExpression()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getExpression</h4>
<pre>java.lang.String getExpression()</pre>
<div class="block">Get the XPath expression</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the string representation of the XPath expression</dd></dl>
</li>
</ul>
<a name="getNamespace(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespace</h4>
<pre><a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a> getNamespace(java.lang.String prefix)</pre>
<div class="block">Get the Namespace associated with a given prefix.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>prefix</code> - The prefix to select the Namespace URI for.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the URI of the specified Namespace prefix</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.IllegalArgumentException</code> - if that prefix is not defined.</dd></dl>
</li>
</ul>
<a name="getNamespaces()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNamespaces</h4>
<pre><a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>[] getNamespaces()</pre>
<div class="block">Get the Namespaces that were used to compile this XPathExpression.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>a potentially empty array of Namespaces (never null).</dd></dl>
</li>
</ul>
<a name="setVariable(java.lang.String, org.jdom2.Namespace, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVariable</h4>
<pre>java.lang.Object setVariable(java.lang.String localname,
<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a> uri,
java.lang.Object value)</pre>
<div class="block">Change the defined value for a variable to some new value. You may not
use this method to add new variables to the compiled XPath, you can only
change existing variable values.
<p>
The value of the variable may be null. Some XPath libraries support a
null value, and if the library that this expression is for does not
support a null value it should be translated to something meaningful for
that library, typically the empty string.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>localname</code> - The variable localname to change.</dd><dd><code>uri</code> - the Namespace in which the variable name is declared.</dd><dd><code>value</code> - The new value to set.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The value of the variable prior to this change.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if name or uri is null</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if name is not already a variable.</dd></dl>
</li>
</ul>
<a name="setVariable(java.lang.String, java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setVariable</h4>
<pre>java.lang.Object setVariable(java.lang.String qname,
java.lang.Object value)</pre>
<div class="block">Change the defined value for a variable to some new value. You may not
use this method to add new variables to the compiled XPath, you can only
change existing variable values.
<p>
The value of the variable may be null. Some XPath libraries support a
null value, and if the library that this expression is for does not
support a null value it should be translated to something meaningful for
that library, typically the empty string.
<p>
qname must consist of an optional namespace prefix and colon, followed
by a mandatory variable localname. If the prefix is not specified, then
the Namespace is assumed to be the <a href="../../../org/jdom2/Namespace.html#NO_NAMESPACE"><code>Namespace.NO_NAMESPACE</code></a>. If
the prefix is specified, it must match with one of the declared
Namespaces for this XPathExpression</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>qname</code> - The variable qname to change.</dd><dd><code>value</code> - The new value to set.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The value of the variable prior to this change.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if qname is null</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if name is not already a variable.</dd></dl>
</li>
</ul>
<a name="getVariable(java.lang.String, org.jdom2.Namespace)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariable</h4>
<pre>java.lang.Object getVariable(java.lang.String localname,
<a href="../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a> uri)</pre>
<div class="block">Get the variable value associated to the given variable name.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>localname</code> - the variable localname to retrieve the value for.</dd><dd><code>uri</code> - the Namespace in which the variable name was declared.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value associated to a Variable name.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if name or uri is null</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if that variable name is not defined.</dd></dl>
</li>
</ul>
<a name="getVariable(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getVariable</h4>
<pre>java.lang.Object getVariable(java.lang.String qname)</pre>
<div class="block">Get the variable value associated to the given variable qname.
<p>
qname must consist of an optional namespace prefix and colon, followed
by a mandatory variable localname. If the prefix is not specified, then
the Namespace is assumed to be the <a href="../../../org/jdom2/Namespace.html#NO_NAMESPACE"><code>Namespace.NO_NAMESPACE</code></a>. If
the prefix is specified, it must match with one of the declared
Namespaces for this XPathExpression</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>qname</code> - the variable qname to retrieve the value for.</dd>
<dt><span class="strong">Returns:</span></dt><dd>the value associated to a Variable name.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if qname is null</dd>
<dd><code>java.lang.IllegalArgumentException</code> - if that variable name is not defined.</dd></dl>
</li>
</ul>
<a name="getFilter()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilter</h4>
<pre><a href="../../../org/jdom2/filter/Filter.html" title="interface in org.jdom2.filter">Filter</a><<a href="../../../org/jdom2/xpath/XPathExpression.html" title="type parameter in XPathExpression">T</a>> getFilter()</pre>
<div class="block">Get the <code>Filter<T></code> used to coerce the raw XPath results in to
the correct Generic type.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the <code>Filter<T></code> used to coerce the raw XPath results in to
the correct Generic type.</dd></dl>
</li>
</ul>
<a name="evaluate(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evaluate</h4>
<pre>java.util.List<<a href="../../../org/jdom2/xpath/XPathExpression.html" title="type parameter in XPathExpression">T</a>> evaluate(java.lang.Object context)</pre>
<div class="block">Process the compiled XPathExpression against the specified context.
<p>
In the JDOM2 XPath API the results of the raw XPath query are processed
by the attached <code>Filter<T></code> instance to coerce the results in to
the correct generic type for this XPathExpression. The Filter process may
cause some XPath results to be removed from the final results. You may
instead want to call the <a href="../../../org/jdom2/xpath/XPathExpression.html#diagnose(java.lang.Object, boolean)"><code>diagnose(Object, boolean)</code></a> method to
have access to both the raw XPath results as well as the filtered and
generically typed results.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - The context against which to process the query.</dd>
<dt><span class="strong">Returns:</span></dt><dd>a list of the XPath results.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the context is null</dd>
<dd><code>java.lang.IllegalStateException</code> - if the expression is not runnable or if the context node is not
appropriate for the expression.</dd></dl>
</li>
</ul>
<a name="evaluateFirst(java.lang.Object)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>evaluateFirst</h4>
<pre><a href="../../../org/jdom2/xpath/XPathExpression.html" title="type parameter in XPathExpression">T</a> evaluateFirst(java.lang.Object context)</pre>
<div class="block">Return the first value in the XPath query result set type-cast to the
return type of this XPathExpression.
<p>
The concept of the 'first' result is applied before any JDOM Filter is
applied. Thus, if the underlying XPath query has some results, the first
result is sent through the filter. If it matches it is returned, if it
does not match, then null is returned (even if some subsequent result
underlying XPath result would pass the filter).
<p>
This allows the XPath implementation to optimise the evaluateFirst method
by potentially using 'short-circuit' conditions in the evaluation.
<p></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - The context against which to evaluate the expression. This will
typically be a Document, Element, or some other JDOM object.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The first XPath result (if there is any) coerced to the generic
type of this XPathExpression, or null if it cannot be coerced.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the context is null</dd>
<dd><code>java.lang.IllegalStateException</code> - if the expression is not runnable or if the context node is not
appropriate for the expression.</dd></dl>
</li>
</ul>
<a name="diagnose(java.lang.Object, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>diagnose</h4>
<pre><a href="../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath">XPathDiagnostic</a><<a href="../../../org/jdom2/xpath/XPathExpression.html" title="type parameter in XPathExpression">T</a>> diagnose(java.lang.Object context,
boolean firstonly)</pre>
<div class="block">Evaluate the XPath query against the supplied context, but return
additional data which may be useful for diagnosing problems with XPath
queries.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>context</code> - The context against which to run the query.</dd><dd><code>firstonly</code> - Indicate whether the XPath expression can be terminated after the
first successful result value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>an <a href="../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath"><code>XPathDiagnostic</code></a> instance.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code>java.lang.NullPointerException</code> - if the context is null</dd>
<dd><code>java.lang.IllegalStateException</code> - if the expression is not runnable or if the context node is not
appropriate for the expression.</dd></dl>
</li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
</div>
<!-- ========= END OF CLASS DATA ========= -->
<!-- ======= START OF BOTTOM NAVBAR ====== -->
<div class="bottomNav"><a name="navbar_bottom">
<!-- -->
</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow">
<!-- -->
</a>
<ul class="navList" title="Navigation">
<li><a href="../../../overview-summary.html">Overview</a></li>
<li><a href="package-summary.html">Package</a></li>
<li class="navBarCell1Rev">Class</li>
<li><a href="class-use/XPathExpression.html">Use</a></li>
<li><a href="package-tree.html">Tree</a></li>
<li><a href="../../../deprecated-list.html">Deprecated</a></li>
<li><a href="../../../index-files/index-1.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
<div class="aboutLanguage"><em><b>JDOM<br><font size='-1'>2.x</font></b></em></div>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../org/jdom2/xpath/XPathFactory.html" title="class in org.jdom2.xpath"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jdom2/xpath/XPathExpression.html" target="_top">Frames</a></li>
<li><a href="XPathExpression.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small>Copyright ? 2014 Jason Hunter, Brett McLaughlin. All Rights Reserved.</small></p>
</body>
</html>
|