/usr/share/doc/libcommons-discovery-java/api/org/apache/commons/discovery/tools/ManagedProperties.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 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 | <!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>ManagedProperties (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="ManagedProperties (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><a href="../../../../../org/apache/commons/discovery/tools/EnvironmentCache.html" title="class in org.apache.commons.discovery.tools"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/discovery/tools/PropertiesHolder.html" title="class in org.apache.commons.discovery.tools"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/discovery/tools/ManagedProperties.html" target="_top">Frames</a></li>
<li><a href="ManagedProperties.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.apache.commons.discovery.tools</div>
<h2 title="Class ManagedProperties" class="title">Class ManagedProperties</h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li>java.lang.Object</li>
<li>
<ul class="inheritance">
<li>org.apache.commons.discovery.tools.ManagedProperties</li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<hr>
<br>
<pre>public class <span class="strong">ManagedProperties</span>
extends java.lang.Object</pre>
<div class="block"><p>This class may disappear in the future, or be moved to another project..
</p>
<p>Extend the concept of System properties to a hierarchical scheme
based around class loaders. System properties are global in nature,
so using them easily violates sound architectural and design principles
for maintaining separation between components and runtime environments.
Nevertheless, there is a need for properties broader in scope than
class or class instance scope.
</p>
<p>This class is one solution.
</p>
<p>Manage properties according to a secure
scheme similar to that used by classloaders:
<ul>
<li><code>ClassLoader</code>s are organized in a tree hierarchy.</li>
<li>each <code>ClassLoader</code> has a reference
to a parent <code>ClassLoader</code>.</li>
<li>the root of the tree is the bootstrap <code>ClassLoader</code>er.</li>
<li>the youngest decendent is the thread context class loader.</li>
<li>properties are bound to a <code>ClassLoader</code> instance
<ul>
<li><i>non-default</i> properties bound to a parent <code>ClassLoader</code>
instance take precedence over all properties of the same name bound
to any decendent.
Just to confuse the issue, this is the default case.</li>
<li><i>default</i> properties bound to a parent <code>ClassLoader</code>
instance may be overriden by (default or non-default) properties of
the same name bound to any decendent.
</li>
</ul>
</li>
<li>System properties take precedence over all other properties</li>
</ul>
</p>
<p>This is not a perfect solution, as it is possible that
different <code>ClassLoader</code>s load different instances of
<code>ScopedProperties</code>. The 'higher' this class is loaded
within the <code>ClassLoader</code> hierarchy, the more usefull
it will be.
</p></div>
</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/apache/commons/discovery/tools/ManagedProperties.html#ManagedProperties()">ManagedProperties</a></strong>()</code> </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>static java.util.Properties</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#getProperties()">getProperties</a></strong>()</code>
<div class="block">This is an expensive operation.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#getProperty(java.lang.ClassLoader, java.lang.String)">getProperty</a></strong>(java.lang.ClassLoader classLoader,
java.lang.String propertyName)</code>
<div class="block">Get value for property bound to the class loader.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#getProperty(java.lang.ClassLoader, java.lang.String, java.lang.String)">getProperty</a></strong>(java.lang.ClassLoader classLoader,
java.lang.String propertyName,
java.lang.String dephault)</code>
<div class="block">Get value for property bound to the class loader.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#getProperty(java.lang.String)">getProperty</a></strong>(java.lang.String propertyName)</code>
<div class="block">Get value for property bound to the current thread context class loader.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static java.lang.String</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#getProperty(java.lang.String, java.lang.String)">getProperty</a></strong>(java.lang.String propertyName,
java.lang.String dephault)</code>
<div class="block">Get value for property bound to the current thread context class loader.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static java.util.Enumeration<java.lang.String></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#propertyNames()">propertyNames</a></strong>()</code>
<div class="block">Return list of all property names.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#setLog(org.apache.commons.logging.Log)">setLog</a></strong>(org.apache.commons.logging.Log _log)</code>
<div class="block"><strong>Deprecated.</strong>
<div class="block"><i>This method is not thread-safe</i></div>
</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#setProperties(java.util.Map)">setProperties</a></strong>(java.util.Map<?,?> newProperties)</code>
<div class="block">Set property values for <code>Properties</code> bound to the
current thread context class loader.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#setProperties(java.util.Map, boolean)">setProperties</a></strong>(java.util.Map<?,?> newProperties,
boolean isDefault)</code>
<div class="block">Set property values for <code>Properties</code> bound to the
current thread context class loader.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#setProperty(java.lang.String, java.lang.String)">setProperty</a></strong>(java.lang.String propertyName,
java.lang.String value)</code>
<div class="block">Set value for property bound to the current thread context class loader.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>static void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/discovery/tools/ManagedProperties.html#setProperty(java.lang.String, java.lang.String, boolean)">setProperty</a></strong>(java.lang.String propertyName,
java.lang.String value,
boolean isDefault)</code>
<div class="block">Set value for property bound to the current thread context class loader.</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">
<!-- ========= CONSTRUCTOR DETAIL ======== -->
<ul class="blockList">
<li class="blockList"><a name="constructor_detail">
<!-- -->
</a>
<h3>Constructor Detail</h3>
<a name="ManagedProperties()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>ManagedProperties</h4>
<pre>public ManagedProperties()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="setLog(org.apache.commons.logging.Log)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setLog</h4>
<pre>@Deprecated
public static void setLog(org.apache.commons.logging.Log _log)</pre>
<div class="block"><span class="strong">Deprecated.</span> <i>This method is not thread-safe</i></div>
<div class="block">Sets the <code>Log</code> for this class.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>_log</code> - This class <code>Log</code></dd></dl>
</li>
</ul>
<a name="getProperty(java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre>public static java.lang.String getProperty(java.lang.String propertyName)</pre>
<div class="block">Get value for property bound to the current thread context class loader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - property name.</dd>
<dt><span class="strong">Returns:</span></dt><dd>property value if found, otherwise default.</dd></dl>
</li>
</ul>
<a name="getProperty(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre>public static java.lang.String getProperty(java.lang.String propertyName,
java.lang.String dephault)</pre>
<div class="block">Get value for property bound to the current thread context class loader.
If not found, then return default.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - property name.</dd><dd><code>dephault</code> - default value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>property value if found, otherwise default.</dd></dl>
</li>
</ul>
<a name="getProperty(java.lang.ClassLoader, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre>public static java.lang.String getProperty(java.lang.ClassLoader classLoader,
java.lang.String propertyName)</pre>
<div class="block">Get value for property bound to the class loader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classLoader</code> - The classloader used to load resources.</dd><dd><code>propertyName</code> - property name.</dd>
<dt><span class="strong">Returns:</span></dt><dd>property value if found, otherwise default.</dd></dl>
</li>
</ul>
<a name="getProperty(java.lang.ClassLoader, java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getProperty</h4>
<pre>public static java.lang.String getProperty(java.lang.ClassLoader classLoader,
java.lang.String propertyName,
java.lang.String dephault)</pre>
<div class="block">Get value for property bound to the class loader.
If not found, then return default.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>classLoader</code> - The classloader used to load resources.</dd><dd><code>propertyName</code> - property name.</dd><dd><code>dephault</code> - default value.</dd>
<dt><span class="strong">Returns:</span></dt><dd>property value if found, otherwise default.</dd></dl>
</li>
</ul>
<a name="setProperty(java.lang.String, java.lang.String)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>public static void setProperty(java.lang.String propertyName,
java.lang.String value)</pre>
<div class="block">Set value for property bound to the current thread context class loader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - property name</dd><dd><code>value</code> - property value (non-default) If null, remove the property.</dd></dl>
</li>
</ul>
<a name="setProperty(java.lang.String, java.lang.String, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperty</h4>
<pre>public static void setProperty(java.lang.String propertyName,
java.lang.String value,
boolean isDefault)</pre>
<div class="block">Set value for property bound to the current thread context class loader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>propertyName</code> - property name</dd><dd><code>value</code> - property value. If null, remove the property.</dd><dd><code>isDefault</code> - determines if property is default or not.
A non-default property cannot be overriden.
A default property can be overriden by a property
(default or non-default) of the same name bound to
a decendent class loader.</dd></dl>
</li>
</ul>
<a name="setProperties(java.util.Map)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperties</h4>
<pre>public static void setProperties(java.util.Map<?,?> newProperties)</pre>
<div class="block">Set property values for <code>Properties</code> bound to the
current thread context class loader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newProperties</code> - name/value pairs to be bound</dd></dl>
</li>
</ul>
<a name="setProperties(java.util.Map, boolean)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>setProperties</h4>
<pre>public static void setProperties(java.util.Map<?,?> newProperties,
boolean isDefault)</pre>
<div class="block">Set property values for <code>Properties</code> bound to the
current thread context class loader.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>newProperties</code> - name/value pairs to be bound</dd><dd><code>isDefault</code> - determines if properties are default or not.
A non-default property cannot be overriden.
A default property can be overriden by a property
(default or non-default) of the same name bound to
a decendent class loader.</dd></dl>
</li>
</ul>
<a name="propertyNames()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>propertyNames</h4>
<pre>public static java.util.Enumeration<java.lang.String> propertyNames()</pre>
<div class="block">Return list of all property names. This is an expensive
operation: ON EACH CALL it walks through all property lists
associated with the current context class loader upto
and including the bootstrap class loader.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>The list of all property names</dd></dl>
</li>
</ul>
<a name="getProperties()">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>getProperties</h4>
<pre>public static java.util.Properties getProperties()</pre>
<div class="block">This is an expensive operation.
ON EACH CALL it walks through all property lists
associated with the current context class loader upto
and including the bootstrap class loader.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>Returns a <code>java.util.Properties</code> instance
that is equivalent to the current state of the scoped
properties, in that getProperty() will return the same value.
However, this is a copy, so setProperty on the
returned value will not effect the scoped properties.</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><a href="../../../../../org/apache/commons/discovery/tools/EnvironmentCache.html" title="class in org.apache.commons.discovery.tools"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/discovery/tools/PropertiesHolder.html" title="class in org.apache.commons.discovery.tools"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/discovery/tools/ManagedProperties.html" target="_top">Frames</a></li>
<li><a href="ManagedProperties.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 (c) 2002 - Apache Software Foundation</small></p>
</body>
</html>
|