Added: websites/production/commons/content/proper/commons-pool/api-2.5.0/org/apache/commons/pool2/PooledObject.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.5.0/org/apache/commons/pool2/PooledObject.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.5.0/org/apache/commons/pool2/PooledObject.html Wed Dec 20 17:04:00 2017 @@ -0,0 +1,627 @@ +<!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>PooledObject (Apache Commons Pool 2.5.0 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="PooledObject (Apache Commons Pool 2.5.0 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/PooledObject.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/ObjectPool.html" title="interface in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/commons/pool2/PooledObject.html" target="_top">Frames</a></li> +<li><a href="PooledObject.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.pool2</div> +<h2 title="Interface PooledObject" class="title">Interface PooledObject<T></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - the type of object in the pool</dd></dl> +<dl> +<dt>All Superinterfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/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>></dd> +</dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><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="class in org.apache.commons.pool2.impl">PooledSoftReference</a></dd> +</dl> +<hr> +<br> +<pre>public interface <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.32">PooledObject</a><T> +extends <a href="http://docs.oracle.com/javase/7/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>></pre> +<div class="block">Defines the wrapper that is used to track the additional information, such as + state, for the pooled objects. + <p> + Implementations of this class are required to be thread-safe.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== 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>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#allocate()">allocate</a></strong>()</code> +<div class="block">Allocates the object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#compareTo(org.apache.commons.pool2.PooledObject)">compareTo</a></strong>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="type parameter in PooledObject">T</a>> other)</code> +<div class="block">Orders instances based on idle time - i.e.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#deallocate()">deallocate</a></strong>()</code> +<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> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#endEvictionTest(java.util.Deque)">endEvictionTest</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Deque.html?is-external=true"; title="class or interface in java.util">Deque</a><<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="type parameter in PooledObject">T</a>>> idleQueue)</code> +<div class="block">Called to inform the object that the eviction test has ended.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#equals(java.lang.Object)">equals</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</code> </td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#getActiveTimeMillis()">getActiveTimeMillis</a></strong>()</code> +<div class="block">Obtain the time in milliseconds that this object last spent in the + active state (it may still be active in which case subsequent calls will + return an increased value).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#getCreateTime()">getCreateTime</a></strong>()</code> +<div class="block">Obtain the time (using the same basis as + <a href="http://docs.oracle.com/javase/7/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> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#getIdleTimeMillis()">getIdleTimeMillis</a></strong>()</code> +<div class="block">Obtain the time in milliseconds that this object last spend in the + idle state (it may still be idle in which case subsequent calls will + return an increased value).</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#getLastBorrowTime()">getLastBorrowTime</a></strong>()</code> +<div class="block">Obtain the time the wrapped object was last borrowed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#getLastReturnTime()">getLastReturnTime</a></strong>()</code> +<div class="block">Obtain the time the wrapped object was last returned.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>long</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#getLastUsedTime()">getLastUsedTime</a></strong>()</code> +<div class="block">Return an estimate of the last time this object was used.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/pool2/PooledObject.html" title="type parameter in PooledObject">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#getObject()">getObject</a></strong>()</code> +<div class="block">Obtain the underlying object that is wrapped by this instance of + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a>.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#getState()">getState</a></strong>()</code> +<div class="block">Returns the state of this object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#hashCode()">hashCode</a></strong>()</code> </td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#invalidate()">invalidate</a></strong>()</code> +<div class="block">Sets the state to <a href="../../../../org/apache/commons/pool2/PooledObjectState.html#INVALID"><code>INVALID</code></a></div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#markAbandoned()">markAbandoned</a></strong>()</code> +<div class="block">Marks the pooled object as abandoned.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#markReturning()">markReturning</a></strong>()</code> +<div class="block">Marks the object as returning to 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/PooledObject.html#printStackTrace(java.io.PrintWriter)">printStackTrace</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> writer)</code> +<div class="block">Prints the stack trace of the code that borrowed this pooled object and + the stack trace of the last code to use this object (if available) to + the supplied writer.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#setLogAbandoned(boolean)">setLogAbandoned</a></strong>(boolean logAbandoned)</code> +<div class="block">Is abandoned object tracking being used? If this is true the + implementation will need to record the stack trace of the last caller to + borrow this object.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#startEvictionTest()">startEvictionTest</a></strong>()</code> +<div class="block">Attempt to place the pooled object in the + <a href="../../../../org/apache/commons/pool2/PooledObjectState.html#EVICTION"><code>PooledObjectState.EVICTION</code></a> state.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="http://docs.oracle.com/javase/7/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/PooledObject.html#toString()">toString</a></strong>()</code> +<div class="block">Provides a String form of the wrapper for debug purposes.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObject.html#use()">use</a></strong>()</code> +<div class="block">Record the current stack trace as the last time the object was used.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="getObject()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getObject</h4> +<pre><a href="../../../../org/apache/commons/pool2/PooledObject.html" title="type parameter in PooledObject">T</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.40">getObject</a>()</pre> +<div class="block">Obtain the underlying object that is wrapped by this instance of + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The wrapped object</dd></dl> +</li> +</ul> +<a name="getCreateTime()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getCreateTime</h4> +<pre>long <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.48">getCreateTime</a>()</pre> +<div class="block">Obtain the time (using the same basis as + <a href="http://docs.oracle.com/javase/7/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> +<dl><dt><span class="strong">Returns:</span></dt><dd>The creation time for the wrapped object</dd></dl> +</li> +</ul> +<a name="getActiveTimeMillis()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getActiveTimeMillis</h4> +<pre>long <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.57">getActiveTimeMillis</a>()</pre> +<div class="block">Obtain the time in milliseconds that this object last spent in the + active state (it may still be active in which case subsequent calls will + return an increased value).</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The time in milliseconds last spent in the active state</dd></dl> +</li> +</ul> +<a name="getIdleTimeMillis()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getIdleTimeMillis</h4> +<pre>long <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.66">getIdleTimeMillis</a>()</pre> +<div class="block">Obtain the time in milliseconds that this object last spend in the + idle state (it may still be idle in which case subsequent calls will + return an increased value).</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The time in milliseconds last spent in the idle state</dd></dl> +</li> +</ul> +<a name="getLastBorrowTime()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastBorrowTime</h4> +<pre>long <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.73">getLastBorrowTime</a>()</pre> +<div class="block">Obtain the time the wrapped object was last borrowed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The time the object was last borrowed</dd></dl> +</li> +</ul> +<a name="getLastReturnTime()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastReturnTime</h4> +<pre>long <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.80">getLastReturnTime</a>()</pre> +<div class="block">Obtain the time the wrapped object was last returned.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>The time the object was last returned</dd></dl> +</li> +</ul> +<a name="getLastUsedTime()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getLastUsedTime</h4> +<pre>long <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.91">getLastUsedTime</a>()</pre> +<div class="block">Return an estimate of the last time this object was used. If the class + of the pooled object implements <a href="../../../../org/apache/commons/pool2/TrackedUse.html" title="interface in org.apache.commons.pool2"><code>TrackedUse</code></a>, what is returned is + the maximum of <a href="../../../../org/apache/commons/pool2/TrackedUse.html#getLastUsed()"><code>TrackedUse.getLastUsed()</code></a> and + <a href="../../../../org/apache/commons/pool2/PooledObject.html#getLastBorrowTime()"><code>getLastBorrowTime()</code></a>; otherwise this method gives the same + value as <a href="../../../../org/apache/commons/pool2/PooledObject.html#getLastBorrowTime()"><code>getLastBorrowTime()</code></a>.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>the last time this object was used</dd></dl> +</li> +</ul> +<a name="compareTo(org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>compareTo</h4> +<pre>int <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.103">compareTo</a>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="type parameter in PooledObject">T</a>> other)</pre> +<div class="block">Orders instances based on idle time - i.e. the length of time since the + instance was returned to the pool. Used by the GKOP idle object evictor. +<p> + Note: This class has a natural ordering that is inconsistent with + equals if distinct objects have the same identity hash code. + <p> + </div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true#compareTo(T)" title="class or interface in java.lang">compareTo</a></code> in interface <code><a href="http://docs.oracle.com/javase/7/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><<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="type parameter in PooledObject">T</a>>></code></dd> +</dl> +</li> +</ul> +<a name="equals(java.lang.Object)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>equals</h4> +<pre>boolean <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.106">equals</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a> obj)</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="hashCode()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>hashCode</h4> +<pre>int <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.109">hashCode</a>()</pre> +<dl> +<dt><strong>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="toString()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>toString</h4> +<pre><a href="http://docs.oracle.com/javase/7/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/PooledObject.html#line.118">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>Overrides:</strong></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a></code> in class <code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Object.html?is-external=true"; title="class or interface in java.lang">Object</a></code></dd> +</dl> +</li> +</ul> +<a name="startEvictionTest()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>startEvictionTest</h4> +<pre>boolean <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.128">startEvictionTest</a>()</pre> +<div class="block">Attempt to place the pooled object in the + <a href="../../../../org/apache/commons/pool2/PooledObjectState.html#EVICTION"><code>PooledObjectState.EVICTION</code></a> state.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the object was placed in the + <a href="../../../../org/apache/commons/pool2/PooledObjectState.html#EVICTION"><code>PooledObjectState.EVICTION</code></a> state otherwise + <code>false</code></dd></dl> +</li> +</ul> +<a name="endEvictionTest(java.util.Deque)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>endEvictionTest</h4> +<pre>boolean <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.138">endEvictionTest</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/util/Deque.html?is-external=true"; title="class or interface in java.util">Deque</a><<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="type parameter in PooledObject">T</a>>> idleQueue)</pre> +<div class="block">Called to inform the object that the eviction test has ended.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>idleQueue</code> - The queue of idle objects to which the object should be + returned</dd> +<dt><span class="strong">Returns:</span></dt><dd>Currently not used</dd></dl> +</li> +</ul> +<a name="allocate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>allocate</h4> +<pre>boolean <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.145">allocate</a>()</pre> +<div class="block">Allocates the object.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the original state was <a href="../../../../org/apache/commons/pool2/PooledObjectState.html#IDLE"><code>IDLE</code></a></dd></dl> +</li> +</ul> +<a name="deallocate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>deallocate</h4> +<pre>boolean <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.153">deallocate</a>()</pre> +<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> +<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> if the state was <a href="../../../../org/apache/commons/pool2/PooledObjectState.html#ALLOCATED"><code>ALLOCATED</code></a></dd></dl> +</li> +</ul> +<a name="invalidate()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invalidate</h4> +<pre>void <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.158">invalidate</a>()</pre> +<div class="block">Sets the state to <a href="../../../../org/apache/commons/pool2/PooledObjectState.html#INVALID"><code>INVALID</code></a></div> +</li> +</ul> +<a name="setLogAbandoned(boolean)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>setLogAbandoned</h4> +<pre>void <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.168">setLogAbandoned</a>(boolean logAbandoned)</pre> +<div class="block">Is abandoned object tracking being used? If this is true the + implementation will need to record the stack trace of the last caller to + borrow this object.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>logAbandoned</code> - The new configuration setting for abandoned + object tracking</dd></dl> +</li> +</ul> +<a name="use()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>use</h4> +<pre>void <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.185">use</a>()</pre> +<div class="block">Record the current stack trace as the last time the object was used.</div> +</li> +</ul> +<a name="printStackTrace(java.io.PrintWriter)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>printStackTrace</h4> +<pre>void <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.194">printStackTrace</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/io/PrintWriter.html?is-external=true"; title="class or interface in java.io">PrintWriter</a> writer)</pre> +<div class="block">Prints the stack trace of the code that borrowed this pooled object and + the stack trace of the last code to use this object (if available) to + the supplied writer.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>writer</code> - The destination for the debug output</dd></dl> +</li> +</ul> +<a name="getState()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getState</h4> +<pre><a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.200">getState</a>()</pre> +<div class="block">Returns the state of this object.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>state</dd></dl> +</li> +</ul> +<a name="markAbandoned()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>markAbandoned</h4> +<pre>void <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.205">markAbandoned</a>()</pre> +<div class="block">Marks the pooled object as abandoned.</div> +</li> +</ul> +<a name="markReturning()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>markReturning</h4> +<pre>void <a href="../../../../src-html/org/apache/commons/pool2/PooledObject.html#line.210">markReturning</a>()</pre> +<div class="block">Marks the object as returning to the pool.</div> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/PooledObject.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/ObjectPool.html" title="interface in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/commons/pool2/PooledObject.html" target="_top">Frames</a></li> +<li><a href="PooledObject.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2001–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file
Added: websites/production/commons/content/proper/commons-pool/api-2.5.0/org/apache/commons/pool2/PooledObjectFactory.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.5.0/org/apache/commons/pool2/PooledObjectFactory.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.5.0/org/apache/commons/pool2/PooledObjectFactory.html Wed Dec 20 17:04:00 2017 @@ -0,0 +1,359 @@ +<!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>PooledObjectFactory (Apache Commons Pool 2.5.0 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="PooledObjectFactory (Apache Commons Pool 2.5.0 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/PooledObjectFactory.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/PooledObject.html" title="interface in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/commons/pool2/PooledObjectFactory.html" target="_top">Frames</a></li> +<li><a href="PooledObjectFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.pool2</div> +<h2 title="Interface PooledObjectFactory" class="title">Interface PooledObjectFactory<T></h2> +</div> +<div class="contentContainer"> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type of element managed in this factory.</dd></dl> +<dl> +<dt>All Known Implementing Classes:</dt> +<dd><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.html" title="class in org.apache.commons.pool2">BasePooledObjectFactory</a></dd> +</dl> +<hr> +<br> +<pre>public interface <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectFactory.html#line.71">PooledObjectFactory</a><T></pre> +<div class="block">An interface defining life-cycle methods for instances to be served by an + <a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><code>ObjectPool</code></a>. + <p> + By contract, when an <a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><code>ObjectPool</code></a> delegates to a + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2"><code>PooledObjectFactory</code></a>, + <ol> + <li> + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject()"><code>makeObject()</code></a> is called whenever a new instance is needed. + </li> + <li> + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#activateObject(org.apache.commons.pool2.PooledObject)"><code>activateObject(org.apache.commons.pool2.PooledObject<T>)</code></a> is invoked on every instance that has been + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#passivateObject(org.apache.commons.pool2.PooledObject)"><code>passivated</code></a> before it is + <a href="../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()"><code>borrowed</code></a> from the pool. + </li> + <li> + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)"><code>validateObject(org.apache.commons.pool2.PooledObject<T>)</code></a> may be invoked on <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#activateObject(org.apache.commons.pool2.PooledObject)"><code>activated</code></a> + instances to make sure they can be <a href="../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()"><code>borrowed</code></a> + from the pool. <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)"><code>validateObject(org.apache.commons.pool2.PooledObject<T>)</code></a> may also be used to + test an instance being <a href="../../../../org/apache/commons/pool2/ObjectPool.html#returnObject(T)"><code>returned</code></a> to the pool + before it is <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#passivateObject(org.apache.commons.pool2.PooledObject)"><code>passivated</code></a>. It will only be invoked + on an activated instance. + </li> + <li> + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#passivateObject(org.apache.commons.pool2.PooledObject)"><code>passivateObject(org.apache.commons.pool2.PooledObject<T>)</code></a> is invoked on every instance when it is returned + to the pool. + </li> + <li> + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)"><code>destroyObject(org.apache.commons.pool2.PooledObject<T>)</code></a> is invoked on every instance when it is being + "dropped" from the pool (whether due to the response from + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)"><code>validateObject(org.apache.commons.pool2.PooledObject<T>)</code></a>, or for reasons specific to the pool + implementation.) There is no guarantee that the instance being destroyed + will be considered active, passive or in a generally consistent state. + </li> + </ol> + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="interface in org.apache.commons.pool2"><code>PooledObjectFactory</code></a> must be thread-safe. The only promise + an <a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><code>ObjectPool</code></a> makes is that the same instance of an object will not + be passed to more than one method of a <code>PoolableObjectFactory</code> + at a time. + <p> + While clients of a <a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html" title="interface in org.apache.commons.pool2"><code>KeyedObjectPool</code></a> borrow and return instances of + the underlying value type <code>V</code>, the factory methods act on instances of + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject<V></code></a>. These are the object wrappers that + pools use to track and maintain state information about the objects that + they manage.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><code>ObjectPool</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#activateObject(org.apache.commons.pool2.PooledObject)">activateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="type parameter in PooledObjectFactory">T</a>> p)</code> +<div class="block">Reinitialize an instance to be returned by the pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)">destroyObject</a></strong>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="type parameter in PooledObjectFactory">T</a>> p)</code> +<div class="block">Destroys an instance no longer needed by the pool.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="type parameter in PooledObjectFactory">T</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject()">makeObject</a></strong>()</code> +<div class="block">Create an instance that can be served by the pool and wrap it in a + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a> to be managed by the pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#passivateObject(org.apache.commons.pool2.PooledObject)">passivateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="type parameter in PooledObjectFactory">T</a>> p)</code> +<div class="block">Uninitialize an instance to be returned to the idle object pool.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)">validateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="type parameter in PooledObjectFactory">T</a>> p)</code> +<div class="block">Ensures that the instance is safe to be returned by the pool.</div> +</td> +</tr> +</table> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="makeObject()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>makeObject</h4> +<pre><a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="type parameter in PooledObjectFactory">T</a>> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectFactory.html#line.81">makeObject</a>() + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Create an instance that can be served by the pool and wrap it in a + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a> to be managed by the pool.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd>a <code>PooledObject</code> wrapping an instance that can be served by the pool</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - if there is a problem creating a new instance, + this will be propagated to the code requesting an object.</dd></dl> +</li> +</ul> +<a name="destroyObject(org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>destroyObject</h4> +<pre>void <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectFactory.html#line.102">destroyObject</a>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="type parameter in PooledObjectFactory">T</a>> p) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Destroys an instance no longer needed by the pool. + <p> + It is important for implementations of this method to be aware that there + is no guarantee about what state <code>obj</code> will be in and the + implementation should be prepared to handle unexpected errors. + <p> + Also, an implementation must take in to consideration that instances lost + to the garbage collector may never be destroyed. + </p></div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - a <code>PooledObject</code> wrapping the instance to be destroyed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - should be avoided as it may be swallowed by + the pool implementation.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)"><code>validateObject(org.apache.commons.pool2.PooledObject<T>)</code></a>, +<a href="../../../../org/apache/commons/pool2/ObjectPool.html#invalidateObject(T)"><code>ObjectPool.invalidateObject(T)</code></a></dd></dl> +</li> +</ul> +<a name="validateObject(org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validateObject</h4> +<pre>boolean <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectFactory.html#line.112">validateObject</a>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="type parameter in PooledObjectFactory">T</a>> p)</pre> +<div class="block">Ensures that the instance is safe to be returned by the pool.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - a <code>PooledObject</code> wrapping the instance to be validated</dd> +<dt><span class="strong">Returns:</span></dt><dd><code>false</code> if <code>obj</code> is not valid and should + be dropped from the pool, <code>true</code> otherwise.</dd></dl> +</li> +</ul> +<a name="activateObject(org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>activateObject</h4> +<pre>void <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectFactory.html#line.124">activateObject</a>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="type parameter in PooledObjectFactory">T</a>> p) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Reinitialize an instance to be returned by the pool.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - a <code>PooledObject</code> wrapping the instance to be activated</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - if there is a problem activating <code>obj</code>, + this exception may be swallowed by the pool.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)"><code>destroyObject(org.apache.commons.pool2.PooledObject<T>)</code></a></dd></dl> +</li> +</ul> +<a name="passivateObject(org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>passivateObject</h4> +<pre>void <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectFactory.html#line.136">passivateObject</a>(<a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html" title="type parameter in PooledObjectFactory">T</a>> p) + throws <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></pre> +<div class="block">Uninitialize an instance to be returned to the idle object pool.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>p</code> - a <code>PooledObject</code> wrapping the instance to be passivated</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Exception.html?is-external=true"; title="class or interface in java.lang">Exception</a></code> - if there is a problem passivating <code>obj</code>, + this exception may be swallowed by the pool.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject)"><code>destroyObject(org.apache.commons.pool2.PooledObject<T>)</code></a></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/PooledObjectFactory.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/PooledObject.html" title="interface in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/commons/pool2/PooledObjectFactory.html" target="_top">Frames</a></li> +<li><a href="PooledObjectFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_bottom"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_bottom"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li>Constr | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_bottom"> +<!-- --> +</a></div> +<!-- ======== END OF BOTTOM NAVBAR ======= --> +<p class="legalCopy"><small>Copyright © 2001–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file Added: websites/production/commons/content/proper/commons-pool/api-2.5.0/org/apache/commons/pool2/PooledObjectState.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.5.0/org/apache/commons/pool2/PooledObjectState.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.5.0/org/apache/commons/pool2/PooledObjectState.html Wed Dec 20 17:04:00 2017 @@ -0,0 +1,460 @@ +<!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>PooledObjectState (Apache Commons Pool 2.5.0 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="PooledObjectState (Apache Commons Pool 2.5.0 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/PooledObjectState.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/PooledObjectFactory.html" title="interface in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/pool2/PoolUtils.html" title="class in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/commons/pool2/PooledObjectState.html" target="_top">Frames</a></li> +<li><a href="PooledObjectState.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.pool2</div> +<h2 title="Enum PooledObjectState" class="title">Enum PooledObjectState</h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/7/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="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">java.lang.Enum</a><<a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a>></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.pool2.PooledObjectState</li> +</ul> +</li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="http://docs.oracle.com/javase/7/docs/api/java/io/Serializable.html?is-external=true"; title="class or interface in java.io">Serializable</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Comparable.html?is-external=true"; title="class or interface in java.lang">Comparable</a><<a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a>></dd> +</dl> +<hr> +<br> +<pre>public enum <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.24">PooledObjectState</a> +extends <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a><<a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a>></pre> +<div class="block">Provides the possible states that a <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a> may be in.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- =========== ENUM CONSTANT SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_summary"> +<!-- --> +</a> +<h3>Enum Constant Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Enum Constant Summary table, listing enum constants, and an explanation"> +<caption><span>Enum Constants</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Enum Constant and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#ABANDONED">ABANDONED</a></strong></code> +<div class="block">Deemed abandoned, to be invalidated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#ALLOCATED">ALLOCATED</a></strong></code> +<div class="block">In use.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#EVICTION">EVICTION</a></strong></code> +<div class="block">In the queue, currently being tested for possible eviction.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#EVICTION_RETURN_TO_HEAD">EVICTION_RETURN_TO_HEAD</a></strong></code> +<div class="block">Not in the queue, currently being tested for possible eviction.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#IDLE">IDLE</a></strong></code> +<div class="block">In the queue, not in use.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#INVALID">INVALID</a></strong></code> +<div class="block">Failed maintenance (e.g.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#RETURNING">RETURNING</a></strong></code> +<div class="block">Returning to the pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#VALIDATION">VALIDATION</a></strong></code> +<div class="block">In the queue, currently being validated.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#VALIDATION_PREALLOCATED">VALIDATION_PREALLOCATED</a></strong></code> +<div class="block">Not in queue, currently being validated.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#VALIDATION_RETURN_TO_HEAD">VALIDATION_RETURN_TO_HEAD</a></strong></code> +<div class="block">Not in queue, currently being validated.</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>static <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#valueOf(java.lang.String)">valueOf</a></strong>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</code> +<div class="block">Returns the enum constant of this type with the specified name.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>static <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a>[]</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/PooledObjectState.html#values()">values</a></strong>()</code> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Enum"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true"; title="class or interface in java.lang">Enum</a></h3> +<code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#compareTo(E)" title="class or interface in java.lang">compareTo</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#getDeclaringClass()" title="class or interface in java.lang">getDeclaringClass</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/7/docs/ api/java/lang/Enum.html?is-external=true#name()" title="class or interface in java.lang">name</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#ordinal()" title="class or interface in java.lang">ordinal</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/7/docs/api/java/lang/Enum.html?is-external=true#valueOf(java.lang.Class,%20java.lang.String)" title="class or interface in java.lang">valueOf</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/7/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/7/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/7/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/7/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/7/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/7/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/7/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"> +<!-- ============ ENUM CONSTANT DETAIL =========== --> +<ul class="blockList"> +<li class="blockList"><a name="enum_constant_detail"> +<!-- --> +</a> +<h3>Enum Constant Detail</h3> +<a name="IDLE"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>IDLE</h4> +<pre>public static final <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.28">IDLE</a></pre> +<div class="block">In the queue, not in use.</div> +</li> +</ul> +<a name="ALLOCATED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ALLOCATED</h4> +<pre>public static final <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.33">ALLOCATED</a></pre> +<div class="block">In use.</div> +</li> +</ul> +<a name="EVICTION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EVICTION</h4> +<pre>public static final <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.38">EVICTION</a></pre> +<div class="block">In the queue, currently being tested for possible eviction.</div> +</li> +</ul> +<a name="EVICTION_RETURN_TO_HEAD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>EVICTION_RETURN_TO_HEAD</h4> +<pre>public static final <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.48">EVICTION_RETURN_TO_HEAD</a></pre> +<div class="block">Not in the queue, currently being tested for possible eviction. An + attempt to borrow the object was made while being tested which removed it + from the queue. It should be returned to the head of the queue once + eviction testing completes. + TODO: Consider allocating object and ignoring the result of the eviction + test.</div> +</li> +</ul> +<a name="VALIDATION"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VALIDATION</h4> +<pre>public static final <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.53">VALIDATION</a></pre> +<div class="block">In the queue, currently being validated.</div> +</li> +</ul> +<a name="VALIDATION_PREALLOCATED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VALIDATION_PREALLOCATED</h4> +<pre>public static final <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.61">VALIDATION_PREALLOCATED</a></pre> +<div class="block">Not in queue, currently being validated. The object was borrowed while + being validated and since testOnBorrow was configured, it was removed + from the queue and pre-allocated. It should be allocated once validation + completes.</div> +</li> +</ul> +<a name="VALIDATION_RETURN_TO_HEAD"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>VALIDATION_RETURN_TO_HEAD</h4> +<pre>public static final <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.69">VALIDATION_RETURN_TO_HEAD</a></pre> +<div class="block">Not in queue, currently being validated. An attempt to borrow the object + was made while previously being tested for eviction which removed it from + the queue. It should be returned to the head of the queue once validation + completes.</div> +</li> +</ul> +<a name="INVALID"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>INVALID</h4> +<pre>public static final <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.75">INVALID</a></pre> +<div class="block">Failed maintenance (e.g. eviction test or validation) and will be / has + been destroyed</div> +</li> +</ul> +<a name="ABANDONED"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>ABANDONED</h4> +<pre>public static final <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.80">ABANDONED</a></pre> +<div class="block">Deemed abandoned, to be invalidated.</div> +</li> +</ul> +<a name="RETURNING"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>RETURNING</h4> +<pre>public static final <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.85">RETURNING</a></pre> +<div class="block">Returning to the pool.</div> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="values()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>values</h4> +<pre>public static <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a>[] <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.24">values</a>()</pre> +<div class="block">Returns an array containing the constants of this enum type, in +the order they are declared. This method may be used to iterate +over the constants as follows: +<pre> +for (PooledObjectState c : PooledObjectState.values()) + System.out.println(c); +</pre></div> +<dl><dt><span class="strong">Returns:</span></dt><dd>an array containing the constants of this enum type, in the order they are declared</dd></dl> +</li> +</ul> +<a name="valueOf(java.lang.String)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>valueOf</h4> +<pre>public static <a href="../../../../org/apache/commons/pool2/PooledObjectState.html" title="enum in org.apache.commons.pool2">PooledObjectState</a> <a href="../../../../src-html/org/apache/commons/pool2/PooledObjectState.html#line.24">valueOf</a>(<a href="http://docs.oracle.com/javase/7/docs/api/java/lang/String.html?is-external=true"; title="class or interface in java.lang">String</a> name)</pre> +<div class="block">Returns the enum constant of this type with the specified name. +The string must match <i>exactly</i> an identifier used to declare an +enum constant in this type. (Extraneous whitespace characters are +not permitted.)</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>name</code> - the name of the enum constant to be returned.</dd> +<dt><span class="strong">Returns:</span></dt><dd>the enum constant with the specified name</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/IllegalArgumentException.html?is-external=true"; title="class or interface in java.lang">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="http://docs.oracle.com/javase/7/docs/api/java/lang/NullPointerException.html?is-external=true"; title="class or interface in java.lang">NullPointerException</a></code> - if the argument is null</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/PooledObjectState.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/PooledObjectFactory.html" title="interface in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/pool2/PoolUtils.html" title="class in org.apache.commons.pool2"><span class="strong">Next Class</span></a></li> +</ul> +<ul class="navList"> +<li><a href="../../../../index.html?org/apache/commons/pool2/PooledObjectState.html" target="_top">Frames</a></li> +<li><a href="PooledObjectState.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><a href="#enum_constant_summary">Enum Constants</a> | </li> +<li>Field | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li><a href="#enum_constant_detail">Enum Constants</a> | </li> +<li>Field | </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–2017 <a href="https://www.apache.org/";>The Apache Software Foundation</a>. All rights reserved.</small></p> +</body> +</html> \ No newline at end of file
