Added:
websites/production/commons/content/proper/commons-pool/api-2.3/index-all.html
==============================================================================
---
websites/production/commons/content/proper/commons-pool/api-2.3/index-all.html
(added)
+++
websites/production/commons/content/proper/commons-pool/api-2.3/index-all.html
Wed Dec 31 14:00:19 2014
@@ -0,0 +1,2305 @@
+<!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>Index (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="Index (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>Package</li>
+<li>Class</li>
+<li>Use</li>
+<li><a href="./overview-tree.html">Tree</a></li>
+<li><a href="./deprecated-list.html">Deprecated</a></li>
+<li class="navBarCell1Rev">Index</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?index-all.html" target="_top">Frames</a></li>
+<li><a href="index-all.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="contentContainer"><a href="#_A_">A</a> <a
href="#_B_">B</a> <a href="#_C_">C</a> <a href="#_D_">D</a> <a
href="#_E_">E</a> <a href="#_G_">G</a> <a href="#_H_">H</a> <a
href="#_I_">I</a> <a href="#_J_">J</a> <a href="#_K_">K</a> <a
href="#_L_">L</a> <a href="#_M_">M</a> <a href="#_O_">O</a> <a
href="#_P_">P</a> <a href="#_R_">R</a> <a href="#_S_">S</a> <a
href="#_T_">T</a> <a href="#_U_">U</a> <a href="#_V_">V</a> <a
href="#_W_">W</a> <a name="_A_">
+<!-- -->
+</a>
+<h2 class="title">A</h2>
+<dl>
+<dt><a href="./org/apache/commons/pool2/impl/AbandonedConfig.html"
title="class in org.apache.commons.pool2.impl"><span
class="strong">AbandonedConfig</span></a> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">Configuration settings for abandoned object removal.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/AbandonedConfig.html#AbandonedConfig()">AbandonedConfig()</a></span>
- Constructor for class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in
org.apache.commons.pool2.impl">AbandonedConfig</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#activateObject(K,%20org.apache.commons.pool2.PooledObject)">activateObject(K,
PooledObject<V>)</a></span> - Method in class
org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html"
title="class in org.apache.commons.pool2">BaseKeyedPooledObjectFactory</a></dt>
+<dd>
+<div class="block">Reinitialize an instance to be returned by the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BasePooledObjectFactory.html#activateObject(org.apache.commons.pool2.PooledObject)">activateObject(PooledObject<T>)</a></span>
- Method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BasePooledObjectFactory.html" title="class in
org.apache.commons.pool2">BasePooledObjectFactory</a></dt>
+<dd>
+<div class="block">No-op.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/KeyedPooledObjectFactory.html#activateObject(K,%20org.apache.commons.pool2.PooledObject)">activateObject(K,
PooledObject<V>)</a></span> - Method in interface
org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/KeyedPooledObjectFactory.html"
title="interface in org.apache.commons.pool2">KeyedPooledObjectFactory</a></dt>
+<dd>
+<div class="block">Reinitialize an instance to be returned by the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PooledObjectFactory.html#activateObject(org.apache.commons.pool2.PooledObject)">activateObject(PooledObject<T>)</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PooledObjectFactory.html" title="interface in
org.apache.commons.pool2">PooledObjectFactory</a></dt>
+<dd>
+<div class="block">Reinitialize an instance to be returned by the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BaseObjectPool.html#addObject()">addObject()</a></span>
- Method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BaseObjectPool.html" title="class in
org.apache.commons.pool2">BaseObjectPool</a></dt>
+<dd>
+<div class="block">Not supported in this base implementation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#addObject(K)">addObject(K)</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Create an object using the <a
href="./org/apache/commons/pool2/KeyedPooledObjectFactory.html#makeObject(K)"><code>factory</code></a>,
passivate it, and then place it in the idle object pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#addObject()">addObject()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Create an object, and place it into the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#addObject()">addObject()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/SoftReferenceObjectPool.html"
title="class in org.apache.commons.pool2.impl">SoftReferenceObjectPool</a></dt>
+<dd>
+<div class="block">Create an object, and place it into the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/KeyedObjectPool.html#addObject(K)">addObject(K)</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/KeyedObjectPool.html" title="interface in
org.apache.commons.pool2">KeyedObjectPool</a></dt>
+<dd>
+<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>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/ObjectPool.html#addObject()">addObject()</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/ObjectPool.html" title="interface in
org.apache.commons.pool2">ObjectPool</a></dt>
+<dd>
+<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>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#addObject(K)">addObject(K)</a></span>
- Method in class org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html"
title="class in org.apache.commons.pool2.proxy">ProxiedKeyedObjectPool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/ProxiedObjectPool.html#addObject()">addObject()</a></span>
- Method in class org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="class in
org.apache.commons.pool2.proxy">ProxiedObjectPool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html#allocate()">allocate()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in
org.apache.commons.pool2.impl">DefaultPooledObject</a></dt>
+<dd>
+<div class="block">Allocates the object.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PooledObject.html#allocate()">allocate()</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PooledObject.html" title="interface in
org.apache.commons.pool2">PooledObject</a></dt>
+<dd>
+<div class="block">Allocates the object.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BaseObjectPool.html#assertOpen()">assertOpen()</a></span>
- Method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BaseObjectPool.html" title="class in
org.apache.commons.pool2">BaseObjectPool</a></dt>
+<dd>
+<div class="block">Throws an <code>IllegalStateException</code> when this pool
has been
+ closed.</div>
+</dd>
+</dl>
+<a name="_B_">
+<!-- -->
+</a>
+<h2 class="title">B</h2>
+<dl>
+<dt><a href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html"
title="class in org.apache.commons.pool2.impl"><span
class="strong">BaseGenericObjectPool</span></a><<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="type
parameter in BaseGenericObjectPool">T</a>> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">Base class that provides common functionality for <a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl"><code>GenericObjectPool</code></a>
+ and <a href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html"
title="class in
org.apache.commons.pool2.impl"><code>GenericKeyedObjectPool</code></a>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#BaseGenericObjectPool(org.apache.commons.pool2.impl.BaseObjectPoolConfig,%20java.lang.String,%20java.lang.String)">BaseGenericObjectPool(BaseObjectPoolConfig,
String, String)</a></span> - Constructor for class
org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">Handles JMX registration (if required) and the
initialization required for
+ monitoring.</div>
+</dd>
+<dt><a href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html"
title="class in org.apache.commons.pool2"><span
class="strong">BaseKeyedPooledObjectFactory</span></a><<a
href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type
parameter in BaseKeyedPooledObjectFactory">K</a>,<a
href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type
parameter in BaseKeyedPooledObjectFactory">V</a>> - Class in <a
href="./org/apache/commons/pool2/package-summary.html">org.apache.commons.pool2</a></dt>
+<dd>
+<div class="block">A base implementation of
<code>KeyedPooledObjectFactory</code>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#BaseKeyedPooledObjectFactory()">BaseKeyedPooledObjectFactory()</a></span>
- Constructor for class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html"
title="class in org.apache.commons.pool2">BaseKeyedPooledObjectFactory</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/commons/pool2/BaseObjectPool.html" title="class in
org.apache.commons.pool2"><span class="strong">BaseObjectPool</span></a><<a
href="./org/apache/commons/pool2/BaseObjectPool.html" title="type parameter in
BaseObjectPool">T</a>> - Class in <a
href="./org/apache/commons/pool2/package-summary.html">org.apache.commons.pool2</a></dt>
+<dd>
+<div class="block">A simple base implementation of <a
href="./org/apache/commons/pool2/ObjectPool.html" title="interface in
org.apache.commons.pool2"><code>ObjectPool</code></a>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BaseObjectPool.html#BaseObjectPool()">BaseObjectPool()</a></span>
- Constructor for class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BaseObjectPool.html" title="class in
org.apache.commons.pool2">BaseObjectPool</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html"
title="class in org.apache.commons.pool2.impl"><span
class="strong">BaseObjectPoolConfig</span></a> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">Provides the implementation for the common attributes
shared by the
+ sub-classes.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#BaseObjectPoolConfig()">BaseObjectPoolConfig()</a></span>
- Constructor for class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/commons/pool2/BasePooledObjectFactory.html"
title="class in org.apache.commons.pool2"><span
class="strong">BasePooledObjectFactory</span></a><<a
href="./org/apache/commons/pool2/BasePooledObjectFactory.html" title="type
parameter in BasePooledObjectFactory">T</a>> - Class in <a
href="./org/apache/commons/pool2/package-summary.html">org.apache.commons.pool2</a></dt>
+<dd>
+<div class="block">A base implementation of
<code>PoolableObjectFactory</code>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BasePooledObjectFactory.html#BasePooledObjectFactory()">BasePooledObjectFactory()</a></span>
- Constructor for class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BasePooledObjectFactory.html" title="class in
org.apache.commons.pool2">BasePooledObjectFactory</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BaseObjectPool.html#borrowObject()">borrowObject()</a></span>
- Method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BaseObjectPool.html" title="class in
org.apache.commons.pool2">BaseObjectPool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#borrowObject(K)">borrowObject(K)</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Equivalent to <code><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#borrowObject(K,%20long)"><code>borrowObject</code></a>(key,
+ <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMaxWaitMillis()"><code>BaseGenericObjectPool.getMaxWaitMillis()</code></a>)</code>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#borrowObject(K,%20long)">borrowObject(K,
long)</a></span> - Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Borrows an object from the sub-pool associated with the
given key using
+ the specified waiting time which only applies if
+ <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted()"><code>BaseGenericObjectPool.getBlockWhenExhausted()</code></a>
is true.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#borrowObject()">borrowObject()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Equivalent to <code><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#borrowObject(long)"><code>borrowObject</code></a>(<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getMaxWaitMillis()"><code>BaseGenericObjectPool.getMaxWaitMillis()</code></a>)</code>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#borrowObject(long)">borrowObject(long)</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Borrow an object from the pool using the specific waiting
time which only
+ applies if <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted()"><code>BaseGenericObjectPool.getBlockWhenExhausted()</code></a>
is true.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#borrowObject()">borrowObject()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/SoftReferenceObjectPool.html"
title="class in org.apache.commons.pool2.impl">SoftReferenceObjectPool</a></dt>
+<dd>
+<div class="block">Borrow an object from the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/KeyedObjectPool.html#borrowObject(K)">borrowObject(K)</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/KeyedObjectPool.html" title="interface in
org.apache.commons.pool2">KeyedObjectPool</a></dt>
+<dd>
+<div class="block">Obtains an instance from this pool for the specified
<code>key</code>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/ObjectPool.html#borrowObject()">borrowObject()</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/ObjectPool.html" title="interface in
org.apache.commons.pool2">ObjectPool</a></dt>
+<dd>
+<div class="block">Obtains an instance from this pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#borrowObject(K)">borrowObject(K)</a></span>
- Method in class org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html"
title="class in org.apache.commons.pool2.proxy">ProxiedKeyedObjectPool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/ProxiedObjectPool.html#borrowObject()">borrowObject()</a></span>
- Method in class org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="class in
org.apache.commons.pool2.proxy">ProxiedObjectPool</a></dt>
+<dd> </dd>
+</dl>
+<a name="_C_">
+<!-- -->
+</a>
+<h2 class="title">C</h2>
+<dl>
+<dt><a href="./org/apache/commons/pool2/proxy/CglibProxySource.html"
title="class in org.apache.commons.pool2.proxy"><span
class="strong">CglibProxySource</span></a><<a
href="./org/apache/commons/pool2/proxy/CglibProxySource.html" title="type
parameter in CglibProxySource">T</a>> - Class in <a
href="./org/apache/commons/pool2/proxy/package-summary.html">org.apache.commons.pool2.proxy</a></dt>
+<dd>
+<div class="block">Provides proxy objects using CGLib.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/CglibProxySource.html#CglibProxySource(java.lang.Class)">CglibProxySource(Class<?
extends T>)</a></span> - Constructor for class
org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/CglibProxySource.html" title="class in
org.apache.commons.pool2.proxy">CglibProxySource</a></dt>
+<dd>
+<div class="block">Create a new proxy source for the given class.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PoolUtils.html#checkMinIdle(org.apache.commons.pool2.ObjectPool,%20int,%20long)">checkMinIdle(ObjectPool<T>,
int, long)</a></span> - Static method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PoolUtils.html" title="class in
org.apache.commons.pool2">PoolUtils</a></dt>
+<dd>
+<div class="block">Periodically check the idle object count for the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PoolUtils.html#checkMinIdle(org.apache.commons.pool2.KeyedObjectPool,%20K,%20int,%20long)">checkMinIdle(KeyedObjectPool<K,
V>, K, int, long)</a></span> - Static method in class
org.apache.commons.pool2.<a href="./org/apache/commons/pool2/PoolUtils.html"
title="class in org.apache.commons.pool2">PoolUtils</a></dt>
+<dd>
+<div class="block">Periodically check the idle object count for the key in the
keyedPool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PoolUtils.html#checkMinIdle(org.apache.commons.pool2.KeyedObjectPool,%20java.util.Collection,%20int,%20long)">checkMinIdle(KeyedObjectPool<K,
V>, Collection<K>, int, long)</a></span> - Static method in class
org.apache.commons.pool2.<a href="./org/apache/commons/pool2/PoolUtils.html"
title="class in org.apache.commons.pool2">PoolUtils</a></dt>
+<dd>
+<div class="block">Periodically check the idle object count for each key in the
+ <code>Collection</code> <code>keys</code> in the keyedPool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PoolUtils.html#checkRethrow(java.lang.Throwable)">checkRethrow(Throwable)</a></span>
- Static method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PoolUtils.html" title="class in
org.apache.commons.pool2">PoolUtils</a></dt>
+<dd>
+<div class="block">Should the supplied Throwable be re-thrown (eg if it is an
instance of
+ one of the Throwables that should never be swallowed).</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BaseObjectPool.html#clear()">clear()</a></span>
- Method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BaseObjectPool.html" title="class in
org.apache.commons.pool2">BaseObjectPool</a></dt>
+<dd>
+<div class="block">Not supported in this base implementation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#clear()">clear()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Clears any objects sitting idle in the pool by removing
them from the
+ idle instance sub-pools and then invoking the configured
+ PoolableObjectFactory's
+ <a
href="./org/apache/commons/pool2/KeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)"><code>KeyedPooledObjectFactory.destroyObject(Object,
PooledObject)</code></a>
+ method on each idle instance.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#clear(K)">clear(K)</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Clears the specified sub-pool, removing all pooled instances
+ corresponding to the given <code>key</code>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#clear()">clear()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Clears any objects sitting idle in the pool by removing
them from the
+ idle instance pool and then invoking the configured
+ <a
href="./org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)"><code>PooledObjectFactory.destroyObject(PooledObject)</code></a>
method on each
+ idle instance.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#clear()">clear()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/SoftReferenceObjectPool.html"
title="class in org.apache.commons.pool2.impl">SoftReferenceObjectPool</a></dt>
+<dd>
+<div class="block">Clears any objects sitting idle in the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/KeyedObjectPool.html#clear()">clear()</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/KeyedObjectPool.html" title="interface in
org.apache.commons.pool2">KeyedObjectPool</a></dt>
+<dd>
+<div class="block">Clears the pool, removing all pooled instances (optional
operation).</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/KeyedObjectPool.html#clear(K)">clear(K)</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/KeyedObjectPool.html" title="interface in
org.apache.commons.pool2">KeyedObjectPool</a></dt>
+<dd>
+<div class="block">Clears the specified pool, removing all pooled instances
corresponding to
+ the given <code>key</code> (optional operation).</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/ObjectPool.html#clear()">clear()</a></span> -
Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/ObjectPool.html" title="interface in
org.apache.commons.pool2">ObjectPool</a></dt>
+<dd>
+<div class="block">Clears any objects sitting idle in the pool, releasing any
associated
+ resources (optional operation).</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#clear()">clear()</a></span>
- Method in class org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html"
title="class in org.apache.commons.pool2.proxy">ProxiedKeyedObjectPool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#clear(K)">clear(K)</a></span>
- Method in class org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html"
title="class in org.apache.commons.pool2.proxy">ProxiedKeyedObjectPool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/ProxiedObjectPool.html#clear()">clear()</a></span>
- Method in class org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="class in
org.apache.commons.pool2.proxy">ProxiedObjectPool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#clearOldest()">clearOldest()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Clears oldest 15% of objects in pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html#clone()">clone()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html"
title="class in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolConfig</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html#clone()">clone()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html"
title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BaseObjectPool.html#close()">close()</a></span>
- Method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BaseObjectPool.html" title="class in
org.apache.commons.pool2">BaseObjectPool</a></dt>
+<dd>
+<div class="block">Close this pool, and free any resources associated with
it.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#close()">close()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">Closes the pool, destroys the remaining idle objects and,
if registered
+ in JMX, deregisters it.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#close()">close()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Closes the keyed object pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#close()">close()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Closes the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#close()">close()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/SoftReferenceObjectPool.html"
title="class in org.apache.commons.pool2.impl">SoftReferenceObjectPool</a></dt>
+<dd>
+<div class="block">Close this pool, and free any resources associated with
it.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/KeyedObjectPool.html#close()">close()</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/KeyedObjectPool.html" title="interface in
org.apache.commons.pool2">KeyedObjectPool</a></dt>
+<dd>
+<div class="block">Close this pool, and free any resources associated with
it.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/ObjectPool.html#close()">close()</a></span> -
Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/ObjectPool.html" title="interface in
org.apache.commons.pool2">ObjectPool</a></dt>
+<dd>
+<div class="block">Close this pool, and free any resources associated with
it.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html#close()">close()</a></span>
- Method in class org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/ProxiedKeyedObjectPool.html"
title="class in org.apache.commons.pool2.proxy">ProxiedKeyedObjectPool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/ProxiedObjectPool.html#close()">close()</a></span>
- Method in class org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/ProxiedObjectPool.html" title="class in
org.apache.commons.pool2.proxy">ProxiedObjectPool</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html#compareTo(org.apache.commons.pool2.PooledObject)">compareTo(PooledObject<T>)</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in
org.apache.commons.pool2.impl">DefaultPooledObject</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PooledObject.html#compareTo(org.apache.commons.pool2.PooledObject)">compareTo(PooledObject<T>)</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PooledObject.html" title="interface in
org.apache.commons.pool2">PooledObject</a></dt>
+<dd>
+<div class="block">Orders instances based on idle time - i.e.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#create(K)">create(K)</a></span>
- Method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html"
title="class in org.apache.commons.pool2">BaseKeyedPooledObjectFactory</a></dt>
+<dd>
+<div class="block">Create an instance that can be served by the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BasePooledObjectFactory.html#create()">create()</a></span>
- Method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BasePooledObjectFactory.html" title="class in
org.apache.commons.pool2">BasePooledObjectFactory</a></dt>
+<dd>
+<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>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/CglibProxySource.html#createProxy(T,%20org.apache.commons.pool2.UsageTracking)">createProxy(T,
UsageTracking<T>)</a></span> - Method in class
org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/CglibProxySource.html" title="class in
org.apache.commons.pool2.proxy">CglibProxySource</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/proxy/JdkProxySource.html#createProxy(T,%20org.apache.commons.pool2.UsageTracking)">createProxy(T,
UsageTracking<T>)</a></span> - Method in class
org.apache.commons.pool2.proxy.<a
href="./org/apache/commons/pool2/proxy/JdkProxySource.html" title="class in
org.apache.commons.pool2.proxy">JdkProxySource</a></dt>
+<dd> </dd>
+</dl>
+<a name="_D_">
+<!-- -->
+</a>
+<h2 class="title">D</h2>
+<dl>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html#deallocate()">deallocate()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in
org.apache.commons.pool2.impl">DefaultPooledObject</a></dt>
+<dd>
+<div class="block">Deallocates the object and sets it <a
href="./org/apache/commons/pool2/PooledObjectState.html#IDLE"><code>IDLE</code></a>
+ if it is currently <a
href="./org/apache/commons/pool2/PooledObjectState.html#ALLOCATED"><code>ALLOCATED</code></a>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PooledObject.html#deallocate()">deallocate()</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PooledObject.html" title="interface in
org.apache.commons.pool2">PooledObject</a></dt>
+<dd>
+<div class="block">Deallocates the object and sets it <a
href="./org/apache/commons/pool2/PooledObjectState.html#IDLE"><code>IDLE</code></a>
+ if it is currently <a
href="./org/apache/commons/pool2/PooledObjectState.html#ALLOCATED"><code>ALLOCATED</code></a>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_BLOCK_WHEN_EXHAUSTED">DEFAULT_BLOCK_WHEN_EXHAUSTED</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>blockWhenExhausted</code>
configuration
+ attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_EVICTION_POLICY_CLASS_NAME">DEFAULT_EVICTION_POLICY_CLASS_NAME</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the
<code>evictionPolicyClassName</code> configuration
+ attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_FAIRNESS">DEFAULT_FAIRNESS</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>fairness</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_JMX_ENABLE">DEFAULT_JMX_ENABLE</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for enabling JMX for pools created with a
configuration
+ instance.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_JMX_NAME_BASE">DEFAULT_JMX_NAME_BASE</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the base name to use to name JMX
enabled pools
+ created with a configuration instance.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_JMX_NAME_PREFIX">DEFAULT_JMX_NAME_PREFIX</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the prefix used to name JMX enabled
pools created
+ with a configuration instance.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_LIFO">DEFAULT_LIFO</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>lifo</code> configuration
attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html#DEFAULT_MAX_IDLE">DEFAULT_MAX_IDLE</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html"
title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>maxIdle</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html#DEFAULT_MAX_IDLE_PER_KEY">DEFAULT_MAX_IDLE_PER_KEY</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html"
title="class in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>minIdlePerKey</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html#DEFAULT_MAX_TOTAL">DEFAULT_MAX_TOTAL</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html"
title="class in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>maxTotal</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html#DEFAULT_MAX_TOTAL">DEFAULT_MAX_TOTAL</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html"
title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>maxTotal</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html#DEFAULT_MAX_TOTAL_PER_KEY">DEFAULT_MAX_TOTAL_PER_KEY</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html"
title="class in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>maxTotalPerKey</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_MAX_WAIT_MILLIS">DEFAULT_MAX_WAIT_MILLIS</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>maxWait</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS">DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the
<code>minEvictableIdleTimeMillis</code>
+ configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html#DEFAULT_MIN_IDLE">DEFAULT_MIN_IDLE</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html"
title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>minIdle</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html#DEFAULT_MIN_IDLE_PER_KEY">DEFAULT_MIN_IDLE_PER_KEY</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html"
title="class in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>minIdlePerKey</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_NUM_TESTS_PER_EVICTION_RUN">DEFAULT_NUM_TESTS_PER_EVICTION_RUN</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the
<code>numTestsPerEvictionRun</code> configuration
+ attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS">DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the
<code>softMinEvictableIdleTimeMillis</code>
+ configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_TEST_ON_BORROW">DEFAULT_TEST_ON_BORROW</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>testOnBorrow</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_TEST_ON_CREATE">DEFAULT_TEST_ON_CREATE</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>testOnCreate</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_TEST_ON_RETURN">DEFAULT_TEST_ON_RETURN</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>testOnReturn</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_TEST_WHILE_IDLE">DEFAULT_TEST_WHILE_IDLE</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the <code>testWhileIdle</code>
configuration attribute.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS">DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS</a></span>
- Static variable in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">The default value for the
<code>timeBetweenEvictionRunsMillis</code>
+ configuration attribute.</div>
+</dd>
+<dt><a href="./org/apache/commons/pool2/impl/DefaultEvictionPolicy.html"
title="class in org.apache.commons.pool2.impl"><span
class="strong">DefaultEvictionPolicy</span></a><<a
href="./org/apache/commons/pool2/impl/DefaultEvictionPolicy.html" title="type
parameter in DefaultEvictionPolicy">T</a>> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">Provides the default implementation of <a
href="./org/apache/commons/pool2/impl/EvictionPolicy.html" title="interface in
org.apache.commons.pool2.impl"><code>EvictionPolicy</code></a> used by the
+ pools.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultEvictionPolicy.html#DefaultEvictionPolicy()">DefaultEvictionPolicy()</a></span>
- Constructor for class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultEvictionPolicy.html" title="class
in org.apache.commons.pool2.impl">DefaultEvictionPolicy</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/commons/pool2/impl/DefaultPooledObject.html"
title="class in org.apache.commons.pool2.impl"><span
class="strong">DefaultPooledObject</span></a><<a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html" title="type
parameter in DefaultPooledObject">T</a>> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">This wrapper is used to track the additional information,
such as state, for
+ the pooled objects.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html#DefaultPooledObject(T)">DefaultPooledObject(T)</a></span>
- Constructor for class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in
org.apache.commons.pool2.impl">DefaultPooledObject</a></dt>
+<dd>
+<div class="block">Create a new instance that wraps the provided object so
that the pool can
+ track the state of the pooled object.</div>
+</dd>
+<dt><a href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html"
title="class in org.apache.commons.pool2.impl"><span
class="strong">DefaultPooledObjectInfo</span></a> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">Implementation of object that is used to provide
information on pooled
+ objects via JMX.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html#DefaultPooledObjectInfo(org.apache.commons.pool2.PooledObject)">DefaultPooledObjectInfo(PooledObject<?>)</a></span>
- Constructor for class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html"
title="class in org.apache.commons.pool2.impl">DefaultPooledObjectInfo</a></dt>
+<dd>
+<div class="block">Create a new instance for the given pooled object.</div>
+</dd>
+<dt><a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.html"
title="interface in org.apache.commons.pool2.impl"><span
class="strong">DefaultPooledObjectInfoMBean</span></a> - Interface in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">The interface that defines the information about pooled
objects that will be
+ exposed via JMX.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)">destroyObject(K,
PooledObject<V>)</a></span> - Method in class
org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html"
title="class in org.apache.commons.pool2">BaseKeyedPooledObjectFactory</a></dt>
+<dd>
+<div class="block">Destroy an instance no longer needed by the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/BasePooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)">destroyObject(PooledObject<T>)</a></span>
- Method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/BasePooledObjectFactory.html" title="class in
org.apache.commons.pool2">BasePooledObjectFactory</a></dt>
+<dd>
+<div class="block">No-op.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/KeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)">destroyObject(K,
PooledObject<V>)</a></span> - Method in interface
org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/KeyedPooledObjectFactory.html"
title="interface in org.apache.commons.pool2">KeyedPooledObjectFactory</a></dt>
+<dd>
+<div class="block">Destroy an instance no longer needed by the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)">destroyObject(PooledObject<T>)</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PooledObjectFactory.html" title="interface in
org.apache.commons.pool2">PooledObjectFactory</a></dt>
+<dd>
+<div class="block">Destroys an instance no longer needed by the pool.</div>
+</dd>
+</dl>
+<a name="_E_">
+<!-- -->
+</a>
+<h2 class="title">E</h2>
+<dl>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html#endEvictionTest(java.util.Deque)">endEvictionTest(Deque<PooledObject<T>>)</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in
org.apache.commons.pool2.impl">DefaultPooledObject</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PooledObject.html#endEvictionTest(java.util.Deque)">endEvictionTest(Deque<PooledObject<T>>)</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PooledObject.html" title="interface in
org.apache.commons.pool2">PooledObject</a></dt>
+<dd>
+<div class="block">Called to inform the object that the eviction test has
ended.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PooledObject.html#equals(java.lang.Object)">equals(Object)</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PooledObject.html" title="interface in
org.apache.commons.pool2">PooledObject</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PoolUtils.html#erodingPool(org.apache.commons.pool2.ObjectPool)">erodingPool(ObjectPool<T>)</a></span>
- Static method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PoolUtils.html" title="class in
org.apache.commons.pool2">PoolUtils</a></dt>
+<dd>
+<div class="block">Returns a pool that adaptively decreases its size when idle
objects are
+ no longer needed.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PoolUtils.html#erodingPool(org.apache.commons.pool2.ObjectPool,%20float)">erodingPool(ObjectPool<T>,
float)</a></span> - Static method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PoolUtils.html" title="class in
org.apache.commons.pool2">PoolUtils</a></dt>
+<dd>
+<div class="block">Returns a pool that adaptively decreases its size when idle
objects are
+ no longer needed.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PoolUtils.html#erodingPool(org.apache.commons.pool2.KeyedObjectPool)">erodingPool(KeyedObjectPool<K,
V>)</a></span> - Static method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PoolUtils.html" title="class in
org.apache.commons.pool2">PoolUtils</a></dt>
+<dd>
+<div class="block">Returns a pool that adaptively decreases its size when idle
objects are
+ no longer needed.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PoolUtils.html#erodingPool(org.apache.commons.pool2.KeyedObjectPool,%20float)">erodingPool(KeyedObjectPool<K,
V>, float)</a></span> - Static method in class org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PoolUtils.html" title="class in
org.apache.commons.pool2">PoolUtils</a></dt>
+<dd>
+<div class="block">Returns a pool that adaptively decreases its size when idle
objects are
+ no longer needed.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PoolUtils.html#erodingPool(org.apache.commons.pool2.KeyedObjectPool,%20float,%20boolean)">erodingPool(KeyedObjectPool<K,
V>, float, boolean)</a></span> - Static method in class
org.apache.commons.pool2.<a href="./org/apache/commons/pool2/PoolUtils.html"
title="class in org.apache.commons.pool2">PoolUtils</a></dt>
+<dd>
+<div class="block">Returns a pool that adaptively decreases its size when idle
objects are
+ no longer needed.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#evict()">evict()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">Perform <code>numTests</code> idle object eviction tests,
evicting
+ examined objects that meet the criteria for eviction.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultEvictionPolicy.html#evict(org.apache.commons.pool2.impl.EvictionConfig,%20org.apache.commons.pool2.PooledObject,%20int)">evict(EvictionConfig,
PooledObject<T>, int)</a></span> - Method in class
org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultEvictionPolicy.html" title="class
in org.apache.commons.pool2.impl">DefaultEvictionPolicy</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/EvictionPolicy.html#evict(org.apache.commons.pool2.impl.EvictionConfig,%20org.apache.commons.pool2.PooledObject,%20int)">evict(EvictionConfig,
PooledObject<T>, int)</a></span> - Method in interface
org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/EvictionPolicy.html" title="interface in
org.apache.commons.pool2.impl">EvictionPolicy</a></dt>
+<dd>
+<div class="block">This method is called to test if an idle object in the pool
should be
+ evicted or not.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#evict()">evict()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Perform <code>numTests</code> idle object eviction tests,
evicting
+ examined objects that meet the criteria for eviction.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#evict()">evict()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Perform <code>numTests</code> idle object eviction tests,
evicting
+ examined objects that meet the criteria for eviction.</div>
+</dd>
+<dt><a href="./org/apache/commons/pool2/impl/EvictionConfig.html" title="class
in org.apache.commons.pool2.impl"><span
class="strong">EvictionConfig</span></a> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">This class is used by pool implementations to pass
configuration information
+ to <a href="./org/apache/commons/pool2/impl/EvictionPolicy.html"
title="interface in
org.apache.commons.pool2.impl"><code>EvictionPolicy</code></a> instances.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/EvictionConfig.html#EvictionConfig(long,%20long,%20int)">EvictionConfig(long,
long, int)</a></span> - Constructor for class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/EvictionConfig.html" title="class in
org.apache.commons.pool2.impl">EvictionConfig</a></dt>
+<dd>
+<div class="block">Create a new eviction configuration with the specified
parameters.</div>
+</dd>
+<dt><a href="./org/apache/commons/pool2/impl/EvictionPolicy.html"
title="interface in org.apache.commons.pool2.impl"><span
class="strong">EvictionPolicy</span></a><<a
href="./org/apache/commons/pool2/impl/EvictionPolicy.html" title="type
parameter in EvictionPolicy">T</a>> - Interface in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">To provide a custom eviction policy (i.e.</div>
+</dd>
+</dl>
+<a name="_G_">
+<!-- -->
+</a>
+<h2 class="title">G</h2>
+<dl>
+<dt><a href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html"
title="class in org.apache.commons.pool2.impl"><span
class="strong">GenericKeyedObjectPool</span></a><<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="type
parameter in GenericKeyedObjectPool">K</a>,<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="type
parameter in GenericKeyedObjectPool">T</a>> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">A configurable <code>KeyedObjectPool</code>
implementation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool(org.apache.commons.pool2.KeyedPooledObjectFactory)">GenericKeyedObjectPool(KeyedPooledObjectFactory<K,
T>)</a></span> - Constructor for class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Create a new <code>GenericKeyedObjectPool</code> using
defaults from
+ <a href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html"
title="class in
org.apache.commons.pool2.impl"><code>GenericKeyedObjectPoolConfig</code></a>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#GenericKeyedObjectPool(org.apache.commons.pool2.KeyedPooledObjectFactory,%20org.apache.commons.pool2.impl.GenericKeyedObjectPoolConfig)">GenericKeyedObjectPool(KeyedPooledObjectFactory<K,
T>, GenericKeyedObjectPoolConfig)</a></span> - Constructor for class
org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Create a new <code>GenericKeyedObjectPool</code> using a
specific
+ configuration.</div>
+</dd>
+<dt><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html"
title="class in org.apache.commons.pool2.impl"><span
class="strong">GenericKeyedObjectPoolConfig</span></a> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">A simple "struct" encapsulating the configuration for a
+ <a href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html"
title="class in
org.apache.commons.pool2.impl"><code>GenericKeyedObjectPool</code></a>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html#GenericKeyedObjectPoolConfig()">GenericKeyedObjectPoolConfig()</a></span>
- Constructor for class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html"
title="class in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolConfig</a></dt>
+<dd>
+<div class="block">Create a new configuration with default settings.</div>
+</dd>
+<dt><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html"
title="interface in org.apache.commons.pool2.impl"><span
class="strong">GenericKeyedObjectPoolMXBean</span></a><<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html"
title="type parameter in GenericKeyedObjectPoolMXBean">K</a>> - Interface in
<a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">Defines the methods that will be made available via
JMX.</div>
+</dd>
+<dt><a href="./org/apache/commons/pool2/impl/GenericObjectPool.html"
title="class in org.apache.commons.pool2.impl"><span
class="strong">GenericObjectPool</span></a><<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="type
parameter in GenericObjectPool">T</a>> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">A configurable <a
href="./org/apache/commons/pool2/ObjectPool.html" title="interface in
org.apache.commons.pool2"><code>ObjectPool</code></a> implementation.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#GenericObjectPool(org.apache.commons.pool2.PooledObjectFactory)">GenericObjectPool(PooledObjectFactory<T>)</a></span>
- Constructor for class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Create a new <code>GenericObjectPool</code> using defaults
from
+ <a href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html"
title="class in
org.apache.commons.pool2.impl"><code>GenericObjectPoolConfig</code></a>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#GenericObjectPool(org.apache.commons.pool2.PooledObjectFactory,%20org.apache.commons.pool2.impl.GenericObjectPoolConfig)">GenericObjectPool(PooledObjectFactory<T>,
GenericObjectPoolConfig)</a></span> - Constructor for class
org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Create a new <code>GenericObjectPool</code> using a specific
+ configuration.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#GenericObjectPool(org.apache.commons.pool2.PooledObjectFactory,%20org.apache.commons.pool2.impl.GenericObjectPoolConfig,%20org.apache.commons.pool2.impl.AbandonedConfig)">GenericObjectPool(PooledObjectFactory<T>,
GenericObjectPoolConfig, AbandonedConfig)</a></span> - Constructor for class
org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Create a new <code>GenericObjectPool</code> that tracks and
destroys
+ objects that are checked out, but never returned to the pool.</div>
+</dd>
+<dt><a href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html"
title="class in org.apache.commons.pool2.impl"><span
class="strong">GenericObjectPoolConfig</span></a> - Class in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">A simple "struct" encapsulating the configuration for a
+ <a href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class
in org.apache.commons.pool2.impl"><code>GenericObjectPool</code></a>.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html#GenericObjectPoolConfig()">GenericObjectPoolConfig()</a></span>
- Constructor for class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolConfig.html"
title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a></dt>
+<dd> </dd>
+<dt><a href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html"
title="interface in org.apache.commons.pool2.impl"><span
class="strong">GenericObjectPoolMXBean</span></a> - Interface in <a
href="./org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></dt>
+<dd>
+<div class="block">Defines the methods that will be made available via
JMX.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html#getActiveTimeMillis()">getActiveTimeMillis()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in
org.apache.commons.pool2.impl">DefaultPooledObject</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PooledObject.html#getActiveTimeMillis()">getActiveTimeMillis()</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PooledObject.html" title="interface in
org.apache.commons.pool2">PooledObject</a></dt>
+<dd>
+<div class="block">Obtain the time in milliseconds that this object last spent
in the the
+ active state (it may still be active in which case subsequent calls will
+ return an increased value).</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted()">getBlockWhenExhausted()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">Returns whether to block when the
<code>borrowObject()</code> method is
+ invoked when the pool is exhausted (the maximum number of "active"
+ objects has been reached).</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#getBlockWhenExhausted()">getBlockWhenExhausted()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">Get the value for the <code>blockWhenExhausted</code>
configuration attribute
+ for pools created with this configuration instance.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html#getBlockWhenExhausted()">getBlockWhenExhausted()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted()"><code>BaseGenericObjectPool.getBlockWhenExhausted()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getBlockWhenExhausted()">getBlockWhenExhausted()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBlockWhenExhausted()"><code>BaseGenericObjectPool.getBlockWhenExhausted()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBorrowedCount()">getBorrowedCount()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">The total number of objects successfully borrowed from this
pool over the
+ lifetime of the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html#getBorrowedCount()">getBorrowedCount()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in
org.apache.commons.pool2.impl">DefaultPooledObject</a></dt>
+<dd>
+<div class="block">Get the number of times this object has been borrowed.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html#getBorrowedCount()">getBorrowedCount()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html"
title="class in org.apache.commons.pool2.impl">DefaultPooledObjectInfo</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.html#getBorrowedCount()">getBorrowedCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.html"
title="interface in
org.apache.commons.pool2.impl">DefaultPooledObjectInfoMBean</a></dt>
+<dd>
+<div class="block">Get the number of times this object has been borrowed.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html#getBorrowedCount()">getBorrowedCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBorrowedCount()"><code>BaseGenericObjectPool.getBorrowedCount()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getBorrowedCount()">getBorrowedCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getBorrowedCount()"><code>BaseGenericObjectPool.getBorrowedCount()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getCreatedCount()">getCreatedCount()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">The total number of objects created for this pool over the
lifetime of
+ the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html#getCreatedCount()">getCreatedCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getCreatedCount()"><code>BaseGenericObjectPool.getCreatedCount()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getCreatedCount()">getCreatedCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getCreatedCount()"><code>BaseGenericObjectPool.getCreatedCount()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html#getCreateTime()">getCreateTime()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in
org.apache.commons.pool2.impl">DefaultPooledObject</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html#getCreateTime()">getCreateTime()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html"
title="class in org.apache.commons.pool2.impl">DefaultPooledObjectInfo</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.html#getCreateTime()">getCreateTime()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.html"
title="interface in
org.apache.commons.pool2.impl">DefaultPooledObjectInfoMBean</a></dt>
+<dd>
+<div class="block">Obtain the time (using the same basis as
+ <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/System.html?is-external=true#currentTimeMillis()"
title="class or interface in
java.lang"><code>System.currentTimeMillis()</code></a>) that pooled object was
created.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/PooledObject.html#getCreateTime()">getCreateTime()</a></span>
- Method in interface org.apache.commons.pool2.<a
href="./org/apache/commons/pool2/PooledObject.html" title="interface in
org.apache.commons.pool2">PooledObject</a></dt>
+<dd>
+<div class="block">Obtain the time (using the same basis as
+ <a
href="http://docs.oracle.com/javase/6/docs/api/java/lang/System.html?is-external=true#currentTimeMillis()"
title="class or interface in
java.lang"><code>System.currentTimeMillis()</code></a>) that this object was
created.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html#getCreateTimeFormatted()">getCreateTimeFormatted()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfo.html"
title="class in org.apache.commons.pool2.impl">DefaultPooledObjectInfo</a></dt>
+<dd> </dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.html#getCreateTimeFormatted()">getCreateTimeFormatted()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/DefaultPooledObjectInfoMBean.html"
title="interface in
org.apache.commons.pool2.impl">DefaultPooledObjectInfoMBean</a></dt>
+<dd>
+<div class="block">Obtain the time that pooled object was created.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getCreationStackTrace()">getCreationStackTrace()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">Provides the stack trace for the call that created this
pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html#getCreationStackTrace()">getCreationStackTrace()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getCreationStackTrace()"><code>BaseGenericObjectPool.getCreationStackTrace()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getCreationStackTrace()">getCreationStackTrace()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getCreationStackTrace()"><code>BaseGenericObjectPool.getCreationStackTrace()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedByBorrowValidationCount()">getDestroyedByBorrowValidationCount()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">The total number of objects destroyed by this pool as a
result of failing
+ validation during <code>borrowObject()</code> over the lifetime of the
+ pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html#getDestroyedByBorrowValidationCount()">getDestroyedByBorrowValidationCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedByBorrowValidationCount()"><code>BaseGenericObjectPool.getDestroyedByBorrowValidationCount()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getDestroyedByBorrowValidationCount()">getDestroyedByBorrowValidationCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedByBorrowValidationCount()"><code>BaseGenericObjectPool.getDestroyedByBorrowValidationCount()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedByEvictorCount()">getDestroyedByEvictorCount()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">The total number of objects destroyed by the evictor
associated with this
+ pool over the lifetime of the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html#getDestroyedByEvictorCount()">getDestroyedByEvictorCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedByEvictorCount()"><code>BaseGenericObjectPool.getDestroyedByEvictorCount()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getDestroyedByEvictorCount()">getDestroyedByEvictorCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedByEvictorCount()"><code>BaseGenericObjectPool.getDestroyedByEvictorCount()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedCount()">getDestroyedCount()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">The total number of objects destroyed by this pool over the
lifetime of
+ the pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html#getDestroyedCount()">getDestroyedCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericKeyedObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedCount()"><code>BaseGenericObjectPool.getDestroyedCount()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getDestroyedCount()">getDestroyedCount()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getDestroyedCount()"><code>BaseGenericObjectPool.getDestroyedCount()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getEvictionPolicyClassName()">getEvictionPolicyClassName()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">Returns the name of the <a
href="./org/apache/commons/pool2/impl/EvictionPolicy.html" title="interface in
org.apache.commons.pool2.impl"><code>EvictionPolicy</code></a> implementation
that is
+ used by this pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#getEvictionPolicyClassName()">getEvictionPolicyClassName()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">Get the value for the <code>evictionPolicyClassName</code>
configuration
+ attribute for pools created with this configuration instance.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html#getFactory()">getFactory()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class
in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a></dt>
+<dd>
+<div class="block">Obtain a reference to the factory used to create, destroy
and validate
+ the objects used by this pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#getFactory()">getFactory()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Obtain a reference to the factory used to create, destroy
and validate
+ the objects used by this pool.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#getFactory()">getFactory()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/SoftReferenceObjectPool.html"
title="class in org.apache.commons.pool2.impl">SoftReferenceObjectPool</a></dt>
+<dd>
+<div class="block">Returns the <a
href="./org/apache/commons/pool2/PooledObjectFactory.html" title="interface in
org.apache.commons.pool2"><code>PooledObjectFactory</code></a> used by this
pool to create and
+ manage object instances.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#getFactoryType()">getFactoryType()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in
org.apache.commons.pool2.impl">GenericObjectPool</a></dt>
+<dd>
+<div class="block">Return the type - including the specific type rather than
the generic -
+ of the factory.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html#getFactoryType()">getFactoryType()</a></span>
- Method in interface org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/GenericObjectPoolMXBean.html"
title="interface in
org.apache.commons.pool2.impl">GenericObjectPoolMXBean</a></dt>
+<dd>
+<div class="block">See <a
href="./org/apache/commons/pool2/impl/GenericObjectPool.html#getFactoryType()"><code>GenericObjectPool.getFactoryType()</code></a></div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html#getFairness()">getFairness()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class
in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></dt>
+<dd>
+<div class="block">Returns whether or not the pool serves threads waiting to
borrow objects fairly.</div>
+</dd>
+<dt><span class="strong"><a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html#getFairness()">getFairness()</a></span>
- Method in class org.apache.commons.pool2.impl.<a
href="./org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class
in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></dt>
+<dd>
+<div class="block">Get the value for the <code>fairness</code> configuration
attribute for pools
+ created with this configuration instance.</div>
+</dd>
[... 1475 lines stripped ...]
Propchange:
websites/production/commons/content/proper/commons-pool/api-2.3/index-all.html
------------------------------------------------------------------------------
svn:eol-style = native
