/usr/share/doc/libcommons-pool-java/api/org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html is in libcommons-pool-java-doc 1.6-3.
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 | <!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
<!-- NewPage -->
<html>
<head>
<title>BaseKeyedPoolableObjectFactory (Apache Commons Object Pooling Package)</title>
<meta name="date" content="2016-07-07">
<link rel="stylesheet" type="text/css" href="../../../../stylesheet.css" title="Style">
<script type="text/javascript" src="../../../../script.js"></script>
</head>
<body>
<script type="text/javascript"><!--
try {
if (location.href.indexOf('is-external=true') == -1) {
parent.document.title="BaseKeyedPoolableObjectFactory (Apache Commons Object Pooling Package)";
}
}
catch(err) {
}
//-->
var methods = {"i0":10,"i1":10,"i2":6,"i3":10,"i4":10};
var tabs = {65535:["t0","All Methods"],2:["t2","Instance Methods"],4:["t3","Abstract Methods"],8:["t4","Concrete Methods"]};
var altColor = "altColor";
var rowColor = "rowColor";
var tableTab = "tableTab";
var activeTableTab = "activeTableTab";
</script>
<noscript>
<div>JavaScript is disabled on your browser.</div>
</noscript>
<!-- ========= START OF TOP NAVBAR ======= -->
<div class="topNav"><a name="navbar.top">
<!-- -->
</a>
<div class="skipNav"><a href="#skip.navbar.top" title="Skip navigation links">Skip navigation links</a></div>
<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/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" target="_top">Frames</a></li>
<li><a href="BaseKeyedPoolableObjectFactory.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</div>
<h2 title="Class BaseKeyedPoolableObjectFactory" class="title">Class BaseKeyedPoolableObjectFactory<K,V></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>org.apache.commons.pool.BaseKeyedPoolableObjectFactory<K,V></li>
</ul>
</li>
</ul>
<div class="description">
<ul class="blockList">
<li class="blockList">
<dl>
<dt><span class="paramLabel">Type Parameters:</span></dt>
<dd><code>K</code> - the type of keys in this pool</dd>
<dd><code>V</code> - the type of objects held in this pool</dd>
</dl>
<dl>
<dt>All Implemented Interfaces:</dt>
<dd><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><K,V></dd>
</dl>
<hr>
<br>
<pre>public abstract class <span class="typeNameLabel">BaseKeyedPoolableObjectFactory<K,V></span>
extends <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>
implements <a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><K,V></pre>
<div class="block">A base implementation of <code>KeyedPoolableObjectFactory</code>.
<p>
All operations defined here are essentially no-op's.
</p></div>
<dl>
<dt><span class="simpleTagLabel">Since:</span></dt>
<dd>Pool 1.0</dd>
<dt><span class="simpleTagLabel">Version:</span></dt>
<dd>$Revision: 1222388 $ $Date: 2011-12-22 13:28:27 -0500 (Thu, 22 Dec 2011) $</dd>
<dt><span class="simpleTagLabel">Author:</span></dt>
<dd>Rodney Waldhoff</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool"><code>KeyedPoolableObjectFactory</code></a></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="memberSummary" 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><span class="memberNameLink"><a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html#BaseKeyedPoolableObjectFactory--">BaseKeyedPoolableObjectFactory</a></span>()</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="memberSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
<caption><span id="t0" class="activeTableTab"><span>All Methods</span><span class="tabEnd"> </span></span><span id="t2" class="tableTab"><span><a href="javascript:show(2);">Instance Methods</a></span><span class="tabEnd"> </span></span><span id="t3" class="tableTab"><span><a href="javascript:show(4);">Abstract Methods</a></span><span class="tabEnd"> </span></span><span id="t4" class="tableTab"><span><a href="javascript:show(8);">Concrete Methods</a></span><span class="tabEnd"> </span></span></caption>
<tr>
<th class="colFirst" scope="col">Modifier and Type</th>
<th class="colLast" scope="col">Method and Description</th>
</tr>
<tr id="i0" class="altColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html#activateObject-K-V-">activateObject</a></span>(<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a> key,
<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a> obj)</code>
<div class="block">Reinitialize an instance to be returned by the pool.</div>
</td>
</tr>
<tr id="i1" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html#destroyObject-K-V-">destroyObject</a></span>(<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a> key,
<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a> obj)</code>
<div class="block">Destroy an instance no longer needed by the pool.</div>
</td>
</tr>
<tr id="i2" class="altColor">
<td class="colFirst"><code>abstract <a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a></code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html#makeObject-K-">makeObject</a></span>(<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a> key)</code>
<div class="block">Create an instance that can be served by the pool.</div>
</td>
</tr>
<tr id="i3" class="rowColor">
<td class="colFirst"><code>void</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html#passivateObject-K-V-">passivateObject</a></span>(<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a> key,
<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a> obj)</code>
<div class="block">Uninitialize an instance to be returned to the idle object pool.</div>
</td>
</tr>
<tr id="i4" class="altColor">
<td class="colFirst"><code>boolean</code></td>
<td class="colLast"><code><span class="memberNameLink"><a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html#validateObject-K-V-">validateObject</a></span>(<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a> key,
<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a> obj)</code>
<div class="block">Ensures that the instance is safe to be returned by the pool.</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.<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="BaseKeyedPoolableObjectFactory--">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>BaseKeyedPoolableObjectFactory</h4>
<pre>public BaseKeyedPoolableObjectFactory()</pre>
</li>
</ul>
</li>
</ul>
<!-- ============ METHOD DETAIL ========== -->
<ul class="blockList">
<li class="blockList"><a name="method.detail">
<!-- -->
</a>
<h3>Method Detail</h3>
<a name="activateObject-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="activateObject-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>activateObject</h4>
<pre>public void activateObject(<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a> key,
<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</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">Reinitialize an instance to be returned by the pool.
<p>
The default implementation is a no-op.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#activateObject-K-V-">activateObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a>,<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key used when selecting the object</dd>
<dd><code>obj</code> - the instance to be activated</dd>
<dt><span class="throwsLabel">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 there is a problem activating <code>obj</code>,
this exception may be swallowed by the pool.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#destroyObject-K-V-"><code>KeyedPoolableObjectFactory.destroyObject(K, V)</code></a></dd>
</dl>
</li>
</ul>
<a name="destroyObject-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="destroyObject-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>destroyObject</h4>
<pre>public void destroyObject(<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a> key,
<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</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">Destroy an instance no longer needed by the pool.
<p>
The default implementation is a no-op.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#destroyObject-K-V-">destroyObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a>,<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key used when selecting the instance</dd>
<dd><code>obj</code> - the instance to be destroyed</dd>
<dt><span class="throwsLabel">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> - should be avoided as it may be swallowed by
the pool implementation.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#validateObject-K-V-"><code>KeyedPoolableObjectFactory.validateObject(K, V)</code></a>,
<a href="../../../../org/apache/commons/pool/KeyedObjectPool.html#invalidateObject-K-V-"><code>KeyedObjectPool.invalidateObject(K, V)</code></a></dd>
</dl>
</li>
</ul>
<a name="makeObject-java.lang.Object-">
<!-- -->
</a><a name="makeObject-K-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>makeObject</h4>
<pre>public abstract <a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a> makeObject(<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a> key)
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">Create an instance that can be served by the pool.</div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#makeObject-K-">makeObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a>,<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key used when constructing the object</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>an instance that can be served by the pool</dd>
<dt><span class="throwsLabel">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 there is a problem creating a new instance,
this will be propagated to the code requesting an object.</dd>
</dl>
</li>
</ul>
<a name="passivateObject-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="passivateObject-K-V-">
<!-- -->
</a>
<ul class="blockList">
<li class="blockList">
<h4>passivateObject</h4>
<pre>public void passivateObject(<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a> key,
<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</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">Uninitialize an instance to be returned to the idle object pool.
<p>
The default implementation is a no-op.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#passivateObject-K-V-">passivateObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a>,<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key used when selecting the object</dd>
<dd><code>obj</code> - the instance to be passivated</dd>
<dt><span class="throwsLabel">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 there is a problem passivating <code>obj</code>,
this exception may be swallowed by the pool.</dd>
<dt><span class="seeLabel">See Also:</span></dt>
<dd><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#destroyObject-K-V-"><code>KeyedPoolableObjectFactory.destroyObject(K, V)</code></a></dd>
</dl>
</li>
</ul>
<a name="validateObject-java.lang.Object-java.lang.Object-">
<!-- -->
</a><a name="validateObject-K-V-">
<!-- -->
</a>
<ul class="blockListLast">
<li class="blockList">
<h4>validateObject</h4>
<pre>public boolean validateObject(<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a> key,
<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a> obj)</pre>
<div class="block">Ensures that the instance is safe to be returned by the pool.
<p>
The default implementation always returns <tt>true</tt>.
</p></div>
<dl>
<dt><span class="overrideSpecifyLabel">Specified by:</span></dt>
<dd><code><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html#validateObject-K-V-">validateObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool/KeyedPoolableObjectFactory.html" title="interface in org.apache.commons.pool">KeyedPoolableObjectFactory</a><<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">K</a>,<a href="../../../../org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" title="type parameter in BaseKeyedPoolableObjectFactory">V</a>></code></dd>
<dt><span class="paramLabel">Parameters:</span></dt>
<dd><code>key</code> - the key used when selecting the object</dd>
<dd><code>obj</code> - the instance to be validated</dd>
<dt><span class="returnLabel">Returns:</span></dt>
<dd>always <code>true</code> in the default implementation</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>
<div class="skipNav"><a href="#skip.navbar.bottom" title="Skip navigation links">Skip navigation links</a></div>
<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/BaseKeyedObjectPool.html" title="class in org.apache.commons.pool"><span class="typeNameLink">Prev Class</span></a></li>
<li><a href="../../../../org/apache/commons/pool/BaseObjectPool.html" title="class in org.apache.commons.pool"><span class="typeNameLink">Next Class</span></a></li>
</ul>
<ul class="navList">
<li><a href="../../../../index.html?org/apache/commons/pool/BaseKeyedPoolableObjectFactory.html" target="_top">Frames</a></li>
<li><a href="BaseKeyedPoolableObjectFactory.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 July 7 2016</small>.</small></p>
</body>
</html>
|