/usr/share/doc/libcommons-pool-java/api/org/apache/commons/pool/ObjectPool.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 | <!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:12 UTC 2013 -->
<title>ObjectPool (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="ObjectPool (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/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/pool/ObjectPoolFactory.html" title="interface in org.apache.commons.pool"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/pool/ObjectPool.html" target="_top">Frames</a></li>
<li><a href="ObjectPool.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_top">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_top");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_top">
<!-- -->
</a></div>
<!-- ========= END OF TOP NAVBAR ========= -->
<!-- ======== START OF CLASS DATA ======== -->
<div class="header">
<div class="subTitle">org.apache.commons.pool</div>
<h2 title="Interface ObjectPool" class="title">Interface ObjectPool<T></h2>
</div>
<div class="contentContainer">
<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 Known Implementing Classes:</dt>
<dd><a href="../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool">BaseObjectPool</a>, <a href="../../../../org/apache/commons/pool/impl/GenericObjectPool.html" title="class in org.apache.commons.pool.impl">GenericObjectPool</a>, <a href="../../../../org/apache/commons/pool/impl/SoftReferenceObjectPool.html" title="class in org.apache.commons.pool.impl">SoftReferenceObjectPool</a>, <a href="../../../../org/apache/commons/pool/impl/StackObjectPool.html" title="class in org.apache.commons.pool.impl">StackObjectPool</a></dd>
</dl>
<hr>
<br>
<pre>public interface <span class="strong">ObjectPool<T></span></pre>
<div class="block">A pooling interface.
<p>
<code>ObjectPool</code> defines a trivially simple pooling interface. The only
required methods are <a href="../../../../org/apache/commons/pool/ObjectPool.html#borrowObject()"><code>borrowObject</code></a>, <a href="../../../../org/apache/commons/pool/ObjectPool.html#returnObject(T)"><code>returnObject</code></a>
and <a href="../../../../org/apache/commons/pool/ObjectPool.html#invalidateObject(T)"><code>invalidateObject</code></a>.
</p>
<p>
Example of use:
<pre style="border:solid thin; padding: 1ex;"
> Object obj = <code style="color:#00C">null</code>;
<code style="color:#00C">try</code> {
obj = pool.borrowObject();
<code style="color:#00C">try</code> {
<code style="color:#0C0">//...use the object...</code>
} <code style="color:#00C">catch</code>(Exception e) {
<code style="color:#0C0">// invalidate the object</code>
pool.invalidateObject(obj);
<code style="color:#0C0">// do not return the object to the pool twice</code>
obj = <code style="color:#00C">null</code>;
} <code style="color:#00C">finally</code> {
<code style="color:#0C0">// make sure the object is returned to the pool</code>
<code style="color:#00C">if</code>(<code style="color:#00C">null</code> != obj) {
pool.returnObject(obj);
}
}
} <code style="color:#00C">catch</code>(Exception e) {
<code style="color:#0C0">// failed to borrow an object</code>
}</pre>
</p>
<p>See <a href="../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool"><code>BaseObjectPool</code></a> for a simple base implementation.</p></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, Sandy McArthur</dd>
<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>PoolableObjectFactory</code></a>,
<a href="../../../../org/apache/commons/pool/ObjectPoolFactory.html" title="interface in org.apache.commons.pool"><code>ObjectPoolFactory</code></a>,
<a href="../../../../org/apache/commons/pool/KeyedObjectPool.html" title="interface in org.apache.commons.pool"><code>KeyedObjectPool</code></a>,
<a href="../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool"><code>BaseObjectPool</code></a></dd></dl>
</li>
</ul>
</div>
<div class="summary">
<ul class="blockList">
<li class="blockList">
<!-- ========== METHOD SUMMARY =========== -->
<ul class="blockList">
<li class="blockList"><a name="method_summary">
<!-- -->
</a>
<h3>Method Summary</h3>
<table class="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/ObjectPool.html#addObject()">addObject</a></strong>()</code>
<div class="block">Create an object using the <a href="../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>factory</code></a> or other
implementation dependent mechanism, passivate it, and then place it in the idle object pool.</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code><a href="../../../../org/apache/commons/pool/ObjectPool.html" title="type parameter in ObjectPool">T</a></code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool/ObjectPool.html#borrowObject()">borrowObject</a></strong>()</code>
<div class="block">Obtains an instance from 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/ObjectPool.html#clear()">clear</a></strong>()</code>
<div class="block">Clears any objects sitting idle in the pool, releasing any
associated resources (optional operation).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool/ObjectPool.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>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool/ObjectPool.html#getNumActive()">getNumActive</a></strong>()</code>
<div class="block">Return the number of instances
currently borrowed from this pool
(optional operation).</div>
</td>
</tr>
<tr class="rowColor">
<td class="colFirst"><code>int</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool/ObjectPool.html#getNumIdle()">getNumIdle</a></strong>()</code>
<div class="block">Return the number of instances
currently idle in this pool (optional operation).</div>
</td>
</tr>
<tr class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool/ObjectPool.html#invalidateObject(T)">invalidateObject</a></strong>(<a href="../../../../org/apache/commons/pool/ObjectPool.html" title="type parameter in ObjectPool">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/ObjectPool.html#returnObject(T)">returnObject</a></strong>(<a href="../../../../org/apache/commons/pool/ObjectPool.html" title="type parameter in ObjectPool">T</a> obj)</code>
<div class="block">Return an instance to the pool.</div>
</td>
</tr>
</table>
</li>
</ul>
</li>
</ul>
</div>
<div class="details">
<ul class="blockList">
<li class="blockList">
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method_detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="addObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>addObject</h4>
<pre>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>,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre>
<div class="block">Create an object using the <a href="../../../../org/apache/commons/pool/PoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>factory</code></a> or other
implementation dependent mechanism, passivate it, and then place it in the idle object pool.
<code>addObject</code> is useful for "pre-loading" a pool with idle objects.
(Optional operation).</div>
<dl><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 <a href="../../../../org/apache/commons/pool/PoolableObjectFactory.html#makeObject()"><code>PoolableObjectFactory.makeObject()</code></a> fails.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - after <a href="../../../../org/apache/commons/pool/ObjectPool.html#close()"><code>close()</code></a> has been called on this pool.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - when this pool cannot add new idle objects.</dd></dl>
</li>
</ul>
<a name="borrowObject()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>borrowObject</h4>
<pre><a href="../../../../org/apache/commons/pool/ObjectPool.html" title="type parameter in ObjectPool">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>,
<a href="/usr/share/doc/default-jdk-doc/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util">NoSuchElementException</a>,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></pre>
<div class="block">Obtains an instance from this pool.
<p>
Instances returned from this method will have been either newly created with
<a href="../../../../org/apache/commons/pool/PoolableObjectFactory.html#makeObject()"><code>makeObject</code></a> or will be a previously idle object and
have been activated with <a href="../../../../org/apache/commons/pool/PoolableObjectFactory.html#activateObject(T)"><code>activateObject</code></a> and
then validated with <a href="../../../../org/apache/commons/pool/PoolableObjectFactory.html#validateObject(T)"><code>validateObject</code></a>.
</p>
<p>
By contract, clients <strong>must</strong> return the borrowed instance using
<a href="../../../../org/apache/commons/pool/ObjectPool.html#returnObject(T)"><code>returnObject</code></a>, <a href="../../../../org/apache/commons/pool/ObjectPool.html#invalidateObject(T)"><code>invalidateObject</code></a>, or a related method
as defined in an implementation or sub-interface.
</p>
<p>
The behaviour of this method when the pool has been exhausted
is not strictly specified (although it may be specified by implementations).
Older versions of this method would return <code>null</code> to indicate exhaustion,
newer versions are encouraged to throw a <a href="/usr/share/doc/default-jdk-doc/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util"><code>NoSuchElementException</code></a>.
</p></div>
<dl><dt><span class="strong">Returns:</span></dt><dd>an instance from this pool.</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - after <a href="../../../../org/apache/commons/pool/ObjectPool.html#close()"><code>close</code></a> has been called on this pool.</dd>
<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 <a href="../../../../org/apache/commons/pool/PoolableObjectFactory.html#makeObject()"><code>makeObject</code></a> throws an exception.</dd>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util">NoSuchElementException</a></code> - when the pool is exhausted and cannot or will not return another instance.</dd></dl>
</li>
</ul>
<a name="clear()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>clear</h4>
<pre>void clear()
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>,
<a href="/usr/share/doc/default-jdk-doc/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre>
<div class="block">Clears any objects sitting idle in the pool, releasing any
associated resources (optional operation).
Idle objects cleared must be <a href="../../../../org/apache/commons/pool/PoolableObjectFactory.html#destroyObject(T)"><code>destroyed</code></a>.</div>
<dl><dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if this implementation does not support the operation</dd>
<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="close()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>close</h4>
<pre>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">Close this pool, and free any resources associated with it.
<p>
Calling <a href="../../../../org/apache/commons/pool/ObjectPool.html#addObject()"><code>addObject()</code></a> or <a href="../../../../org/apache/commons/pool/ObjectPool.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><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> - <strong>deprecated</strong>: implementations should silently fail if not all resources can be freed.</dd></dl>
</li>
</ul>
<a name="getNumActive()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumActive</h4>
<pre>int getNumActive()
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre>
<div class="block">Return the number of instances
currently borrowed from this pool
(optional operation).
Returns a negative value if this information is not available.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of instances currently borrowed from this pool or a negative value if unsupported</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - <strong>deprecated</strong>: if this implementation does not support the operation</dd></dl>
</li>
</ul>
<a name="getNumIdle()">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>getNumIdle</h4>
<pre>int getNumIdle()
throws <a href="/usr/share/doc/default-jdk-doc/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre>
<div class="block">Return the number of instances
currently idle in this pool (optional operation).
This may be considered an approximation of the number
of objects that can be <a href="../../../../org/apache/commons/pool/ObjectPool.html#borrowObject()"><code>borrowed</code></a>
without creating any new instances.
Returns a negative value if this information is not available.</div>
<dl><dt><span class="strong">Returns:</span></dt><dd>the number of instances currently idle in this pool or a negative value if unsupported</dd>
<dt><span class="strong">Throws:</span></dt>
<dd><code><a href="/usr/share/doc/default-jdk-doc/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - <strong>deprecated</strong>: if this implementation does not support the operation</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>void invalidateObject(<a href="../../../../org/apache/commons/pool/ObjectPool.html" title="type parameter in ObjectPool">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/ObjectPool.html#borrowObject()"><code>borrowObject</code></a> or a related method as defined in
an implementation or sub-interface.</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><span class="strong">Parameters:</span></dt><dd><code>obj</code> - a <a href="../../../../org/apache/commons/pool/ObjectPool.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>void returnObject(<a href="../../../../org/apache/commons/pool/ObjectPool.html" title="type parameter in ObjectPool">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">Return an instance to the pool.
By contract, <code>obj</code> <strong>must</strong> have been obtained
using <a href="../../../../org/apache/commons/pool/ObjectPool.html#borrowObject()"><code>borrowObject</code></a>
or a related method as defined in an implementation
or sub-interface.</div>
<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - a <a href="../../../../org/apache/commons/pool/ObjectPool.html#borrowObject()"><code>borrowed</code></a> instance to be returned.</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/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool"><span class="strong">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/pool/ObjectPoolFactory.html" title="interface in org.apache.commons.pool"><span class="strong">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/pool/ObjectPool.html" target="_top">Frames</a></li>
<li><a href="ObjectPool.html" target="_top">No Frames</a></li>
</ul>
<ul class="navList" id="allclasses_navbar_bottom">
<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
</ul>
<div>
<script type="text/javascript"><!--
allClassesLink = document.getElementById("allclasses_navbar_bottom");
if(window==top) {
allClassesLink.style.display = "block";
}
else {
allClassesLink.style.display = "none";
}
//-->
</script>
</div>
<div>
<ul class="subNavList">
<li>Summary: </li>
<li>Nested | </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_summary">Method</a></li>
</ul>
<ul class="subNavList">
<li>Detail: </li>
<li>Field | </li>
<li>Constr | </li>
<li><a href="#method_detail">Method</a></li>
</ul>
</div>
<a name="skip-navbar_bottom">
<!-- -->
</a></div>
<!-- ======== END OF BOTTOM NAVBAR ======= -->
<p class="legalCopy"><small><small>Copyright © 2001-2012 Apache Software Foundation. Documenation generated May 24 2013</small>.</small></p>
</body>
</html>
|