/usr/share/doc/libjaxen-java/apidocs/org/jaxen/expr/Step.html is in libjaxen-java-doc 1.1.6-3.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<!-- Generated by javadoc -->
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>Step (jaxen 1.1.6 API)</title>
<link rel="stylesheet" type="text/css" href="../../../javadoc-style.css" title="Style">
<script type="text/javascript" src="../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="Step (jaxen 1.1.6 API)";
}
}
catch(err) {
}
//-->
var methods = {"i0":6,"i1":6,"i2":6,"i3":6,"i4":6,"i5":6};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/Step.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-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jaxen/expr/RelationalExpr.html" title="interface in org.jaxen.expr"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/jaxen/expr/TextNodeStep.html" title="interface in org.jaxen.expr"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jaxen/expr/Step.html" target="_top">Frames</a></li>
<li><a href="Step.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.jaxen.expr</div>
<h2 title="Interface Step" class="title">Interface Step</h2>
</div>
<div class="contentContainer">
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt>All Superinterfaces:</dt>
<dd><a href="../../../org/jaxen/expr/Predicated.html" title="interface in org.jaxen.expr">Predicated</a>, java.io.Serializable</dd>
</dl>
<dl>
<dt>All Known Subinterfaces:</dt>
<dd><a href="../../../org/jaxen/expr/AllNodeStep.html" title="interface in org.jaxen.expr">AllNodeStep</a>, <a href="../../../org/jaxen/expr/CommentNodeStep.html" title="interface in org.jaxen.expr">CommentNodeStep</a>, <a href="../../../org/jaxen/expr/NameStep.html" title="interface in org.jaxen.expr">NameStep</a>, <a href="../../../org/jaxen/expr/ProcessingInstructionNodeStep.html" title="interface in org.jaxen.expr">ProcessingInstructionNodeStep</a>, <a href="../../../org/jaxen/expr/TextNodeStep.html" title="interface in org.jaxen.expr">TextNodeStep</a></dd>
</dl>
<dl>
<dt>All Known Implementing Classes:</dt>
<dd><a href="../../../org/jaxen/expr/DefaultAllNodeStep.html" title="class in org.jaxen.expr">DefaultAllNodeStep</a>, <a href="../../../org/jaxen/expr/DefaultCommentNodeStep.html" title="class in org.jaxen.expr">DefaultCommentNodeStep</a>, <a href="../../../org/jaxen/expr/DefaultNameStep.html" title="class in org.jaxen.expr">DefaultNameStep</a>, <a href="../../../org/jaxen/expr/DefaultProcessingInstructionNodeStep.html" title="class in org.jaxen.expr">DefaultProcessingInstructionNodeStep</a>, <a href="../../../org/jaxen/expr/DefaultStep.html" title="class in org.jaxen.expr">DefaultStep</a>, <a href="../../../org/jaxen/expr/DefaultTextNodeStep.html" title="class in org.jaxen.expr">DefaultTextNodeStep</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="typeNameLabel">Step</span>
extends <a href="../../../org/jaxen/expr/Predicated.html" title="interface in org.jaxen.expr">Predicated</a></pre>
<div class="block"><p>Represents a location step in a LocationPath. The node-set selected by
the location step is the node-set that results from generating an initial
node-set from the axis and node-test, and then filtering that node-set by
each of the predicates in turn.</p>
<p>
The initial node-set consists of the nodes having the relationship to the
context node specified by the axis, and having the node type and expanded-name
specified by the node test.</p></div>
</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>java.util.Iterator</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jaxen/expr/Step.html#axisIterator-java.lang.Object-org.jaxen.ContextSupport-">axisIterator</a></span>(java.lang.Object contextNode,
<a href="../../../org/jaxen/ContextSupport.html" title="class in org.jaxen">ContextSupport</a> support)</code>
<div class="block">Get an Iterator for the current axis starting in the given contextNode.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>java.util.List</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jaxen/expr/Step.html#evaluate-org.jaxen.Context-">evaluate</a></span>(<a href="../../../org/jaxen/Context.html" title="class in org.jaxen">Context</a> context)</code>
<div class="block">For each node in the given context calls matches() for every node on the
axis, then filters the result by each of the predicates.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jaxen/expr/Step.html#getAxis--">getAxis</a></span>()</code>
<div class="block">Get an identifier for the current axis.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>java.lang.String</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jaxen/expr/Step.html#getText--">getText</a></span>()</code>
<div class="block">Returns a <code>String</code> containing the XPath expression.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jaxen/expr/Step.html#matches-java.lang.Object-org.jaxen.ContextSupport-">matches</a></span>(java.lang.Object node,
<a href="../../../org/jaxen/ContextSupport.html" title="class in org.jaxen">ContextSupport</a> contextSupport)</code>
<div class="block">Performs the node-test part of evaluating the step for the given node
(which must be on the axis).</div>
</td>
</tr>
<tr id="i5" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../org/jaxen/expr/Step.html#simplify--">simplify</a></span>()</code>
<div class="block">Simplifies the XPath step.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods.inherited.from.class.org.jaxen.expr.Predicated">
<!-- -->
</a>
<h3>Methods inherited from interface org.jaxen.expr.<a href="../../../org/jaxen/expr/Predicated.html" title="interface in org.jaxen.expr">Predicated</a></h3>
<code><a href="../../../org/jaxen/expr/Predicated.html#addPredicate-org.jaxen.expr.Predicate-">addPredicate</a>, <a href="../../../org/jaxen/expr/Predicated.html#getPredicates--">getPredicates</a>, <a href="../../../org/jaxen/expr/Predicated.html#getPredicateSet--">getPredicateSet</a></code></li>
</ul>
</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="matches-java.lang.Object-org.jaxen.ContextSupport-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>matches</h4>
<pre>boolean matches(java.lang.Object node,
<a href="../../../org/jaxen/ContextSupport.html" title="class in org.jaxen">ContextSupport</a> contextSupport)
throws <a href="../../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></pre>
<div class="block">Performs the node-test part of evaluating the step for the given node
(which must be on the axis).</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>true if the node matches this step; false if it doesn't</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></code></dd>
</dl>
</li>
</ul>
<a name="getText--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getText</h4>
<pre>java.lang.String getText()</pre>
<div class="block">Returns a <code>String</code> containing the XPath expression.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the text form of this step</dd>
</dl>
</li>
</ul>
<a name="simplify--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>simplify</h4>
<pre>void simplify()</pre>
<div class="block">Simplifies the XPath step. In practice, this is usually a noop.
Jaxen does not currently perform any simplification.</div>
</li>
</ul>
<a name="getAxis--">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getAxis</h4>
<pre>int getAxis()</pre>
<div class="block">Get an identifier for the current axis.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>the axis identifier</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../org/jaxen/saxpath/Axis.html" title="class in org.jaxen.saxpath"><code>Axis</code></a></dd>
</dl>
</li>
</ul>
<a name="axisIterator-java.lang.Object-org.jaxen.ContextSupport-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>axisIterator</h4>
<pre>java.util.Iterator axisIterator(java.lang.Object contextNode,
<a href="../../../org/jaxen/ContextSupport.html" title="class in org.jaxen">ContextSupport</a> support)
throws <a href="../../../org/jaxen/UnsupportedAxisException.html" title="class in org.jaxen">UnsupportedAxisException</a></pre>
<div class="block">Get an Iterator for the current axis starting in the given contextNode.</div>
<dl>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>contextNode</code> - the node from which to follow this step</dd>
<dd><code>support</code> - the remaining context for the traversal</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an iterator over the nodes along the axis</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/jaxen/UnsupportedAxisException.html" title="class in org.jaxen">UnsupportedAxisException</a></code> - if the navigator does not support this step's axis</dd>
</dl>
</li>
</ul>
<a name="evaluate-org.jaxen.Context-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>evaluate</h4>
<pre>java.util.List evaluate(<a href="../../../org/jaxen/Context.html" title="class in org.jaxen">Context</a> context)
throws <a href="../../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></pre>
<div class="block">For each node in the given context calls matches() for every node on the
axis, then filters the result by each of the predicates.</div>
<dl>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>a list of matching nodes</dd>
<dt><span class="throwsLabel">Throws:</span></dt>
<dd><code><a href="../../../org/jaxen/JaxenException.html" title="class in org.jaxen">JaxenException</a></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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/Step.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-all.html">Index</a></li>
<li><a href="../../../help-doc.html">Help</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../org/jaxen/expr/RelationalExpr.html" title="interface in org.jaxen.expr"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../org/jaxen/expr/TextNodeStep.html" title="interface in org.jaxen.expr"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../index.html?org/jaxen/expr/Step.html" target="_top">Frames</a></li>
<li><a href="Step.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 © 2001–2018 <a href="http://codehaus.org">Codehaus</a>. All rights reserved.</small></p>
</body>
</html>
|