Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,608 @@ +<!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>ProxiedKeyedObjectPool (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="ProxiedKeyedObjectPool (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/ProxiedKeyedObjectPool.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/proxy/JdkProxySource.html" title="class in org.apache.commons.pool2.proxy"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="class in org.apache.commons.pool2.proxy"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" target="_top">Frames</a></li> +<li><a href="ProxiedKeyedObjectPool.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.proxy</div> +<h2 title="Class ProxiedKeyedObjectPool" class="title">Class ProxiedKeyedObjectPool<K,V></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.proxy.ProxiedKeyedObjectPool<K,V></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - type of the key</dd><dd><code>V</code> - type of the pooled object</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><K,V></dd> +</dl> +<hr> +<br> +<pre>public class <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.35">ProxiedKeyedObjectPool</a><K,V> +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/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><K,V></pre> +<div class="block">Create a new keyed object pool where the pooled objects are wrapped in + proxies allowing better control of pooled objects and in particular the + prevention of the continued use of an object by a client after that client + returns the object to the pool.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</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/proxy/ProxiedKeyedObjectPool.html#ProxiedKeyedObjectPool(org.apache.commons.pool2.KeyedObjectPool,%20org.apache.commons.pool2.proxy.ProxySource)">ProxiedKeyedObjectPool</a></strong>(<a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>> pool, + org.apache.commons.pool2.proxy.ProxySource<<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>> proxySource)</code> +<div class="block">Create a new proxied object pool.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#addObject(K)">addObject</a></strong>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">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/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#borrowObject(K)">borrowObject</a></strong>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">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/proxy/ProxiedKeyedObjectPool.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/proxy/ProxiedKeyedObjectPool.html#clear(K)">clear</a></strong>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">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/proxy/ProxiedKeyedObjectPool.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/proxy/ProxiedKeyedObjectPool.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/proxy/ProxiedKeyedObjectPool.html#getNumActive(K)">getNumActive</a></strong>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">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/proxy/ProxiedKeyedObjectPool.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/proxy/ProxiedKeyedObjectPool.html#getNumIdle(K)">getNumIdle</a></strong>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">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/proxy/ProxiedKeyedObjectPool.html#invalidateObject(K,%20V)">invalidateObject</a></strong>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a> key, + <a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a> proxy)</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/proxy/ProxiedKeyedObjectPool.html#returnObject(K,%20V)">returnObject</a></strong>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a> key, + <a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a> proxy)</code> +<div class="block">Return an instance to 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="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="ProxiedKeyedObjectPool(org.apache.commons.pool2.KeyedObjectPool, org.apache.commons.pool2.proxy.ProxySource)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ProxiedKeyedObjectPool</h4> +<pre>public <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.47">ProxiedKeyedObjectPool</a>(<a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>> pool, + org.apache.commons.pool2.proxy.ProxySource<<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>> proxySource)</pre> +<div class="block">Create a new proxied object pool.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pool</code> - The object pool to wrap</dd><dd><code>proxySource</code> - The source of the proxy objects</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="borrowObject(java.lang.Object)"> +<!-- --> +</a><a name="borrowObject(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>borrowObject</h4> +<pre>public <a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a> <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.56">borrowObject</a>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#borrowObject(K)">KeyedObjectPool</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#borrowObject(K)">borrowObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></dd> +<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>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.68">returnObject</a>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a> key, + <a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a> proxy) + 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/KeyedObjectPool.html#returnObject(K,%20V)">KeyedObjectPool</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#returnObject(K,%20V)">returnObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used to obtain the object</dd><dd><code>proxy</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>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.74">invalidateObject</a>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a> key, + <a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a> proxy) + 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/KeyedObjectPool.html#invalidateObject(K,%20V)">KeyedObjectPool</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#invalidateObject(K,%20V)">invalidateObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used to obtain the object</dd><dd><code>proxy</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>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.80">addObject</a>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#addObject(K)">KeyedObjectPool</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#addObject(K)">addObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></dd> +<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>KeyedObjectPool.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>public int <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.86">getNumIdle</a>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a> key)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumIdle(K)">KeyedObjectPool</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumIdle(K)">getNumIdle</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></dd> +<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>public int <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.91">getNumActive</a>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a> key)</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumActive(K)">KeyedObjectPool</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumActive(K)">getNumActive</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></dd> +<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>public int <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.96">getNumIdle</a>()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumIdle()">KeyedObjectPool</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumIdle()">getNumIdle</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></dd> +<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>public int <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.101">getNumActive</a>()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumActive()">KeyedObjectPool</a></code></strong></div> +<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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#getNumActive()">getNumActive</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></dd> +<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>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.106">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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#clear()">KeyedObjectPool</a></code></strong></div> +<div class="block">Clears the pool, removing all pooled instances (optional operation).</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#clear()">clear</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></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 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>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.111">clear</a>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#clear(K)">KeyedObjectPool</a></code></strong></div> +<div class="block">Clears the specified pool, removing all pooled instances corresponding to + the given <code>key</code> (optional operation).</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#clear(K)">clear</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></dd> +<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>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#line.116">close</a>()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#close()">KeyedObjectPool</a></code></strong></div> +<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> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html#close()">close</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2">KeyedObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">K</a>,<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" title="type parameter in ProxiedKeyedObjectPool">V</a>></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ProxiedKeyedObjectPool.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/proxy/JdkProxySource.html" title="class in org.apache.commons.pool2.proxy"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="class in org.apache.commons.pool2.proxy"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html" target="_top">Frames</a></li> +<li><a href="ProxiedKeyedObjectPool.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/proxy/ProxiedKeyedObjectPool.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/proxy/ProxiedObjectPool.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/proxy/ProxiedObjectPool.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/proxy/ProxiedObjectPool.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,503 @@ +<!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>ProxiedObjectPool (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="ProxiedObjectPool (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/ProxiedObjectPool.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/proxy/ProxiedKeyedObjectPool.html" title="class in org.apache.commons.pool2.proxy"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/pool2/proxy/ProxiedObjectPool.html" target="_top">Frames</a></li> +<li><a href="ProxiedObjectPool.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.proxy</div> +<h2 title="Class ProxiedObjectPool" class="title">Class ProxiedObjectPool<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.proxy.ProxiedObjectPool<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 the pooled object</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><T></dd> +</dl> +<hr> +<br> +<pre>public class <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedObjectPool.html#line.34">ProxiedObjectPool</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/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><T></pre> +<div class="block">Create a new object pool where the pooled objects are wrapped in proxies + allowing better control of pooled objects and in particular the prevention + of the continued use of an object by a client after that client returns the + object to the pool.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</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/proxy/ProxiedObjectPool.html#ProxiedObjectPool(org.apache.commons.pool2.ObjectPool,%20org.apache.commons.pool2.proxy.ProxySource)">ProxiedObjectPool</a></strong>(<a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>> pool, + org.apache.commons.pool2.proxy.ProxySource<<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>> proxySource)</code> +<div class="block">Create a new proxied object pool.</div> +</td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html#addObject()">addObject</a></strong>()</code> +<div class="block">Create an object using the <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.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/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html#borrowObject()">borrowObject</a></strong>()</code> +<div class="block">Obtains an instance from this pool.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html#clear()">clear</a></strong>()</code> +<div class="block">Clears any objects sitting idle in the pool, releasing any associated + resources (optional operation).</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html#close()">close</a></strong>()</code> +<div class="block">Close this pool, and free any resources associated with it.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html#getNumActive()">getNumActive</a></strong>()</code> +<div class="block">Return the number of instances currently borrowed from this pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html#getNumIdle()">getNumIdle</a></strong>()</code> +<div class="block">Return the number of instances currently idle in this pool.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html#invalidateObject(T)">invalidateObject</a></strong>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a> proxy)</code> +<div class="block">Invalidates an object from the pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html#returnObject(T)">returnObject</a></strong>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a> proxy)</code> +<div class="block">Return an instance to 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="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="ProxiedObjectPool(org.apache.commons.pool2.ObjectPool, org.apache.commons.pool2.proxy.ProxySource)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>ProxiedObjectPool</h4> +<pre>public <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedObjectPool.html#line.46">ProxiedObjectPool</a>(<a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>> pool, + org.apache.commons.pool2.proxy.ProxySource<<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>> proxySource)</pre> +<div class="block">Create a new proxied object pool.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>pool</code> - The object pool to wrap</dd><dd><code>proxySource</code> - The source of the proxy objects</dd></dl> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="borrowObject()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>borrowObject</h4> +<pre>public <a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a> <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedObjectPool.html#line.56">borrowObject</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/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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()">ObjectPool</a></code></strong></div> +<div class="block">Obtains an instance from this pool. + <p> + Instances returned from this method will have been either newly created + with <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.makeObject()</code></a> or will be a previously + idle object and have been activated with + <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#activateObject(org.apache.commons.pool2.PooledObject)"><code>PooledObjectFactory.activateObject(org.apache.commons.pool2.PooledObject<T>)</code></a> and then validated with + <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>. + <p> + By contract, clients <strong>must</strong> return the borrowed instance + using <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#returnObject(T)"><code>ObjectPool.returnObject(T)</code></a>, <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#invalidateObject(T)"><code>ObjectPool.invalidateObject(T)</code></a>, or a related + method as defined in an implementation or sub-interface. + <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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()">borrowObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>></code></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/ObjectPool.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/PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.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)"> +<!-- --> +</a><a name="returnObject(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>returnObject</h4> +<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedObjectPool.html#line.69">returnObject</a>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a> proxy) + 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/ObjectPool.html#returnObject(T)">ObjectPool</a></code></strong></div> +<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/ObjectPool.html#borrowObject()"><code>ObjectPool.borrowObject()</code></a> or + a related method as defined in an implementation or sub-interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#returnObject(T)">returnObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>proxy</code> - a <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()"><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)"> +<!-- --> +</a><a name="invalidateObject(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invalidateObject</h4> +<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedObjectPool.html#line.76">invalidateObject</a>(<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a> proxy) + 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/ObjectPool.html#invalidateObject(T)">ObjectPool</a></code></strong></div> +<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/ObjectPool.html#borrowObject()"><code>ObjectPool.borrowObject()</code></a> or a related method as defined in an + implementation or sub-interface. + <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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#invalidateObject(T)">invalidateObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>proxy</code> - a <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()"><code>borrowed</code></a> instance to be disposed.</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()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addObject</h4> +<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedObjectPool.html#line.83">addObject</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/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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#addObject()">ObjectPool</a></code></strong></div> +<div class="block">Create an object using the <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.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><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#addObject()">addObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>></code></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/PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.makeObject()</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/ObjectPool.html#close()"><code>ObjectPool.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()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumIdle</h4> +<pre>public int <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedObjectPool.html#line.90">getNumIdle</a>()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#getNumIdle()">ObjectPool</a></code></strong></div> +<div class="block">Return the number of instances currently idle in this pool. This may be + considered an approximation of the number of objects that can be + <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()"><code>borrowed</code></a> without creating any new instances. + Returns a negative value if this information is not available.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#getNumIdle()">getNumIdle</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the number of instances currently idle in this pool.</dd></dl> +</li> +</ul> +<a name="getNumActive()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumActive</h4> +<pre>public int <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedObjectPool.html#line.96">getNumActive</a>()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#getNumActive()">ObjectPool</a></code></strong></div> +<div class="block">Return the number of instances currently borrowed from this pool. Returns + a negative value if this information is not available.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#getNumActive()">getNumActive</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>the number of instances currently borrowed from this pool.</dd></dl> +</li> +</ul> +<a name="clear()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>clear</h4> +<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedObjectPool.html#line.102">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"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#clear()">ObjectPool</a></code></strong></div> +<div class="block">Clears any objects sitting idle in the pool, releasing any associated + resources (optional operation). Idle objects cleared must be + <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)"><code>PooledObjectFactory.destroyObject(PooledObject)</code></a>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#clear()">clear</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>></code></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> - if this implementation does not 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="close()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>close</h4> +<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/proxy/ProxiedObjectPool.html#line.108">close</a>()</pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#close()">ObjectPool</a></code></strong></div> +<div class="block">Close this pool, and free any resources associated with it. + <p> + Calling <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#addObject()"><code>ObjectPool.addObject()</code></a> or <a href="../../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()"><code>ObjectPool.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> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html#close()">close</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../../org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="type parameter in ProxiedObjectPool">T</a>></code></dd> +</dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/ProxiedObjectPool.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/proxy/ProxiedKeyedObjectPool.html" title="class in org.apache.commons.pool2.proxy"><span class="strong">Prev Class</span></a></li> +<li>Next Class</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/pool2/proxy/ProxiedObjectPool.html" target="_top">Frames</a></li> +<li><a href="ProxiedObjectPool.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/proxy/ProxiedObjectPool.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/proxy/class-use/CglibProxySource.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/proxy/class-use/CglibProxySource.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/proxy/class-use/CglibProxySource.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,115 @@ +<!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>Uses of Class org.apache.commons.pool2.proxy.CglibProxySource (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="Uses of Class org.apache.commons.pool2.proxy.CglibProxySource (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><a href="../../../../../../org/apache/commons/pool2/proxy/CglibProxySource.html" title="class in org.apache.commons.pool2.proxy">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/pool2/proxy/class-use/CglibProxySource.html" target="_top">Frames</a></li> +<li><a href="CglibProxySource.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> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<div class="header"> +<h2 title="Uses of Class org.apache.commons.pool2.proxy.CglibProxySource" class="title">Uses of Class<br>org.apache.commons.pool2.proxy.CglibProxySource</h2> +</div> +<div class="classUseContainer">No usage of org.apache.commons.pool2.proxy.CglibProxySource</div> +<!-- ======= 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><a href="../../../../../../org/apache/commons/pool2/proxy/CglibProxySource.html" title="class in org.apache.commons.pool2.proxy">Class</a></li> +<li class="navBarCell1Rev">Use</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>Prev</li> +<li>Next</li> +</ul> +<ul class="navList"> +<li><a href="../../../../../../index.html?org/apache/commons/pool2/proxy/class-use/CglibProxySource.html" target="_top">Frames</a></li> +<li><a href="CglibProxySource.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> +<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/proxy/class-use/CglibProxySource.html ------------------------------------------------------------------------------ svn:eol-style = native