You are viewing a plain text version of this content. The canonical link for it is here.
Posted to commits@commons.apache.org by ps...@apache.org on 2014/12/31 15:00:21 UTC
svn commit: r934605 [4/35] - in
/websites/production/commons/content/proper/commons-pool/api-2.3: ./ org/
org/apache/ org/apache/commons/ org/apache/commons/pool2/
org/apache/commons/pool2/class-use/ org/apache/commons/pool2/impl/
org/apache/commons/po...
Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/BasePooledObjectFactory.html
==============================================================================
--- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/BasePooledObjectFactory.html (added)
+++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/BasePooledObjectFactory.html Wed Dec 31 14:00:19 2014
@@ -0,0 +1,426 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1">
+<title>BasePooledObjectFactory (Apache Commons Pool 2.3 API)</title>
+<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="BasePooledObjectFactory (Apache Commons Pool 2.3 API)";
+ }
+//-->
+</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="class-use/BasePooledObjectFactory.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/commons/pool2/BasePooledObjectFactory.html" target="_top">Frames</a></li>
+<li><a href="BasePooledObjectFactory.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.pool2</div>
+<h2 title="Class BasePooledObjectFactory" class="title">Class BasePooledObjectFactory<T></h2>
+</div>
+<div class="contentContainer">
+<ul class="inheritance">
+<li><a href="http://docs.oracle.com/javase/6/docs/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.pool2.BasePooledObjectFactory<T></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> - Type of element managed in this factory.</dd></dl>
+<dl>
+<dt>All Implemented Interfaces:</dt>
+<dd><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><T></dd>
+</dl>
+<hr>
+<br>
+<pre>public abstract class <a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line.35">BasePooledObjectFactory</a><T>
+extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a>
+implements <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><T></pre>
+<div class="block">A base implementation of <code>PoolableObjectFactory</code>.
+ <p>
+ All operations defined here are essentially no-op's.
+ <p>
+ This class is immutable, and therefore thread-safe</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>2.0</dd>
+<dt><span class="strong">Version:</span></dt>
+ <dd>$Revision: 1333925 $</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2"><code>PooledObjectFactory</code></a>,
+<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="class in org.apache.commons.pool2"><code>BaseKeyedPooledObjectFactory</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="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/pool2/BasePooledObjectFactory.html#BasePooledObjectFactory()">BasePooledObjectFactory</a></strong>()</code> </td>
+</tr>
+</table>
+</li>
+</ul>
+<!-- ========== METHOD SUMMARY =========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_summary">
+<!-- -->
+</a>
+<h3>Method Summary</h3>
+<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation">
+<caption><span>Methods</span><span class="tabEnd"> </span></caption>
+<tr>
+<th class="colFirst" scope="col">Modifier and Type</th>
+<th class="colLast" scope="col">Method and Description</th>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html#activateObject(org.apache.commons.pool2.PooledObject)">activateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</code>
+<div class="block">No-op.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>abstract <a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html#create()">create</a></strong>()</code>
+<div class="block">Creates an object instance, to be wrapped in a <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)">destroyObject</a></strong>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</code>
+<div class="block">No-op.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code><a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html#makeObject()">makeObject</a></strong>()</code>
+<div class="block">Create an instance that can be served by the pool and wrap it in a
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a> to be managed by 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/pool2/BasePooledObjectFactory.html#passivateObject(org.apache.commons.pool2.PooledObject)">passivateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</code>
+<div class="block">No-op.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)">validateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</code>
+<div class="block">This implementation always returns <code>true</code>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>abstract <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html#wrap(T)">wrap</a></strong>(<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a> obj)</code>
+<div class="block">Wrap the provided instance with an implementation of
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a>.</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="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3>
+<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang
/Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" 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="BasePooledObjectFactory()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>BasePooledObjectFactory</h4>
+<pre>public <a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line.35">BasePooledObjectFactory</a>()</pre>
+</li>
+</ul>
+</li>
+</ul>
+<!-- ============ METHOD DETAIL ========== -->
+<ul class="blockList">
+<li class="blockList"><a name="method_detail">
+<!-- -->
+</a>
+<h3>Method Detail</h3>
+<a name="create()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>create</h4>
+<pre>public abstract <a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a> <a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line.46">create</a>()
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Creates an object instance, to be wrapped in a <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a>.
+ <p>This method <strong>must</strong> support concurrent, multi-threaded
+ activation.</p></div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>an instance to be served by the pool</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="wrap(java.lang.Object)">
+<!-- -->
+</a><a name="wrap(T)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>wrap</h4>
+<pre>public abstract <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> <a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line.56">wrap</a>(<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a> obj)</pre>
+<div class="block">Wrap the provided instance with an implementation of
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a>.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - the instance to wrap</dd>
+<dt><span class="strong">Returns:</span></dt><dd>The provided instance, wrapped by a <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a></dd></dl>
+</li>
+</ul>
+<a name="makeObject()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>makeObject</h4>
+<pre>public <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> <a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line.59">makeObject</a>()
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject()">PooledObjectFactory</a></code></strong></div>
+<div class="block">Create an instance that can be served by the pool and wrap it in a
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a> to be managed by the pool.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject()">makeObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></code></dd>
+<dt><span class="strong">Returns:</span></dt><dd>a <code>PooledObject</code> wrapping an instance that can be served by the pool</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="destroyObject(org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>destroyObject</h4>
+<pre>public void <a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line.69">destroyObject</a>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">No-op.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)">destroyObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - ignored</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)"><code>PooledObjectFactory.validateObject(org.apache.commons.pool2.PooledObject<T>)</code></a>,
+<a href="../../../../org/apache/commons/pool2/ObjectPool.html#invalidateObject(T)"><code>ObjectPool.invalidateObject(T)</code></a></dd></dl>
+</li>
+</ul>
+<a name="validateObject(org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>validateObject</h4>
+<pre>public boolean <a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line.81">validateObject</a>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</pre>
+<div class="block">This implementation always returns <code>true</code>.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)">validateObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - ignored</dd>
+<dt><span class="strong">Returns:</span></dt><dd><code>true</code></dd></dl>
+</li>
+</ul>
+<a name="activateObject(org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>activateObject</h4>
+<pre>public void <a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line.91">activateObject</a>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">No-op.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#activateObject(org.apache.commons.pool2.PooledObject)">activateObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - ignored</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)"><code>PooledObjectFactory.destroyObject(org.apache.commons.pool2.PooledObject<T>)</code></a></dd></dl>
+</li>
+</ul>
+<a name="passivateObject(org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>passivateObject</h4>
+<pre>public void <a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line.100">passivateObject</a>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">No-op.</div>
+<dl>
+<dt><strong>Specified by:</strong></dt>
+<dd><code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#passivateObject(org.apache.commons.pool2.PooledObject)">passivateObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></code></dd>
+<dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - ignored</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)"><code>PooledObjectFactory.destroyObject(org.apache.commons.pool2.PooledObject<T>)</code></a></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="class-use/BasePooledObjectFactory.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/commons/pool2/BasePooledObjectFactory.html" target="_top">Frames</a></li>
+<li><a href="BasePooledObjectFactory.html" target="_top">No Frames</a></li>
+</ul>
+<ul class="navList" id="allclasses_navbar_bottom">
+<li><a href="../../../../allclasses-noframe.html">All Classes</a></li>
+</ul>
+<div>
+<script type="text/javascript"><!--
+ allClassesLink = document.getElementById("allclasses_navbar_bottom");
+ if(window==top) {
+ allClassesLink.style.display = "block";
+ }
+ else {
+ allClassesLink.style.display = "none";
+ }
+ //-->
+</script>
+</div>
+<div>
+<ul class="subNavList">
+<li>Summary: </li>
+<li>Nested | </li>
+<li>Field | </li>
+<li><a href="#constructor_summary">Constr</a> | </li>
+<li><a href="#method_summary">Method</a></li>
+</ul>
+<ul class="subNavList">
+<li>Detail: </li>
+<li>Field | </li>
+<li><a href="#constructor_detail">Constr</a> | </li>
+<li><a href="#method_detail">Method</a></li>
+</ul>
+</div>
+<a name="skip-navbar_bottom">
+<!-- -->
+</a></div>
+<!-- ======== END OF BOTTOM NAVBAR ======= -->
+<p class="legalCopy"><small>Copyright © 2001–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+</body>
+</html>
\ No newline at end of file
Propchange: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/BasePooledObjectFactory.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/KeyedObjectPool.html
==============================================================================
--- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/KeyedObjectPool.html (added)
+++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/KeyedObjectPool.html Wed Dec 31 14:00:19 2014
@@ -0,0 +1,537 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1">
+<title>KeyedObjectPool (Apache Commons Pool 2.3 API)</title>
+<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="KeyedObjectPool (Apache Commons Pool 2.3 API)";
+ }
+//-->
+</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="class-use/KeyedObjectPool.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="class in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/commons/pool2/KeyedObjectPool.html" target="_top">Frames</a></li>
+<li><a href="KeyedObjectPool.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.pool2</div>
+<h2 title="Interface KeyedObjectPool" class="title">Interface KeyedObjectPool<K,V></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>K</code> - The type of keys maintained by this pool.</dd><dd><code>V</code> - Type of element pooled in this pool.</dd></dl>
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a>, <a href="../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="class in org.apache.commons.pool2.proxy">ProxiedKeyedObjectPool</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.65">KeyedObjectPool</a><K,V></pre>
+<div class="block">A "keyed" pooling interface.
+ <p>
+ A keyed pool maintains a pool of instances for each key value.
+ <p>
+ Example of use:
+ <pre style="border:solid thin; padding: 1ex;"
+ > Object obj = <code style="color:#00C">null</code>;
+ Object key = <code style="color:#C00">"Key"</code>;
+
+ <code style="color:#00C">try</code> {
+ obj = pool.borrowObject(key);
+ <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(key, 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(key, obj);
+ }
+ }</pre>
+ <p>
+ <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><code>KeyedObjectPool</code></a> implementations <i>may</i> choose to store at most
+ one instance per key value, or may choose to maintain a pool of instances
+ for each key (essentially creating a <a href="http://docs.oracle.com/javase/6/docs/api/java/util/Map.html?is-external=true" title="class or interface in java.util"><code>Map</code></a> of
+ <a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><code>pools</code></a>).
+ <p>
+ See <a href="../../../../org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class in org.apache.commons.pool2.impl"><code>GenericKeyedObjectPool</code></a> for an implementation.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>2.0</dd>
+<dt><span class="strong">Version:</span></dt>
+ <dd>$Revision: 1566605 $</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2"><code>KeyedPooledObjectFactory</code></a>,
+<a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><code>ObjectPool</code></a>,
+<a href="../../../../org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class in org.apache.commons.pool2.impl"><code>GenericKeyedObjectPool</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/pool2/KeyedObjectPool.html#addObject(K)">addObject</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key)</code>
+<div class="block">Create an object using the <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2"><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/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">V</a></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#borrowObject(K)">borrowObject</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key)</code>
+<div class="block">Obtains an instance from this pool for the specified <code>key</code>.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#clear()">clear</a></strong>()</code>
+<div class="block">Clears the pool, removing all pooled instances (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/pool2/KeyedObjectPool.html#clear(K)">clear</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key)</code>
+<div class="block">Clears the specified pool, removing all pooled instances corresponding to
+ the given <code>key</code> (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/pool2/KeyedObjectPool.html#close()">close</a></strong>()</code>
+<div class="block">Close this pool, and free any resources associated with it.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumActive()">getNumActive</a></strong>()</code>
+<div class="block">Returns the total number of instances current borrowed from this pool but
+ not yet returned.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumActive(K)">getNumActive</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key)</code>
+<div class="block">Returns the number of instances currently borrowed from but not yet
+ returned to the pool corresponding to the given <code>key</code>.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumIdle()">getNumIdle</a></strong>()</code>
+<div class="block">Returns the total number of instances currently idle in this pool.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>int</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumIdle(K)">getNumIdle</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key)</code>
+<div class="block">Returns the number of instances corresponding to the given
+ <code>key</code> currently idle in this pool.</div>
+</td>
+</tr>
+<tr class="rowColor">
+<td class="colFirst"><code>void</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#invalidateObject(K,%20V)">invalidateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">V</a> obj)</code>
+<div class="block">Invalidates 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/pool2/KeyedObjectPool.html#returnObject(K,%20V)">returnObject</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">V</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="borrowObject(java.lang.Object)">
+<!-- -->
+</a><a name="borrowObject(K)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>borrowObject</h4>
+<pre><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">V</a> <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.99">borrowObject</a>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key)
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>,
+ <a href="http://docs.oracle.com/javase/6/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util">NoSuchElementException</a>,
+ <a href="http://docs.oracle.com/javase/6/docs/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 for the specified <code>key</code>.
+ <p>
+ Instances returned from this method will have been either newly created
+ with <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#makeObject(K)"><code>makeObject</code></a> or will be
+ a previously idle object and have been activated with
+ <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#activateObject(K,%20org.apache.commons.pool2.PooledObject)"><code>activateObject</code></a> and then
+ (optionally) validated with
+ <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#validateObject(K,%20org.apache.commons.pool2.PooledObject)"><code>validateObject</code></a>.
+ <p>
+ By contract, clients <strong>must</strong> return the borrowed object
+ using <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#returnObject(K,%20V)"><code>returnObject</code></a>,
+ <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#invalidateObject(K,%20V)"><code>invalidateObject</code></a>, or a related method as
+ defined in an implementation or sub-interface, using a <code>key</code>
+ that is <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang"><code>equivalent</code></a> to the one used to borrow the
+ instance in the first place.
+ <p>
+ The behaviour of this method when the pool has been exhausted is not
+ strictly specified (although it may be specified by implementations).</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used to obtain the object</dd>
+<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="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - after <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#close()"><code>close</code></a> has been called on this pool</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#makeObject(K)"><code>makeObject</code></a> throws an exception</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="returnObject(java.lang.Object,java.lang.Object)">
+<!-- -->
+</a><a name="returnObject(K, V)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>returnObject</h4>
+<pre>void <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.120">returnObject</a>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">V</a> obj)
+ throws <a href="http://docs.oracle.com/javase/6/docs/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/pool2/KeyedObjectPool.html#borrowObject(K)"><code>borrowObject</code></a> or a related method as defined in an
+ implementation or sub-interface using a <code>key</code> that is
+ equivalent to the one used to borrow the instance in the first place.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used to obtain the object</dd><dd><code>obj</code> - a <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#borrowObject(K)"><code>borrowed</code></a> instance to be returned.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if an attempt is made to return an object to the pool that
+ is in any state other than allocated (i.e. borrowed).
+ Attempting to return an object more than once or attempting
+ to return an object that was never borrowed from the pool
+ will trigger this exception.</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an instance cannot be returned to the pool</dd></dl>
+</li>
+</ul>
+<a name="invalidateObject(java.lang.Object,java.lang.Object)">
+<!-- -->
+</a><a name="invalidateObject(K, V)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>invalidateObject</h4>
+<pre>void <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.139">invalidateObject</a>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">V</a> obj)
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre>
+<div class="block">Invalidates an object from the pool.
+ <p>
+ By contract, <code>obj</code> <strong>must</strong> have been obtained
+ using <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#borrowObject(K)"><code>borrowObject</code></a> or a related method as defined
+ in an implementation or sub-interface using a <code>key</code> that is
+ equivalent to the one used to borrow the <code>Object</code> in the first
+ place.
+ <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.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used to obtain the object</dd><dd><code>obj</code> - a <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#borrowObject(K)"><code>borrowed</code></a> instance to be returned.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the instance cannot be invalidated</dd></dl>
+</li>
+</ul>
+<a name="addObject(java.lang.Object)">
+<!-- -->
+</a><a name="addObject(K)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>addObject</h4>
+<pre>void <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.156">addObject</a>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key)
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>,
+ <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a>,
+ <a href="http://docs.oracle.com/javase/6/docs/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/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2"><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">Parameters:</span></dt><dd><code>key</code> - the key a new instance should be added to</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#makeObject(K)"><code>KeyedPooledObjectFactory.makeObject(K)</code></a> fails.</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - after <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#close()"><code>close()</code></a> has been called on this pool.</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="getNumIdle(java.lang.Object)">
+<!-- -->
+</a><a name="getNumIdle(K)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNumIdle</h4>
+<pre>int <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.168">getNumIdle</a>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key)</pre>
+<div class="block">Returns the number of instances corresponding to the given
+ <code>key</code> currently idle in this pool. Returns a negative value if
+ this information is not available.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key to query</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the number of instances corresponding to the given
+ <code>key</code> currently idle in this pool.</dd></dl>
+</li>
+</ul>
+<a name="getNumActive(java.lang.Object)">
+<!-- -->
+</a><a name="getNumActive(K)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNumActive</h4>
+<pre>int <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.179">getNumActive</a>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key)</pre>
+<div class="block">Returns the number of instances currently borrowed from but not yet
+ returned to the pool corresponding to the given <code>key</code>.
+ Returns a negative value if this information is not available.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key to query</dd>
+<dt><span class="strong">Returns:</span></dt><dd>the number of instances currently borrowed from but not yet
+ returned to the pool corresponding to the given <code>key</code>.
+=</dd></dl>
+</li>
+</ul>
+<a name="getNumIdle()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNumIdle</h4>
+<pre>int <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.186">getNumIdle</a>()</pre>
+<div class="block">Returns the total number of instances currently idle in this pool.
+ Returns a negative value if this information is not available.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the total number of instances currently idle in this pool.
+ =</dd></dl>
+</li>
+</ul>
+<a name="getNumActive()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>getNumActive</h4>
+<pre>int <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.195">getNumActive</a>()</pre>
+<div class="block">Returns the total number of instances current borrowed from this pool but
+ not yet returned. Returns a negative value if this information is not
+ available.</div>
+<dl><dt><span class="strong">Returns:</span></dt><dd>the total number of instances current borrowed from this pool but
+ not yet returned.</dd></dl>
+</li>
+</ul>
+<a name="clear()">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>clear</h4>
+<pre>void <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.205">clear</a>()
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>,
+ <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre>
+<div class="block">Clears the pool, removing all pooled instances (optional operation).</div>
+<dl><dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - when this implementation doesn't
+ support the operation</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the pool cannot be cleared</dd></dl>
+</li>
+</ul>
+<a name="clear(java.lang.Object)">
+<!-- -->
+</a><a name="clear(K)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>clear</h4>
+<pre>void <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.218">clear</a>(<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="type parameter in KeyedObjectPool">K</a> key)
+ throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>,
+ <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre>
+<div class="block">Clears the specified pool, removing all pooled instances corresponding to
+ the given <code>key</code> (optional operation).</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key to clear</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - when this implementation doesn't
+ support the operation</dd>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the key cannot be cleared</dd></dl>
+</li>
+</ul>
+<a name="close()">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>close</h4>
+<pre>void <a href="../../../../src-html/org/apache/commons/pool2/KeyedObjectPool.html#line.229">close</a>()</pre>
+<div class="block">Close this pool, and free any resources associated with it.
+ <p>
+ Calling <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#addObject(K)"><code>addObject</code></a> or
+ <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#borrowObject(K)"><code>borrowObject</code></a> after invoking this method on a pool
+ will cause them to throw an <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalStateException</code></a>.
+ <p>
+ Implementations should silently fail if not all resources can be freed.</div>
+</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="class-use/KeyedObjectPool.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="class in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/commons/pool2/KeyedObjectPool.html" target="_top">Frames</a></li>
+<li><a href="KeyedObjectPool.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>Copyright © 2001–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+</body>
+</html>
\ No newline at end of file
Propchange: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/KeyedObjectPool.html
------------------------------------------------------------------------------
svn:eol-style = native
Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/KeyedPooledObjectFactory.html
==============================================================================
--- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/KeyedPooledObjectFactory.html (added)
+++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/KeyedPooledObjectFactory.html Wed Dec 31 14:00:19 2014
@@ -0,0 +1,383 @@
+<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN" "http://www.w3.org/TR/html4/loose.dtd">
+<!-- NewPage -->
+<html lang="en">
+<head>
+<meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1">
+<title>KeyedPooledObjectFactory (Apache Commons Pool 2.3 API)</title>
+<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="KeyedPooledObjectFactory (Apache Commons Pool 2.3 API)";
+ }
+//-->
+</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="class-use/KeyedPooledObjectFactory.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/commons/pool2/KeyedPooledObjectFactory.html" target="_top">Frames</a></li>
+<li><a href="KeyedPooledObjectFactory.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.pool2</div>
+<h2 title="Interface KeyedPooledObjectFactory" class="title">Interface KeyedPooledObjectFactory<K,V></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>K</code> - The type of keys managed by this factory.</dd><dd><code>V</code> - Type of element managed by this factory.</dd></dl>
+<dl>
+<dt>All Known Implementing Classes:</dt>
+<dd><a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="class in org.apache.commons.pool2">BaseKeyedPooledObjectFactory</a></dd>
+</dl>
+<hr>
+<br>
+<pre>public interface <a href="../../../../src-html/org/apache/commons/pool2/KeyedPooledObjectFactory.html#line.77">KeyedPooledObjectFactory</a><K,V></pre>
+<div class="block">An interface defining life-cycle methods for
+ instances to be served by a <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><code>KeyedObjectPool</code></a>.
+ <p>
+ By contract, when an <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><code>KeyedObjectPool</code></a>
+ delegates to a <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2"><code>KeyedPooledObjectFactory</code></a>,
+ <ol>
+ <li>
+ <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#makeObject(K)"><code>makeObject(K)</code></a> is called whenever a new instance is needed.
+ </li>
+ <li>
+ <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#activateObject(K,%20org.apache.commons.pool2.PooledObject)"><code>activateObject(K, org.apache.commons.pool2.PooledObject<V>)</code></a> is invoked on every instance that has been
+ <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#passivateObject(K,%20org.apache.commons.pool2.PooledObject)"><code>passivated</code></a> before it is
+ <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#borrowObject(K)"><code>borrowed</code></a> from the pool.
+ </li>
+ <li>
+ <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#validateObject(K,%20org.apache.commons.pool2.PooledObject)"><code>validateObject(K, org.apache.commons.pool2.PooledObject<V>)</code></a> may be invoked on <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#activateObject(K,%20org.apache.commons.pool2.PooledObject)"><code>activated</code></a>
+ instances to make sure they can be
+ <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#borrowObject(K)"><code>borrowed</code></a> from the pool.
+ <code>validateObject</code> may also be used to test an
+ instance being <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#returnObject(K,%20V)"><code>returned</code></a> to the pool
+ before it is <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#passivateObject(K,%20org.apache.commons.pool2.PooledObject)"><code>passivated</code></a>. It will only be invoked
+ on an activated instance.
+ </li>
+ <li>
+ <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#passivateObject(K,%20org.apache.commons.pool2.PooledObject)"><code>passivateObject</code></a>
+ is invoked on every instance when it is returned to the pool.
+ </li>
+ <li>
+ <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)"><code>destroyObject</code></a>
+ is invoked on every instance when it is being "dropped" from the
+ pool (whether due to the response from <code>validateObject</code>,
+ or for reasons specific to the pool implementation.) There is no
+ guarantee that the instance being destroyed will
+ be considered active, passive or in a generally consistent state.
+ </li>
+ </ol>
+ <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2"><code>KeyedPooledObjectFactory</code></a> must be thread-safe. The only promise
+ an <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><code>KeyedObjectPool</code></a> makes is that the same instance of an object will
+ not be passed to more than one method of a
+ <code>KeyedPoolableObjectFactory</code> at a time.
+ <p>
+ While clients of a <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><code>KeyedObjectPool</code></a> borrow and return instances of
+ the underlying value type V, the factory methods act on instances of
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject<V></code></a>. These are the object wrappers that
+ pools use to track and maintain state informations about the objects that
+ they manage.</div>
+<dl><dt><span class="strong">Since:</span></dt>
+ <dd>2.0</dd>
+<dt><span class="strong">Version:</span></dt>
+ <dd>$Revision: 1333925 $</dd>
+<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><code>KeyedObjectPool</code></a>,
+<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="class in org.apache.commons.pool2"><code>BaseKeyedPooledObjectFactory</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/pool2/KeyedPooledObjectFactory.html#activateObject(K,%20org.apache.commons.pool2.PooledObject)">activateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">V</a>> p)</code>
+<div class="block">Reinitialize an instance to be returned by 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/pool2/KeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)">destroyObject</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">V</a>> p)</code>
+<div class="block">Destroy an instance no longer needed by the pool.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code><a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">V</a>></code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#makeObject(K)">makeObject</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">K</a> key)</code>
+<div class="block">Create an instance that can be served by the pool and
+ wrap it in a <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a> to be managed by 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/pool2/KeyedPooledObjectFactory.html#passivateObject(K,%20org.apache.commons.pool2.PooledObject)">passivateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">V</a>> p)</code>
+<div class="block">Uninitialize an instance to be returned to the idle object pool.</div>
+</td>
+</tr>
+<tr class="altColor">
+<td class="colFirst"><code>boolean</code></td>
+<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#validateObject(K,%20org.apache.commons.pool2.PooledObject)">validateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">V</a>> p)</code>
+<div class="block">Ensures that the instance is safe to be returned by 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="makeObject(java.lang.Object)">
+<!-- -->
+</a><a name="makeObject(K)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>makeObject</h4>
+<pre><a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">V</a>> <a href="../../../../src-html/org/apache/commons/pool2/KeyedPooledObjectFactory.html#line.90">makeObject</a>(<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">K</a> key)
+ throws <a href="http://docs.oracle.com/javase/6/docs/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 and
+ wrap it in a <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a> to be managed by the pool.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when constructing the object</dd>
+<dt><span class="strong">Returns:</span></dt><dd>a <code>PooledObject</code> wrapping an instance that can
+ be served by the pool.</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="destroyObject(java.lang.Object,org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a><a name="destroyObject(K, org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>destroyObject</h4>
+<pre>void <a href="../../../../src-html/org/apache/commons/pool2/KeyedPooledObjectFactory.html#line.111">destroyObject</a>(<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">V</a>> p)
+ throws <a href="http://docs.oracle.com/javase/6/docs/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>
+ It is important for implementations of this method to be aware that there
+ is no guarantee about what state <code>obj</code> will be in and the
+ implementation should be prepared to handle unexpected errors.
+ <p>
+ Also, an implementation must take in to consideration that instances lost
+ to the garbage collector may never be destroyed.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when selecting the instance</dd><dd><code>p</code> - a <code>PooledObject</code> wrapping the instance to be destroyed</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#validateObject(K,%20org.apache.commons.pool2.PooledObject)"><code>validateObject(K, org.apache.commons.pool2.PooledObject<V>)</code></a>,
+<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#invalidateObject(K,%20V)"><code>KeyedObjectPool.invalidateObject(K, V)</code></a></dd></dl>
+</li>
+</ul>
+<a name="validateObject(java.lang.Object,org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a><a name="validateObject(K, org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>validateObject</h4>
+<pre>boolean <a href="../../../../src-html/org/apache/commons/pool2/KeyedPooledObjectFactory.html#line.122">validateObject</a>(<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">V</a>> p)</pre>
+<div class="block">Ensures that the instance is safe to be returned by the pool.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when selecting the object</dd><dd><code>p</code> - a <code>PooledObject</code> wrapping the instance to be validated</dd>
+<dt><span class="strong">Returns:</span></dt><dd><code>false</code> if <code>obj</code> is not valid and should
+ be dropped from the pool, <code>true</code> otherwise.</dd></dl>
+</li>
+</ul>
+<a name="activateObject(java.lang.Object,org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a><a name="activateObject(K, org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a>
+<ul class="blockList">
+<li class="blockList">
+<h4>activateObject</h4>
+<pre>void <a href="../../../../src-html/org/apache/commons/pool2/KeyedPooledObjectFactory.html#line.135">activateObject</a>(<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">V</a>> p)
+ throws <a href="http://docs.oracle.com/javase/6/docs/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.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when selecting the object</dd><dd><code>p</code> - a <code>PooledObject</code> wrapping the instance to be activated</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)"><code>destroyObject(K, org.apache.commons.pool2.PooledObject<V>)</code></a></dd></dl>
+</li>
+</ul>
+<a name="passivateObject(java.lang.Object,org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a><a name="passivateObject(K, org.apache.commons.pool2.PooledObject)">
+<!-- -->
+</a>
+<ul class="blockListLast">
+<li class="blockList">
+<h4>passivateObject</h4>
+<pre>void <a href="../../../../src-html/org/apache/commons/pool2/KeyedPooledObjectFactory.html#line.148">passivateObject</a>(<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">K</a> key,
+ <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="type parameter in KeyedPooledObjectFactory">V</a>> p)
+ throws <a href="http://docs.oracle.com/javase/6/docs/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.</div>
+<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when selecting the object</dd><dd><code>p</code> - a <code>PooledObject</code> wrapping the instance to be passivated</dd>
+<dt><span class="strong">Throws:</span></dt>
+<dd><code><a href="http://docs.oracle.com/javase/6/docs/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="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)"><code>destroyObject(K, org.apache.commons.pool2.PooledObject<V>)</code></a></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="class-use/KeyedPooledObjectFactory.html">Use</a></li>
+<li><a href="package-tree.html">Tree</a></li>
+<li><a href="../../../../deprecated-list.html">Deprecated</a></li>
+<li><a href="../../../../index-all.html">Index</a></li>
+<li><a href="../../../../help-doc.html">Help</a></li>
+</ul>
+</div>
+<div class="subNav">
+<ul class="navList">
+<li><a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li>
+<li><a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li>
+</ul>
+<ul class="navList">
+<li><a href="../../../../index.html?org/apache/commons/pool2/KeyedPooledObjectFactory.html" target="_top">Frames</a></li>
+<li><a href="KeyedPooledObjectFactory.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>Copyright © 2001–2014 <a href="http://www.apache.org/">The Apache Software Foundation</a>. All rights reserved.</small></p>
+</body>
+</html>
\ No newline at end of file
Propchange: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/KeyedPooledObjectFactory.html
------------------------------------------------------------------------------
svn:eol-style = native