/usr/share/doc/libjdom2-java/api/org/jdom2/xpath/jaxen/JaxenXPathFactory.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 | <!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>JaxenXPathFactory (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="JaxenXPathFactory (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/JaxenXPathFactory.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>Prev Class</li>
<li><a href="../../../../org/jdom2/xpath/jaxen/JDOMXPath.html" title="class in org.jdom2.xpath.jaxen"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jdom2/xpath/jaxen/JaxenXPathFactory.html" target="_top">Frames</a></li>
<li><a href="JaxenXPathFactory.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.jaxen</div>
<h2 title="Class JaxenXPathFactory" class="title">Class JaxenXPathFactory</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li><a href="../../../../org/jdom2/xpath/XPathFactory.html" title="class in org.jdom2.xpath">org.jdom2.xpath.XPathFactory</a></li>
<li>
<ul class="inheritance">
<li>org.jdom2.xpath.jaxen.JaxenXPathFactory</li>
</ul>
</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">JaxenXPathFactory</span>
extends <a href="../../../../org/jdom2/xpath/XPathFactory.html" title="class in org.jdom2.xpath">XPathFactory</a></pre>
<div class="block">This simple Factory creates XPath instances tailored to the Jaxen library.</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/jaxen/JaxenXPathFactory.html#JaxenXPathFactory()">JaxenXPathFactory</a></strong>()</code>
<div class="block">The public default constructor used by the XPathFactory.</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><T> <a href="../../../../org/jdom2/xpath/XPathExpression.html" title="interface in org.jdom2.xpath">XPathExpression</a><T></code></td>
<td class="colLast"><code><strong><a href="../../../../org/jdom2/xpath/jaxen/JaxenXPathFactory.html#compile(java.lang.String, org.jdom2.filter.Filter, java.util.Map, org.jdom2.Namespace...)">compile</a></strong>(java.lang.String expression,
<a href="../../../../org/jdom2/filter/Filter.html" title="interface in org.jdom2.filter">Filter</a><T> filter,
java.util.Map<java.lang.String,java.lang.Object> variables,
<a href="../../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>... namespaces)</code>
<div class="block">Create a Compiled XPathExpression<> instance from this factory.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.jdom2.xpath.XPathFactory">
<!-- -->
</a>
<h3>Methods inherited from class org.jdom2.xpath.<a href="../../../../org/jdom2/xpath/XPathFactory.html" title="class in org.jdom2.xpath">XPathFactory</a></h3>
<code><a href="../../../../org/jdom2/xpath/XPathFactory.html#compile(java.lang.String)">compile</a>, <a href="../../../../org/jdom2/xpath/XPathFactory.html#compile(java.lang.String, org.jdom2.filter.Filter)">compile</a>, <a href="../../../../org/jdom2/xpath/XPathFactory.html#compile(java.lang.String, org.jdom2.filter.Filter, java.util.Map, java.util.Collection)">compile</a>, <a href="../../../../org/jdom2/xpath/XPathFactory.html#instance()">instance</a>, <a href="../../../../org/jdom2/xpath/XPathFactory.html#newInstance(java.lang.String)">newInstance</a></code></li>
</ul>
<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, toString, 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="JaxenXPathFactory()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>JaxenXPathFactory</h4>
<pre>public JaxenXPathFactory()</pre>
<div class="block">The public default constructor used by the XPathFactory.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="compile(java.lang.String, org.jdom2.filter.Filter, java.util.Map, org.jdom2.Namespace...)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>compile</h4>
<pre>public <T> <a href="../../../../org/jdom2/xpath/XPathExpression.html" title="interface in org.jdom2.xpath">XPathExpression</a><T> compile(java.lang.String expression,
<a href="../../../../org/jdom2/filter/Filter.html" title="interface in org.jdom2.filter">Filter</a><T> filter,
java.util.Map<java.lang.String,java.lang.Object> variables,
<a href="../../../../org/jdom2/Namespace.html" title="class in org.jdom2">Namespace</a>... namespaces)</pre>
<div class="block"><strong>Description copied from class: <code><a href="../../../../org/jdom2/xpath/XPathFactory.html#compile(java.lang.String, org.jdom2.filter.Filter, java.util.Map, org.jdom2.Namespace...)">XPathFactory</a></code></strong></div>
<div class="block">Create a Compiled XPathExpression<> instance from this factory. This
is the only abstract method on this class. All other compile and evaluate
methods prepare the data in some way to call this compile method.
<p>
XPathFactory implementations override this method to implement support
for the JDOM/XPath API.
<p>
<h2>Namespace</h2> XPath expressions are always namespace aware, and
expect to be able to resolve prefixes to namespace URIs. In XPath
expressions the prefix "" always resolves to the empty Namespace URI "".
A prefix in an XPath query is expected to resolve to exactly one URI.
Multiple different prefixes in the expression may resolve to the same
URI.
<p>
This compile method ensures that these XPath/Namespace rules are followed
and thus this method will throw IllegalArgumentException if:
<ul>
<li>a namespace has the empty-string prefix but has a non-empty URI.
<li>more than one Namespace has any one prefix.
</ul>
<p>
<h2>Variables</h2>
<p>
Variables are referenced from XPath expressions using a
<code>$varname</code> syntax. The variable name may be a Namespace
qualified variable name of the form <code>$pfx:localname</code>.
Variables <code>$pa:var</code> and <code>$pb:var</code> are the identical
variables if the namespace URI for prefix 'pa' is the same URI as for
prefix 'pb'.
<p>
This compile method expects all variable names to be expressed in a
prefix-qualified format, where all prefixes have to be available in one
of the specified Namespace instances.
<p>
e.g. if you specify a variable name "ns:var" with value "value", you also
need to have some namespace provided with the prefix "ns" such as
<code>Namespace.getNamespace("ns", "http://example.com/nsuri");</code>
<p>
Some XPath libraries allow null variable values (Jaxen), some do not
(native Java). This compile method will silently convert any null
Variable value to an empty string <code>""</code>.
<p>
Variables are provided in the form of a Map where the key is the variable
name and the mapped value is the variable value. If the entire map is
null then the compile Method assumes there are no variables.
<p>
In light of the above, this compile method will throw an
IllegalArgumentException if:
<ul>
<li>a variable name is not a valid XML QName.
<li>The prefix associated with a variable name is not available as a
Namespace.
</ul>
A NullPointerException will be thrown if the map contains a null variable
name</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../org/jdom2/xpath/XPathFactory.html#compile(java.lang.String, org.jdom2.filter.Filter, java.util.Map, org.jdom2.Namespace...)">compile</a></code> in class <code><a href="../../../../org/jdom2/xpath/XPathFactory.html" title="class in org.jdom2.xpath">XPathFactory</a></code></dd>
<dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - The generic type of the results that the XPathExpression will
produce.</dd><dt><span class="strong">Parameters:</span></dt><dd><code>expression</code> - The XPath expression.</dd><dd><code>filter</code> - The Filter that is used to coerce the xpath result data in to the
generic-typed results.</dd><dd><code>variables</code> - Any variable values that may be referenced from the query. A null
value indicates that there are no variables.</dd><dd><code>namespaces</code> - Any namespaces that may be referenced from the query</dd>
<dt><span class="strong">Returns:</span></dt><dd>an XPathExpression<> instance.</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/JaxenXPathFactory.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>Prev Class</li>
<li><a href="../../../../org/jdom2/xpath/jaxen/JDOMXPath.html" title="class in org.jdom2.xpath.jaxen"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/jdom2/xpath/jaxen/JaxenXPathFactory.html" target="_top">Frames</a></li>
<li><a href="JaxenXPathFactory.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>
|