/usr/share/doc/libjdom2-java/api/org/jdom2/xpath/util/XPathDiagnosticImpl.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 | <!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>XPathDiagnosticImpl (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="XPathDiagnosticImpl (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/XPathDiagnosticImpl.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/util/AbstractXPathCompiled.html" title="class in org.jdom2.xpath.util"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jdom2/xpath/util/XPathDiagnosticImpl.html" target="_top">Frames</a></li>
<li><a href="XPathDiagnosticImpl.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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.util</div>
<h2 title="Class XPathDiagnosticImpl" class="title">Class XPathDiagnosticImpl<T></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.jdom2.xpath.util.XPathDiagnosticImpl<T></li>
</ul>
</li>
</ul>
<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 from the <a href="../../../../org/jdom2/xpath/XPathExpression.html" title="interface in org.jdom2.xpath"><code>XPathExpression</code></a></dd></dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath">XPathDiagnostic</a><T></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">XPathDiagnosticImpl<T></span>
extends java.lang.Object
implements <a href="../../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath">XPathDiagnostic</a><T></pre>
<div class="block">A diagnostic implementation useful for diagnosing problems in XPath results.
<p>
This class tries to make all the data available as part of the internal
structure which may assist people who are stepping-through the code from
a debugging environment.</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">
<!-- ======== CONSTRUCTOR SUMMARY ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_summary">
<!-- -->
</a>
<h3>Constructor Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation">
<caption><span>Constructors</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colOne" scope="col">Constructor and Description</th>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html#XPathDiagnosticImpl(java.lang.Object, org.jdom2.xpath.XPathExpression, java.util.List, boolean)">XPathDiagnosticImpl</a></strong>(java.lang.Object dcontext,
<a href="../../../../org/jdom2/xpath/XPathExpression.html" title="interface in org.jdom2.xpath">XPathExpression</a><<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>> dxpath,
java.util.List<?> inraw,
boolean dfirstonly)</code>
<div class="block">Create a useful Diagnostic instance for tracing XPath query results.</div>
</td>
</tr>
</table>
</li>
</ul>
<!-- ========== 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>java.lang.Object</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html#getContext()">getContext</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<java.lang.Object></code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html#getFilteredResults()">getFilteredResults</a></strong>()</code>
<div class="block">Returns the XPath results which are not returned by the regular evaluate
process.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>java.util.List<java.lang.Object></code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html#getRawResults()">getRawResults</a></strong>()</code>
<div class="block">Returns the XPath results before any were filtered.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>java.util.List<<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html#getResult()">getResult</a></strong>()</code>
<div class="block">Returns the results as they would be returned by the regular evaluate
process (read-only).</div>
</td>
</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/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html#getXPathExpression()">getXPathExpression</a></strong>()</code> </td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html#isFirstOnly()">isFirstOnly</a></strong>()</code>
<div class="block">Indicate whether the query was evaluated as a first-only evaluation.</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/util/XPathDiagnosticImpl.html#toString()">toString</a></strong>()</code> </td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object">
<!-- -->
</a>
<h3>Methods inherited from class java.lang.Object</h3>
<code>clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="XPathDiagnosticImpl(java.lang.Object, org.jdom2.xpath.XPathExpression, java.util.List, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>XPathDiagnosticImpl</h4>
<pre>public XPathDiagnosticImpl(java.lang.Object dcontext,
<a href="../../../../org/jdom2/xpath/XPathExpression.html" title="interface in org.jdom2.xpath">XPathExpression</a><<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>> dxpath,
java.util.List<?> inraw,
boolean dfirstonly)</pre>
<div class="block">Create a useful Diagnostic instance for tracing XPath query results.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>dcontext</code> - The context against which the XPath query was run.</dd><dd><code>dxpath</code> - The <a href="../../../../org/jdom2/xpath/XPathExpression.html" title="interface in org.jdom2.xpath"><code>XPathExpression</code></a> instance which created this diagnostic.</dd><dd><code>inraw</code> - The data as returned from the XPath library.</dd><dd><code>dfirstonly</code> - If the XPath library was allowed to terminate after the first result.</dd></dl>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="getContext()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getContext</h4>
<pre>public java.lang.Object getContext()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html#getContext()">getContext</a></code> in interface <code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath">XPathDiagnostic</a><<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>The context object against which the XPath query was evaluated.</dd></dl>
</li>
</ul>
<a name="getXPathExpression()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getXPathExpression</h4>
<pre>public <a href="../../../../org/jdom2/xpath/XPathExpression.html" title="interface in org.jdom2.xpath">XPathExpression</a><<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>> getXPathExpression()</pre>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html#getXPathExpression()">getXPathExpression</a></code> in interface <code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath">XPathDiagnostic</a><<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the <a href="../../../../org/jdom2/xpath/XPathExpression.html" title="interface in org.jdom2.xpath"><code>XPathExpression</code></a> instance that generated this
diagnostic.</dd></dl>
</li>
</ul>
<a name="getResult()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getResult</h4>
<pre>public java.util.List<<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>> getResult()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html#getResult()">XPathDiagnostic</a></code></strong></div>
<div class="block">Returns the results as they would be returned by the regular evaluate
process (read-only).</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html#getResult()">getResult</a></code> in interface <code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath">XPathDiagnostic</a><<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the regular evaluated results.</dd></dl>
</li>
</ul>
<a name="getFilteredResults()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFilteredResults</h4>
<pre>public java.util.List<java.lang.Object> getFilteredResults()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html#getFilteredResults()">XPathDiagnostic</a></code></strong></div>
<div class="block">Returns the XPath results which are not returned by the regular evaluate
process.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html#getFilteredResults()">getFilteredResults</a></code> in interface <code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath">XPathDiagnostic</a><<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>those results which were returned by the XPath query but were
filtered out by the JDOM Filter.</dd></dl>
</li>
</ul>
<a name="getRawResults()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getRawResults</h4>
<pre>public java.util.List<java.lang.Object> getRawResults()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html#getRawResults()">XPathDiagnostic</a></code></strong></div>
<div class="block">Returns the XPath results before any were filtered.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html#getRawResults()">getRawResults</a></code> in interface <code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath">XPathDiagnostic</a><<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>those results which were returned by the XPath query before any
filtering.</dd></dl>
</li>
</ul>
<a name="isFirstOnly()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isFirstOnly</h4>
<pre>public boolean isFirstOnly()</pre>
<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html#isFirstOnly()">XPathDiagnostic</a></code></strong></div>
<div class="block">Indicate whether the query was evaluated as a first-only evaluation.
XPath libraries are allowed to stop processing the results after the
first result is retrieved if first-only processing is set.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html#isFirstOnly()">isFirstOnly</a></code> in interface <code><a href="../../../../org/jdom2/xpath/XPathDiagnostic.html" title="interface in org.jdom2.xpath">XPathDiagnostic</a><<a href="../../../../org/jdom2/xpath/util/XPathDiagnosticImpl.html" title="type parameter in XPathDiagnosticImpl">T</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>true if the evaluation was a first-only evaluation.</dd></dl>
</li>
</ul>
<a name="toString()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>toString</h4>
<pre>public java.lang.String toString()</pre>
<dl>
<dt><strong>Overrides:</strong></dt>
<dd><code>toString</code> in class <code>java.lang.Object</code></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/XPathDiagnosticImpl.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/util/AbstractXPathCompiled.html" title="class in org.jdom2.xpath.util"><span class="strong">Prev Class</span></a></li>
<li>Next Class</li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jdom2/xpath/util/XPathDiagnosticImpl.html" target="_top">Frames</a></li>
<li><a href="XPathDiagnosticImpl.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><a href="#constructor_summary">Constr</a> | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li><a href="#constructor_detail">Constr</a> | </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>
|