/usr/share/doc/libcommons-pool-java/api/org/apache/commons/pool/impl/StackObjectPool.html is in libcommons-pool-java-doc 1.6-2.
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 522 523 524 525 526 527 528 529 530 531 532 533 534 535 536 537 538 539 540 541 542 543 544 545 546 547 548 549 550 551 552 553 554 555 556 557 558 559 560 561 562 563 564 565 566 567 568 569 570 571 572 573 574 575 576 577 578 579 580 581 582 583 584 585 586 587 588 589 590 591 592 593 594 595 596 597 598 599 600 601 602 603 604 605 606 607 608 609 | <!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_21) on Fri May 24 11:14:13 UTC 2013 -->
<title>StackObjectPool (Apache Commons Object Pooling Package)</title>
<meta name="date" content="2013-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="StackObjectPool (Apache Commons Object Pooling Package)";
}
//-->
</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="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/pool/impl/StackKeyedObjectPoolFactory.html" title="class in org.apache.commons.pool.impl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/pool/impl/StackObjectPoolFactory.html" title="class in org.apache.commons.pool.impl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/pool/impl/StackObjectPool.html" target="_top">Frames</a></li>
<li><a href="StackObjectPool.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.pool.impl</div>
<h2 title="Class StackObjectPool" class="title">Class StackObjectPool<T></h2>
</div>
<div class="contentContainer">
<ul class="inheritance">
<li><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
<li>
<ul class="inheritance">
<li><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">org.apache.commons.pool.BaseObjectPool</a><T></li>
<li>
<ul class="inheritance">
<li>org.apache.commons.pool.impl.StackObjectPool<T></li>
</ul>
</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 type of objects held in this pool</dd></dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool">ObjectPool</a><T></dd>
</dl>
<hr>
<br>
<pre>public class <span class="strong">StackObjectPool<T></span>
extends <a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a><T>
implements <a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool">ObjectPool</a><T></pre>
<div class="block">A simple, <a href="/usr/share/doc/default-jdk-doc/api/java/util/Stack.html?is-external=true" title="class or interface in java.util"><code>Stack</code></a>-based <a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool"><code>ObjectPool</code></a> implementation.
<p>
Given a <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>PoolableObjectFactory</code></a>, this class will maintain
a simple pool of instances. A finite number of "sleeping"
or idle instances is enforced, but when the pool is
empty, new instances are created to support the new load.
Hence this class places no limit on the number of "active"
instances created by the pool, but is quite useful for
re-using <tt>Object</tt>s without introducing
artificial limits.</div>
<dl><dt><span class="strong">Since:</span></dt>
<dd>Pool 1.0</dd>
<dt><span class="strong">Version:</span></dt>
<dd>$Revision: 1222396 $ $Date: 2011-12-22 14:02:25 -0500 (Thu, 22 Dec 2011) $</dd>
<dt><span class="strong">Author:</span></dt>
<dd>Rodney Waldhoff, Dirk Verbeeck, Sandy McArthur</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/apache/commons/pool/impl/StackObjectPool.html#StackObjectPool(org.apache.commons.pool.PoolableObjectFactory)">StackObjectPool</a></strong>(<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool">PoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>> factory)</code>
<div class="block">Create a new <tt>StackObjectPool</tt> using the specified <i>factory</i> to create new instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#StackObjectPool(org.apache.commons.pool.PoolableObjectFactory, int)">StackObjectPool</a></strong>(<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool">PoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>> factory,
int maxIdle)</code>
<div class="block">Create a new <tt>SimpleObjectPool</tt> using the specified <i>factory</i> to create new instances,
capping the number of "sleeping" instances to <i>maxIdle</i>.</div>
</td>
</tr>
<tr class="altColor">
<td class="colOne"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#StackObjectPool(org.apache.commons.pool.PoolableObjectFactory, int, int)">StackObjectPool</a></strong>(<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool">PoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>> factory,
int maxIdle,
int initIdleCapacity)</code>
<div class="block">Create a new <tt>StackObjectPool</tt> using the specified <code>factory</code> to create new instances,
capping the number of "sleeping" instances to <code>maxIdle</code>, and initially allocating a container
capable of containing at least <code>initIdleCapacity</code> instances.</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>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#addObject()">addObject</a></strong>()</code>
<div class="block">Create an object, and place it on top of the stack.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#borrowObject()">borrowObject</a></strong>()</code>
<div class="block">Borrows an object from the pool.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#clear()">clear</a></strong>()</code>
<div class="block">Clears any objects sitting idle in the pool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#close()">close</a></strong>()</code>
<div class="block">Close this pool, and free any resources associated with it.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code><a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool">PoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#getFactory()">getFactory</a></strong>()</code>
<div class="block">Returns the <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>PoolableObjectFactory</code></a> used by this pool to create and manage object instances.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#getMaxSleeping()">getMaxSleeping</a></strong>()</code>
<div class="block">Returns the maximum number of idle instances in the pool.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#getNumActive()">getNumActive</a></strong>()</code>
<div class="block">Return the number of instances currently borrowed from this pool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#getNumIdle()">getNumIdle</a></strong>()</code>
<div class="block">Return the number of instances
currently idle in this pool.</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#invalidateObject(T)">invalidateObject</a></strong>(<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a> obj)</code>
<div class="block">Invalidates an object from the pool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#returnObject(T)">returnObject</a></strong>(<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a> obj)</code>
<div class="block">Returns an instance to the pool, pushing it on top of the idle instance stack after successful
validation and passivation.</div>
</td>
</tr>
</table>
<ul class="blockList">
<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.pool.BaseObjectPool">
<!-- -->
</a>
<h3>Methods inherited from class org.apache.commons.pool.<a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a></h3>
<code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#isClosed()">isClosed</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.<a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
<code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Object.html?is-external=true#wait(long, int)" title="class or interface in java.lang">wait</a></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="StackObjectPool(org.apache.commons.pool.PoolableObjectFactory)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StackObjectPool</h4>
<pre>public StackObjectPool(<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool">PoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>> factory)</pre>
<div class="block">Create a new <tt>StackObjectPool</tt> using the specified <i>factory</i> to create new instances.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - the <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>PoolableObjectFactory</code></a> used to populate the pool</dd></dl>
</li>
</ul>
<a name="StackObjectPool(org.apache.commons.pool.PoolableObjectFactory, int)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>StackObjectPool</h4>
<pre>public StackObjectPool(<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool">PoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>> factory,
int maxIdle)</pre>
<div class="block">Create a new <tt>SimpleObjectPool</tt> using the specified <i>factory</i> to create new instances,
capping the number of "sleeping" instances to <i>maxIdle</i>.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - the <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>PoolableObjectFactory</code></a> used to populate the pool</dd><dd><code>maxIdle</code> - cap on the number of "sleeping" instances in the pool</dd></dl>
</li>
</ul>
<a name="StackObjectPool(org.apache.commons.pool.PoolableObjectFactory, int, int)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>StackObjectPool</h4>
<pre>public StackObjectPool(<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool">PoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>> factory,
int maxIdle,
int initIdleCapacity)</pre>
<div class="block"><p>Create a new <tt>StackObjectPool</tt> using the specified <code>factory</code> to create new instances,
capping the number of "sleeping" instances to <code>maxIdle</code>, and initially allocating a container
capable of containing at least <code>initIdleCapacity</code> instances. The pool is not pre-populated.
The <code>initIdleCapacity</code> parameter just determines the initial size of the underlying
container, which can increase beyond this value if <code>maxIdle > initIdleCapacity.</code></p>
<p>Negative values of <code>maxIdle</code> are ignored (i.e., the pool is created using
<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#DEFAULT_MAX_SLEEPING"><code>DEFAULT_MAX_SLEEPING</code></a>) as are non-positive values for <code>initIdleCapacity.</code></div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - the <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>PoolableObjectFactory</code></a> used to populate the pool</dd><dd><code>maxIdle</code> - cap on the number of "sleeping" instances in the pool</dd><dd><code>initIdleCapacity</code> - initial size of the pool (this specifies the size of the container,
it does not cause the pool to be pre-populated.)</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="addObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addObject</h4>
<pre>public void addObject()
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><p>Create an object, and place it on top of the stack.
This method is useful for "pre-loading" a pool with idle objects.</p>
<p>Before being added to the pool, the newly created instance is
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject(T)"><code>validated</code></a> and
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#passivateObject(T)"><code>passivated</code></a>. If validation
fails, the new instance is <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#destroyObject(T)"><code>destroyed</code></a>.
Exceptions generated by the factory <code>makeObject</code> or <code>passivate</code> are
propagated to the caller. Exceptions destroying instances are silently swallowed.</p>
<p>If a new instance is created and successfully validated and passivated and adding this
instance to the pool causes <a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#getMaxSleeping()"><code>maxSleeping</code></a> to be exceeded, the oldest
(bottom) instance in the pool is destroyed to make room for the newly created instance, which
is pushed on top of the stack.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/ObjectPool.html#addObject()">addObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool">ObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#addObject()">addObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when the <a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#getFactory()"><code>factory</code></a> has a problem creating or passivating an object.</dd></dl>
</li>
</ul>
<a name="borrowObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>borrowObject</h4>
<pre>public <a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a> borrowObject()
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><p>Borrows an object from the pool. If there are idle instances available on the stack,
the top element of the stack is popped to activate, validate and return to the client. If there
are no idle instances available, the <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#makeObject()"><code>makeObject</code></a>
method of the pool's <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>PoolableObjectFactory</code></a> is invoked to create a new instance.</p>
<p>All instances are <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#activateObject(T)"><code>activated</code></a> and
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject(T)"><code>validated</code></a> before being returned to the
client. If validation fails or an exception occurs activating or validating an instance
popped from the idle instance stack, the failing instance is
<a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#destroyObject(T)"><code>destroyed</code></a> and the next instance on
the stack is popped, validated and activated. This process continues until either the
stack is empty or an instance passes validation. If the stack is empty on activation or
it does not contain any valid instances, the factory's <code>makeObject</code> method is used
to create a new instance. If a null instance is returned by the factory or the created
instance either raises an exception on activation or fails validation, <code>NoSuchElementException</code>
is thrown. Exceptions thrown by <code>MakeObject</code> are propagated to the caller; but
other than <code>ThreadDeath</code> or <code>VirtualMachineError</code>, exceptions generated by
activation, validation or destroy methods are swallowed silently.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/ObjectPool.html#borrowObject()">borrowObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool">ObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#borrowObject()">borrowObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>an instance from the pool</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an instance cannot be obtained from the pool</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>public void clear()</pre>
<div class="block">Clears any objects sitting idle in the pool. Silently swallows any
exceptions thrown by <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#destroyObject(T)"><code>PoolableObjectFactory.destroyObject(Object)</code></a>.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/ObjectPool.html#clear()">clear</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool">ObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#clear()">clear</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
</dl>
</li>
</ul>
<a name="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>public void close()
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><p>Close this pool, and free any resources associated with it. Invokes
<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#clear()"><code>clear()</code></a> to destroy and remove instances in the pool.</p>
<p>Calling <a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#addObject()"><code>addObject()</code></a> or <a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#borrowObject()"><code>borrowObject()</code></a> after invoking
this method on a pool will cause them to throw an
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalStateException</code></a>.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/ObjectPool.html#close()">close</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool">ObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#close()">close</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - never - exceptions clearing the pool are swallowed</dd></dl>
</li>
</ul>
<a name="getFactory()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getFactory</h4>
<pre>public <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool">PoolableObjectFactory</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>> getFactory()</pre>
<div class="block">Returns the <a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>PoolableObjectFactory</code></a> used by this pool to create and manage object instances.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the factory</dd><dt><span class="strong">Since:</span></dt>
<dd>1.5.5</dd></dl>
</li>
</ul>
<a name="getMaxSleeping()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getMaxSleeping</h4>
<pre>public int getMaxSleeping()</pre>
<div class="block">Returns the maximum number of idle instances in the pool.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>maxSleeping</dd><dt><span class="strong">Since:</span></dt>
<dd>1.5.5</dd></dl>
</li>
</ul>
<a name="getNumActive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumActive</h4>
<pre>public int getNumActive()</pre>
<div class="block">Return the number of instances currently borrowed from this pool.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/ObjectPool.html#getNumActive()">getNumActive</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool">ObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#getNumActive()">getNumActive</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of instances currently borrowed from this pool</dd></dl>
</li>
</ul>
<a name="getNumIdle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumIdle</h4>
<pre>public int getNumIdle()</pre>
<div class="block">Return the number of instances
currently idle in this pool.</div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/ObjectPool.html#getNumIdle()">getNumIdle</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool">ObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><strong>Overrides:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#getNumIdle()">getNumIdle</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><span class="strong">Returns:</span></dt><dd>the number of instances currently idle in this pool</dd></dl>
</li>
</ul>
<a name="invalidateObject(java.lang.Object)">
<!-- -->
</a><a name="invalidateObject(T)">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>invalidateObject</h4>
<pre>public void invalidateObject(<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a> obj)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><p>Invalidates an object from the pool.</p>
<p>By contract, <code>obj</code> <strong>must</strong> have been obtained
using <a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#borrowObject()"><code>borrowObject</code></a>.<p>
<p>This method should be used when an object that has been borrowed
is determined (due to an exception or other problem) to be invalid.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/ObjectPool.html#invalidateObject(T)">invalidateObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool">ObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#invalidateObject(T)">invalidateObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - a <a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#borrowObject()"><code>borrowed</code></a> instance to be disposed.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code></dd></dl>
</li>
</ul>
<a name="returnObject(java.lang.Object)">
<!-- -->
</a><a name="returnObject(T)">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>returnObject</h4>
<pre>public void returnObject(<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a> obj)
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
<div class="block"><p>Returns an instance to the pool, pushing it on top of the idle instance stack after successful
validation and passivation. The returning instance is destroyed if any of the following are true:<ul>
<li>the pool is closed</li>
<li><a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject(T)"><code>validation</code></a> fails</li>
<li><a href="../../../../../org/apache/commons/pool/PoolableObjectFactory.html#passivateObject(T)"><code>passivation</code></a> throws an exception</li>
</ul>
If adding a validated, passivated returning instance to the stack would cause
<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html#getMaxSleeping()"><code>maxSleeping</code></a> to be exceeded, the oldest (bottom) instance on the stack
is destroyed to make room for the returning instance, which is pushed on top of the stack.</p>
<p>Exceptions passivating or destroying instances are silently swallowed. Exceptions validating
instances are propagated to the client.</p></div>
<dl>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/ObjectPool.html#returnObject(T)">returnObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool/ObjectPool.html" title="interface in org.apache.commons.pool">ObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><strong>Specified by:</strong></dt>
<dd><code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html#returnObject(T)">returnObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="type parameter in StackObjectPool">T</a>></code></dd>
<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - instance to return to the pool</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</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><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="../../../../../index-all.html">Index</a></li>
</ul>
</div>
<div class="subNav">
<ul class="navList">
<li><a href="../../../../../org/apache/commons/pool/impl/StackKeyedObjectPoolFactory.html" title="class in org.apache.commons.pool.impl"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../../org/apache/commons/pool/impl/StackObjectPoolFactory.html" title="class in org.apache.commons.pool.impl"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../../index.html?org/apache/commons/pool/impl/StackObjectPool.html" target="_top">Frames</a></li>
<li><a href="StackObjectPool.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><small>Copyright © 2001-2012 Apache Software Foundation. Documenation generated May 24 2013</small>.</small></p>
</body>
</html>
|