/usr/share/doc/libcommons-discovery-java/api/org/apache/commons/discovery/resource/ClassLoaders.html is in libcommons-discovery-java-doc 0.5-3ubuntu1.
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 | <!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_03) on Mon May 28 16:30:15 UTC 2012 -->
<title>ClassLoaders (Commons Discovery (Version 0.5-SNAPSHOT))</title>
<meta name="date" content="2012-05-28">
<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="ClassLoaders (Commons Discovery (Version 0.5-SNAPSHOT))";
}
//-->
</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="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>Prev Class</li>
<li><a href="../../../../../org/apache/commons/discovery/resource/DiscoverResources.html" title="class in org.apache.commons.discovery.resource"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/discovery/resource/ClassLoaders.html" target="_top">Frames</a></li>
<li><a href="ClassLoaders.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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.apache.commons.discovery.resource</div>
<h2 title="Class ClassLoaders" class="title">Class ClassLoaders</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.discovery.resource.ClassLoaders</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ClassLoaders</span>
extends java.lang.Object</pre>
<div class="block">There are many different contexts in which
loaders can be used. This provides a holder
for a set of class loaders, so that they
don't have to be build back up everytime...</div>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- =========== FIELD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_summary">
<!-- -->
</a>
<h3>Field Summary</h3>
<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Field Summary table, listing fields, and an explanation">
<caption><span>Fields</span><span class="tabEnd"> </span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Field and Description</th>
</tr>
<tr class="altColor">
<td class="colFirst"><code>protected java.util.List<java.lang.ClassLoader></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html#classLoaders">classLoaders</a></strong></code> </td>
</tr>
</table>
</li>
</ul>
<!-- ======== 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/apache/commons/discovery/resource/ClassLoaders.html#ClassLoaders()">ClassLoaders</a></strong>()</code>
<div class="block">Construct a new class loader set.</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.ClassLoader</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html#get(int)">get</a></strong>(int idx)</code>
<div class="block">Returns the class loader positioned at the given index.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html" title="class in org.apache.commons.discovery.resource">ClassLoaders</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html#getAppLoaders(java.lang.Class, java.lang.Class, boolean)">getAppLoaders</a></strong>(java.lang.Class<?> spi,
java.lang.Class<?> factory,
boolean prune)</code>
<div class="block">Utility method.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static <a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html" title="class in org.apache.commons.discovery.resource">ClassLoaders</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html#getLibLoaders(java.lang.Class, java.lang.Class, boolean)">getLibLoaders</a></strong>(java.lang.Class<?> spi,
java.lang.Class<?> factory,
boolean prune)</code>
<div class="block">Utility method.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html#isAncestor(java.lang.ClassLoader)">isAncestor</a></strong>(java.lang.ClassLoader classLoader)</code>
<div class="block">Check to see if <code>classLoader</code> is an
ancestor of any contained class loader.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html#put(java.lang.ClassLoader)">put</a></strong>(java.lang.ClassLoader classLoader)</code>
<div class="block">Specify a new class loader to be used in searching.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html#put(java.lang.ClassLoader, boolean)">put</a></strong>(java.lang.ClassLoader classLoader,
boolean prune)</code>
<div class="block">Specify a new class loader to be used in searching.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html#size()">size</a></strong>()</code>
<div class="block">Returns the size of class loaders set.</div>
</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, toString, wait, wait, wait</code></li>
</ul>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ FIELD DETAIL =========== -->
<ul class="blockList">
<li class="blockList"><a name="field_detail">
<!-- -->
</a>
<h3>Field Detail</h3>
<a name="classLoaders">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>classLoaders</h4>
<pre>protected java.util.List<java.lang.ClassLoader> classLoaders</pre>
</li>
</ul>
</li>
</ul>
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ClassLoaders()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ClassLoaders</h4>
<pre>public ClassLoaders()</pre>
<div class="block">Construct a new class loader set.</div>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="size()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>size</h4>
<pre>public int size()</pre>
<div class="block">Returns the size of class loaders set.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The size of class loaders set</dd></dl>
</li>
</ul>
<a name="get(int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>get</h4>
<pre>public java.lang.ClassLoader get(int idx)</pre>
<div class="block">Returns the class loader positioned at the given index.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>idx</code> - The index the class loader has to be retrieved from</dd>
<dt><span class="strong">Returns:</span></dt><dd>The class loader positioned at the given index</dd></dl>
</li>
</ul>
<a name="put(java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public void put(java.lang.ClassLoader classLoader)</pre>
<div class="block">Specify a new class loader to be used in searching.
The order of loaders determines the order of the result.
It is recommended to add the most specific loaders first;
<code>null</code> class loaders are discarded.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classLoader</code> - The class loader has to added in the set</dd></dl>
</li>
</ul>
<a name="put(java.lang.ClassLoader, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>put</h4>
<pre>public void put(java.lang.ClassLoader classLoader,
boolean prune)</pre>
<div class="block">Specify a new class loader to be used in searching.
The order of loaders determines the order of the result.
It is recommended to add the most specific loaders first;
<code>null</code> class loaders are discarded.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classLoader</code> - The class loader has to added in the set</dd><dd><code>prune</code> - if true, verify that the class loader is
not an Ancestor (@see isAncestor) before
adding it to our list.</dd></dl>
</li>
</ul>
<a name="isAncestor(java.lang.ClassLoader)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>isAncestor</h4>
<pre>public boolean isAncestor(java.lang.ClassLoader classLoader)</pre>
<div class="block">Check to see if <code>classLoader</code> is an
ancestor of any contained class loader.
This can be used to eliminate redundant class loaders
IF all class loaders defer to parent class loaders
before resolving a class.
It may be that this is not always true. Therefore,
this check is not done internally to eliminate
redundant class loaders, but left to the discretion
of the user.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classLoader</code> - The class loader under test</dd>
<dt><span class="strong">Returns:</span></dt><dd>true, if the class loader under test is an ancestor
of any contained class loader, false otherwise</dd></dl>
</li>
</ul>
<a name="getLibLoaders(java.lang.Class, java.lang.Class, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getLibLoaders</h4>
<pre>public static <a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html" title="class in org.apache.commons.discovery.resource">ClassLoaders</a> getLibLoaders(java.lang.Class<?> spi,
java.lang.Class<?> factory,
boolean prune)</pre>
<div class="block">Utility method. Returns a preloaded ClassLoaders instance
containing the following class loaders, in order:
<ul>
<li>spi.getClassLoader</li>
<li>seeker.getClassLoader</li>
<li>System Class Loader</li>
</ul>
Note that the thread context class loader is NOT present.
This is a reasonable set of loaders to try if the resource to be found
should be restricted to a libraries containing the SPI and Factory.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>spi</code> - WHAT is being looked for (an implementation of this class,
a default property file related to this class).</dd><dd><code>factory</code> - WHO is performing the lookup.</dd><dd><code>prune</code> - Determines if ancestors are allowed to be loaded or not.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The class loaders holder</dd></dl>
</li>
</ul>
<a name="getAppLoaders(java.lang.Class, java.lang.Class, boolean)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getAppLoaders</h4>
<pre>public static <a href="../../../../../org/apache/commons/discovery/resource/ClassLoaders.html" title="class in org.apache.commons.discovery.resource">ClassLoaders</a> getAppLoaders(java.lang.Class<?> spi,
java.lang.Class<?> factory,
boolean prune)</pre>
<div class="block">Utility method. Returns a preloaded ClassLoaders instance
containing the following class loaders, in order:
<ul>
<li>Thread Context Class Loader</li>
<li>spi.getClassLoader</li>
<li>seeker.getClassLoader</li>
<li>System Class Loader</li>
</ul>
Note that the thread context class loader IS present.
This is a reasonable set of loaders to try if the resource to be found
may be provided by an application.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>spi</code> - WHAT is being looked for (an implementation of this class,
a default property file related to this class).</dd><dd><code>factory</code> - WHO is performing the lookup (factory).</dd><dd><code>prune</code> - Determines if ancestors are allowed to be loaded or not.</dd>
<dt><span class="strong">Returns:</span></dt><dd>The class loaders holder</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="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>Prev Class</li>
<li><a href="../../../../../org/apache/commons/discovery/resource/DiscoverResources.html" title="class in org.apache.commons.discovery.resource"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/discovery/resource/ClassLoaders.html" target="_top">Frames</a></li>
<li><a href="ClassLoaders.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><a href="#field_summary">Field</a> | </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><a href="#field_detail">Field</a> | </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 (c) 2002 - Apache Software Foundation</small></p>
</body>
</html>
|