Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/PooledSoftReference.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/PooledSoftReference.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/PooledSoftReference.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,368 @@ +<!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>PooledSoftReference (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="PooledSoftReference (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/PooledSoftReference.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/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="class in org.apache.commons.pool2.impl"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/pool2/impl/PooledSoftReference.html" target="_top">Frames</a></li> +<li><a href="PooledSoftReference.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.impl</div> +<h2 title="Class PooledSoftReference" class="title">Class PooledSoftReference<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><a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in org.apache.commons.pool2.impl">org.apache.commons.pool2.impl.DefaultPooledObject</a><T></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.pool2.impl.PooledSoftReference<T></li> +</ul> +</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> - the type of the underlying object that the wrapped SoftReference + refers to.</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Comparable.html?is-external=true" title="class or interface in java.lang">Comparable</a><<a href="../../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><T>>, <a href="../../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><T></dd> +</dl> +<hr> +<br> +<pre>public class <a href="../../../../../src-html/org/apache/commons/pool2/impl/PooledSoftReference.html#line.33">PooledSoftReference</a><T> +extends <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in org.apache.commons.pool2.impl">DefaultPooledObject</a><T></pre> +<div class="block">Extension of <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in org.apache.commons.pool2.impl"><code>DefaultPooledObject</code></a> to wrap pooled soft references. + + <p>This class is intended to be thread-safe.</p></div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">Version:</span></dt> + <dd>$Revision: $</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/impl/PooledSoftReference.html#PooledSoftReference(java.lang.ref.SoftReference)">PooledSoftReference</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/SoftReference.html?is-external=true" title="class or interface in java.lang.ref">SoftReference</a><<a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a>> reference)</code> +<div class="block">Creates a new PooledSoftReference wrapping the provided reference.</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><a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html#getObject()">getObject</a></strong>()</code> +<div class="block">Returns the object that the wrapped SoftReference refers to.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/SoftReference.html?is-external=true" title="class or interface in java.lang.ref">SoftReference</a><<a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html#getReference()">getReference</a></strong>()</code> +<div class="block">Returns the SoftReference wrapped by this object.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html#setReference(java.lang.ref.SoftReference)">setReference</a></strong>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/SoftReference.html?is-external=true" title="class or interface in java.lang.ref">SoftReference</a><<a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a>> reference)</code> +<div class="block">Sets the wrapped reference.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html#toString()">toString</a></strong>()</code> +<div class="block">Provides a String form of the wrapper for debug purposes.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.pool2.impl.DefaultPooledObject"> +<!-- --> +</a> +<h3>Methods inherited from 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></h3> +<code><a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#allocate()">allocate</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#compareTo(org.apache.commons.pool2.PooledObject)">compareTo</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#deallocate()">deallocate</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#endEvictionTest(java.util.Deque)">endEvictionTest</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#getActiveTimeMillis()">getActiveTimeMillis</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#getBorrowedCount()">getBorrowedCount</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#getCreateTime()">getCreateTime</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#getIdleTimeMillis()">getIdleTimeMillis</a>, <a href="../. ./../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#getLastBorrowTime()">getLastBorrowTime</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#getLastReturnTime()">getLastReturnTime</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#getLastUsedTime()">getLastUsedTime</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#getState()">getState</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#invalidate()">invalidate</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#markAbandoned()">markAbandoned</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#markReturning()">markReturning</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#printStackTrace(java.io.PrintWriter)">printStackTrace</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPo oledObject.html#setLogAbandoned(boolean)">setLogAbandoned</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#startEvictionTest()">startEvictionTest</a>, <a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#use()">use</a></code></li> +</ul> +<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#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> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.pool2.PooledObject"> +<!-- --> +</a> +<h3>Methods inherited from interface org.apache.commons.pool2.<a href="../../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a></h3> +<code><a href="../../../../../org/apache/commons/pool2/PooledObject.html#equals(java.lang.Object)">equals</a>, <a href="../../../../../org/apache/commons/pool2/PooledObject.html#hashCode()">hashCode</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="PooledSoftReference(java.lang.ref.SoftReference)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>PooledSoftReference</h4> +<pre>public <a href="../../../../../src-html/org/apache/commons/pool2/impl/PooledSoftReference.html#line.43">PooledSoftReference</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/SoftReference.html?is-external=true" title="class or interface in java.lang.ref">SoftReference</a><<a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a>> reference)</pre> +<div class="block">Creates a new PooledSoftReference wrapping the provided reference.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - SoftReference to be managed by the pool</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="getObject()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getObject</h4> +<pre>public <a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a> <a href="../../../../../src-html/org/apache/commons/pool2/impl/PooledSoftReference.html#line.57">getObject</a>()</pre> +<div class="block">Returns the object that the wrapped SoftReference refers to. + <p> + Note that if the reference has been cleared, this method will return + null.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/PooledObject.html#getObject()">getObject</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#getObject()">getObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in org.apache.commons.pool2.impl">DefaultPooledObject</a><<a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>Object referred to by the SoftReference</dd></dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> <a href="../../../../../src-html/org/apache/commons/pool2/impl/PooledSoftReference.html#line.65">toString</a>()</pre> +<div class="block">Provides a String form of the wrapper for debug purposes. The format is + not fixed and may change at any time. + <p> + </div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/PooledObject.html#toString()">toString</a></code> in interface <code><a href="../../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html#toString()">toString</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/impl/DefaultPooledObject.html" title="class in org.apache.commons.pool2.impl">DefaultPooledObject</a><<a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getReference()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getReference</h4> +<pre>public <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/SoftReference.html?is-external=true" title="class or interface in java.lang.ref">SoftReference</a><<a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a>> <a href="../../../../../src-html/org/apache/commons/pool2/impl/PooledSoftReference.html#line.83">getReference</a>()</pre> +<div class="block">Returns the SoftReference wrapped by this object.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>underlying SoftReference</dd></dl> +</li> +</ul> +<a name="setReference(java.lang.ref.SoftReference)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>setReference</h4> +<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/PooledSoftReference.html#line.97">setReference</a>(<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/SoftReference.html?is-external=true" title="class or interface in java.lang.ref">SoftReference</a><<a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html" title="type parameter in PooledSoftReference">T</a>> reference)</pre> +<div class="block">Sets the wrapped reference. + + <p>This method exists to allow a new, non-registered reference to be + held by the pool to track objects that have been checked out of the pool. + The actual parameter <strong>should</strong> be a reference to the same + object that <a href="../../../../../org/apache/commons/pool2/impl/PooledSoftReference.html#getObject()"><code>getObject()</code></a> returns before calling this method.</p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>reference</code> - new reference</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/PooledSoftReference.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/impl/GenericObjectPoolMXBean.html" title="interface in org.apache.commons.pool2.impl"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="class in org.apache.commons.pool2.impl"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../../index.html?org/apache/commons/pool2/impl/PooledSoftReference.html" target="_top">Frames</a></li> +<li><a href="PooledSoftReference.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/impl/PooledSoftReference.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/SoftReferenceObjectPool.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/SoftReferenceObjectPool.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/SoftReferenceObjectPool.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,544 @@ +<!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>SoftReferenceObjectPool (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="SoftReferenceObjectPool (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/SoftReferenceObjectPool.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/impl/PooledSoftReference.html" title="class in org.apache.commons.pool2.impl"><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/impl/SoftReferenceObjectPool.html" target="_top">Frames</a></li> +<li><a href="SoftReferenceObjectPool.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.impl</div> +<h2 title="Class SoftReferenceObjectPool" class="title">Class SoftReferenceObjectPool<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><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">org.apache.commons.pool2.BaseObjectPool</a><T></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.pool2.impl.SoftReferenceObjectPool<T></li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type of element pooled in this pool.</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/impl/SoftReferenceObjectPool.html#line.43">SoftReferenceObjectPool</a><T> +extends <a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">BaseObjectPool</a><T></pre> +<div class="block">A <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/ref/SoftReference.html?is-external=true" title="class or interface in java.lang.ref"><code>SoftReference</code></a> based <a href="../../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><code>ObjectPool</code></a>. + <p> + This class is intended to be thread-safe.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">Version:</span></dt> + <dd>$Revision: 1622090 $</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/impl/SoftReferenceObjectPool.html#SoftReferenceObjectPool(org.apache.commons.pool2.PooledObjectFactory)">SoftReferenceObjectPool</a></strong>(<a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>> factory)</code> +<div class="block">Create a <code>SoftReferenceObjectPool</code> with the specified factory.</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/impl/SoftReferenceObjectPool.html#addObject()">addObject</a></strong>()</code> +<div class="block">Create an object, and place it into the pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#borrowObject()">borrowObject</a></strong>()</code> +<div class="block">Borrow 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/impl/SoftReferenceObjectPool.html#clear()">clear</a></strong>()</code> +<div class="block">Clears any objects sitting idle in 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/impl/SoftReferenceObjectPool.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><a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#getFactory()">getFactory</a></strong>()</code> +<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> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#getNumActive()">getNumActive</a></strong>()</code> +<div class="block">Return the number of instances currently borrowed from 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/impl/SoftReferenceObjectPool.html#getNumIdle()">getNumIdle</a></strong>()</code> +<div class="block">Returns an approximation not less than the of the number of idle + instances in 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/impl/SoftReferenceObjectPool.html#invalidateObject(T)">invalidateObject</a></strong>(<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a> obj)</code> +<div class="block">Invalidates an object from the pool.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#returnObject(T)">returnObject</a></strong>(<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a> obj)</code> +<div class="block">Returns an instance to the pool after successful validation and + passivation.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_org.apache.commons.pool2.BaseObjectPool"> +<!-- --> +</a> +<h3>Methods inherited from class org.apache.commons.pool2.<a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">BaseObjectPool</a></h3> +<code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html#assertOpen()">assertOpen</a>, <a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html#isClosed()">isClosed</a></code></li> +</ul> +<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="SoftReferenceObjectPool(org.apache.commons.pool2.PooledObjectFactory)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>SoftReferenceObjectPool</h4> +<pre>public <a href="../../../../../src-html/org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#line.78">SoftReferenceObjectPool</a>(<a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>> factory)</pre> +<div class="block">Create a <code>SoftReferenceObjectPool</code> with the specified factory.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>factory</code> - object factory to use.</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/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a> <a href="../../../../../src-html/org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#line.118">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></pre> +<div class="block">Borrow an object from the pool. If there are no idle instances available + in the pool, the configured factory's + <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.makeObject()</code></a> method is invoked to create a + new instance. + <p> + All instances are <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#activateObject(org.apache.commons.pool2.PooledObject)"><code>activated</code></a> + and <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)"><code>validated</code></a> before being returned by this method. If validation fails or + an exception occurs activating or validating an idle instance, the + failing instance is <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)"><code>destroyed</code></a> and another instance is retrieved from the pool, validated and + activated. This process continues until either the pool is empty or an + instance passes validation. If the pool is empty on activation or it does + not contain any valid instances, the factory's <code>makeObject</code> + method is used to create a new instance. If the created instance either + raises an exception on activation or fails validation, + <code>NoSuchElementException</code> is thrown. Exceptions thrown by + <code>MakeObject</code> are propagated to the caller; but other than + <code>ThreadDeath</code> or <code>VirtualMachineError</code>, exceptions + generated by activation, validation or destroy methods are swallowed + silently.</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/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html#borrowObject()">borrowObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a valid, activated object instance</dd> +<dt><span class="strong">Throws:</span></dt> +<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> - if a valid object cannot be provided</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> - if invoked on a <a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#close()"><code>closed</code></a> 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> - if an exception occurs creating a new 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/impl/SoftReferenceObjectPool.html#line.193">returnObject</a>(<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a> obj) + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Returns an instance to the pool after successful validation and + passivation. The returning instance is destroyed if any of the following + are true: + <ul> + <li>the pool is closed</li> + <li><a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)"><code>validation</code></a> fails + </li> + <li><a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#passivateObject(org.apache.commons.pool2.PooledObject)"><code>passivation</code></a> + throws an exception</li> + </ul> + Exceptions passivating or destroying instances are silently swallowed. + Exceptions validating instances are propagated to the client.</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/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html#returnObject(T)">returnObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>obj</code> - instance to return to the 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> - 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/impl/SoftReferenceObjectPool.html#line.235">invalidateObject</a>(<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a> obj) + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Invalidates an object from the pool. + <p> + By contract, <code>obj</code> <strong>must</strong> have been obtained + using <a href="../../../../../org/apache/commons/pool2/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/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html#invalidateObject(T)">invalidateObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>obj</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/impl/SoftReferenceObjectPool.html#line.271">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></pre> +<div class="block">Create an object, and place it into the pool. addObject() is useful for + "pre-loading" a pool with idle objects. + <p> + Before being added to the pool, the newly created instance is + <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)"><code>validated</code></a> and + <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#passivateObject(org.apache.commons.pool2.PooledObject)"><code>passivated</code></a>. If + validation fails, the new instance is + <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)"><code>destroyed</code></a>. Exceptions + generated by the factory <code>makeObject</code> or + <code>passivate</code> are propagated to the caller. Exceptions + destroying instances are silently swallowed.</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/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html#addObject()">addObject</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">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/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if invoked on a <a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#close()"><code>closed</code></a> 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 the <a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#getFactory()"><code>factory</code></a> has a problem creating + or passivating an object.</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/impl/SoftReferenceObjectPool.html#line.313">getNumIdle</a>()</pre> +<div class="block">Returns an approximation not less than the of the number of idle + instances in the pool.</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/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html#getNumIdle()">getNumIdle</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>estimated number of idle instances in the 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/impl/SoftReferenceObjectPool.html#line.324">getNumActive</a>()</pre> +<div class="block">Return the number of instances currently borrowed from this pool.</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/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html#getNumActive()">getNumActive</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">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/impl/SoftReferenceObjectPool.html#line.332">clear</a>()</pre> +<div class="block">Clears any objects sitting idle in the pool.</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/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html#clear()">clear</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="close()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>close</h4> +<pre>public void <a href="../../../../../src-html/org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#line.359">close</a>()</pre> +<div class="block">Close this pool, and free any resources associated with it. Invokes + <a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#clear()"><code>clear()</code></a> to destroy and remove instances in the pool. + <p> + Calling <a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#addObject()"><code>addObject()</code></a> or <a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#borrowObject()"><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>.</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/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html#close()">close</a></code> in class <code><a href="../../../../../org/apache/commons/pool2/BaseObjectPool.html" title="class in org.apache.commons.pool2">BaseObjectPool</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="getFactory()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>getFactory</h4> +<pre>public <a href="../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="type parameter in SoftReferenceObjectPool">T</a>> <a href="../../../../../src-html/org/apache/commons/pool2/impl/SoftReferenceObjectPool.html#line.370">getFactory</a>()</pre> +<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> +<dl><dt><span class="strong">Returns:</span></dt><dd>the factory</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/SoftReferenceObjectPool.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/impl/PooledSoftReference.html" title="class in org.apache.commons.pool2.impl"><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/impl/SoftReferenceObjectPool.html" target="_top">Frames</a></li> +<li><a href="SoftReferenceObjectPool.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/impl/SoftReferenceObjectPool.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/class-use/AbandonedConfig.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/class-use/AbandonedConfig.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/class-use/AbandonedConfig.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,176 @@ +<!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.impl.AbandonedConfig (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.impl.AbandonedConfig (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/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">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/impl/class-use/AbandonedConfig.html" target="_top">Frames</a></li> +<li><a href="AbandonedConfig.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.impl.AbandonedConfig" class="title">Uses of Class<br>org.apache.commons.pool2.impl.AbandonedConfig</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">AbandonedConfig</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.commons.pool2.impl">org.apache.commons.pool2.impl</a></td> +<td class="colLast"> +<div class="block"> + Object pooling API implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.commons.pool2.impl"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">AbandonedConfig</a> in <a href="../../../../../../org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing methods, and an explanation"> +<caption><span>Methods in <a href="../../../../../../org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a> with parameters of type <a href="../../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">AbandonedConfig</a></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> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><span class="strong">GenericObjectPool.</span><code><strong><a href="../../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html#setAbandonedConfig(org.apache.commons.pool2.impl.AbandonedConfig)">setAbandonedConfig</a></strong>(<a href="../../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">AbandonedConfig</a> abandonedConfig)</code> +<div class="block">Sets the abandoned object removal configuration.</div> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../../org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a> with parameters of type <a href="../../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">AbandonedConfig</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><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</a></strong>(<a href="../../../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a><<a href="../../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="type parameter in GenericObjectPool">T</a>> factory, + <a href="../../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a> config, + <a href="../../../../../../org/apache/commons/pool2/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">AbandonedConfig</a> abandonedConfig)</code> +<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> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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/impl/AbandonedConfig.html" title="class in org.apache.commons.pool2.impl">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/impl/class-use/AbandonedConfig.html" target="_top">Frames</a></li> +<li><a href="AbandonedConfig.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/impl/class-use/AbandonedConfig.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/class-use/BaseGenericObjectPool.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/class-use/BaseGenericObjectPool.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/class-use/BaseGenericObjectPool.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,166 @@ +<!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.impl.BaseGenericObjectPool (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.impl.BaseGenericObjectPool (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/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">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/impl/class-use/BaseGenericObjectPool.html" target="_top">Frames</a></li> +<li><a href="BaseGenericObjectPool.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.impl.BaseGenericObjectPool" class="title">Uses of Class<br>org.apache.commons.pool2.impl.BaseGenericObjectPool</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">BaseGenericObjectPool</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.commons.pool2.impl">org.apache.commons.pool2.impl</a></td> +<td class="colLast"> +<div class="block"> + Object pooling API implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.commons.pool2.impl"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">BaseGenericObjectPool</a> in <a href="../../../../../../org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">BaseGenericObjectPool</a> in <a href="../../../../../../org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/pool2/impl/GenericKeyedObjectPool.html" title="class in org.apache.commons.pool2.impl">GenericKeyedObjectPool</a><K,T></strong></code> +<div class="block">A configurable <code>KeyedObjectPool</code> implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/pool2/impl/GenericObjectPool.html" title="class in org.apache.commons.pool2.impl">GenericObjectPool</a><T></strong></code> +<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> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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/impl/BaseGenericObjectPool.html" title="class in org.apache.commons.pool2.impl">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/impl/class-use/BaseGenericObjectPool.html" target="_top">Frames</a></li> +<li><a href="BaseGenericObjectPool.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/impl/class-use/BaseGenericObjectPool.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/class-use/BaseObjectPoolConfig.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/class-use/BaseObjectPoolConfig.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/impl/class-use/BaseObjectPoolConfig.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,184 @@ +<!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.impl.BaseObjectPoolConfig (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.impl.BaseObjectPoolConfig (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/impl/BaseObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">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/impl/class-use/BaseObjectPoolConfig.html" target="_top">Frames</a></li> +<li><a href="BaseObjectPoolConfig.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.impl.BaseObjectPoolConfig" class="title">Uses of Class<br>org.apache.commons.pool2.impl.BaseObjectPoolConfig</h2> +</div> +<div class="classUseContainer"> +<ul class="blockList"> +<li class="blockList"> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing packages, and an explanation"> +<caption><span>Packages that use <a href="../../../../../../org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Package</th> +<th class="colLast" scope="col">Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><a href="#org.apache.commons.pool2.impl">org.apache.commons.pool2.impl</a></td> +<td class="colLast"> +<div class="block"> + Object pooling API implementations.</div> +</td> +</tr> +</tbody> +</table> +</li> +<li class="blockList"> +<ul class="blockList"> +<li class="blockList"><a name="org.apache.commons.pool2.impl"> +<!-- --> +</a> +<h3>Uses of <a href="../../../../../../org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a> in <a href="../../../../../../org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></h3> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing subclasses, and an explanation"> +<caption><span>Subclasses of <a href="../../../../../../org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a> in <a href="../../../../../../org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Class and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">GenericKeyedObjectPoolConfig</a></strong></code> +<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> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>class </code></td> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/pool2/impl/GenericObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">GenericObjectPoolConfig</a></strong></code> +<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> +</td> +</tr> +</tbody> +</table> +<table border="0" cellpadding="3" cellspacing="0" summary="Use table, listing constructors, and an explanation"> +<caption><span>Constructors in <a href="../../../../../../org/apache/commons/pool2/impl/package-summary.html">org.apache.commons.pool2.impl</a> with parameters of type <a href="../../../../../../org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a></span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tbody> +<tr class="altColor"> +<td class="colLast"><code><strong><a href="../../../../../../org/apache/commons/pool2/impl/BaseGenericObjectPool.html#BaseGenericObjectPool(org.apache.commons.pool2.impl.BaseObjectPoolConfig,%20java.lang.String,%20java.lang.String)">BaseGenericObjectPool</a></strong>(<a href="../../../../../../org/apache/commons/pool2/impl/BaseObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">BaseObjectPoolConfig</a> config, + <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jmxNameBase, + <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/String.html?is-external=true" title="class or interface in java.lang">String</a> jmxNamePrefix)</code> +<div class="block">Handles JMX registration (if required) and the initialization required for + monitoring.</div> +</td> +</tr> +</tbody> +</table> +</li> +</ul> +</li> +</ul> +</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/impl/BaseObjectPoolConfig.html" title="class in org.apache.commons.pool2.impl">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/impl/class-use/BaseObjectPoolConfig.html" target="_top">Frames</a></li> +<li><a href="BaseObjectPoolConfig.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/impl/class-use/BaseObjectPoolConfig.html ------------------------------------------------------------------------------ svn:eol-style = native