Added: websites/production/commons/content/proper/commons-pool/api-2.3/index.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/index.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/index.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,74 @@ +<!DOCTYPE HTML PUBLIC "-//W3C//DTD HTML 4.01 Frameset//EN" "http://www.w3.org/TR/html4/frameset.dtd"> +<!-- NewPage --> +<html lang="en"> +<head> +<meta http-equiv="Content-Type" content="text/html" charset="iso-8859-1"> +<title>Apache Commons Pool 2.3 API</title> +<script type="text/javascript"> + targetPage = "" + window.location.search; + if (targetPage != "" && targetPage != "undefined") + targetPage = targetPage.substring(1); + if (targetPage.indexOf(":") != -1 || (targetPage != "" && !validURL(targetPage))) + targetPage = "undefined"; + function validURL(url) { + try { + url = decodeURIComponent(url); + } + catch (error) { + return false; + } + var pos = url.indexOf(".html"); + if (pos == -1 || pos != url.length - 5) + return false; + var allowNumber = false; + var allowSep = false; + var seenDot = false; + for (var i = 0; i < url.length - 5; i++) { + var ch = url.charAt(i); + if ('a' <= ch && ch <= 'z' || + 'A' <= ch && ch <= 'Z' || + ch == '$' || + ch == '_' || + ch.charCodeAt(0) > 127) { + allowNumber = true; + allowSep = true; + } else if ('0' <= ch && ch <= '9' + || ch == '-') { + if (!allowNumber) + return false; + } else if (ch == '/' || ch == '.') { + if (!allowSep) + return false; + allowNumber = false; + allowSep = false; + if (ch == '.') + seenDot = true; + if (ch == '/' && seenDot) + return false; + } else { + return false; + } + } + return true; + } + function loadFrames() { + if (targetPage != "" && targetPage != "undefined") + top.classFrame.location = top.targetPage; + } +</script> +</head> +<frameset cols="20%,80%" title="Documentation frame" onload="top.loadFrames()"> +<frameset rows="30%,70%" title="Left frames" onload="top.loadFrames()"> +<frame src="overview-frame.html" name="packageListFrame" title="All Packages"> +<frame src="allclasses-frame.html" name="packageFrame" title="All classes and interfaces (except non-static nested types)"> +</frameset> +<frame src="overview-summary.html" name="classFrame" title="Package, class and interface descriptions" scrolling="yes"> +<noframes> +<noscript> +<div>JavaScript is disabled on your browser.</div> +</noscript> +<h2>Frame Alert</h2> +<p>This document is designed to be viewed using the frames feature. If you see this message, you are using a non-frame-capable web client. Link to <a href="overview-summary.html">Non-frame version</a>.</p> +</noframes> +</frameset> +</html> \ No newline at end of file
Propchange: websites/production/commons/content/proper/commons-pool/api-2.3/index.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,454 @@ +<!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>BaseKeyedPooledObjectFactory (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="BaseKeyedPooledObjectFactory (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/BaseKeyedPooledObjectFactory.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>Prev Class</li> +<li><a href="../../../../org/apache/commons/pool2/BaseObjectPool.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/BaseKeyedPooledObjectFactory.html" target="_top">Frames</a></li> +<li><a href="BaseKeyedPooledObjectFactory.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.pool2</div> +<h2 title="Class BaseKeyedPooledObjectFactory" class="title">Class BaseKeyedPooledObjectFactory<K,V></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.pool2.BaseKeyedPooledObjectFactory<K,V></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>K</code> - The type of keys managed by this factory.</dd><dd><code>V</code> - Type of element managed by this factory.</dd></dl> +<dl> +<dt>All Implemented Interfaces:</dt> +<dd><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2">KeyedPooledObjectFactory</a><K,V></dd> +</dl> +<hr> +<br> +<pre>public abstract class <a href="../../../../src-html/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#line.35">BaseKeyedPooledObjectFactory</a><K,V> +extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2">KeyedPooledObjectFactory</a><K,V></pre> +<div class="block">A base implementation of <code>KeyedPooledObjectFactory</code>. + <p> + All operations defined here are essentially no-op's. + </p> + This class is immutable, and therefore thread-safe.</div> +<dl><dt><span class="strong">Since:</span></dt> + <dd>2.0</dd> +<dt><span class="strong">Version:</span></dt> + <dd>$Revision: 1333925 $</dd> +<dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2"><code>KeyedPooledObjectFactory</code></a></dd></dl> +</li> +</ul> +</div> +<div class="summary"> +<ul class="blockList"> +<li class="blockList"> +<!-- ======== CONSTRUCTOR SUMMARY ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_summary"> +<!-- --> +</a> +<h3>Constructor Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Constructor Summary table, listing constructors, and an explanation"> +<caption><span>Constructors</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colOne" scope="col">Constructor and Description</th> +</tr> +<tr class="altColor"> +<td class="colOne"><code><strong><a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#BaseKeyedPooledObjectFactory()">BaseKeyedPooledObjectFactory</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#activateObject(K,%20org.apache.commons.pool2.PooledObject)">activateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key, + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>> p)</code> +<div class="block">Reinitialize an instance to be returned by the pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract <a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#create(K)">create</a></strong>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key)</code> +<div class="block">Create an instance that can be served by the pool.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)">destroyObject</a></strong>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key, + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>> p)</code> +<div class="block">Destroy an instance no longer needed by the pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code><a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#makeObject(K)">makeObject</a></strong>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key)</code> +<div class="block">Create an instance that can be served by the pool and + wrap it in a <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a> to be managed by the pool.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#passivateObject(K,%20org.apache.commons.pool2.PooledObject)">passivateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key, + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>> p)</code> +<div class="block">Uninitialize an instance to be returned to the idle object pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>boolean</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#validateObject(K,%20org.apache.commons.pool2.PooledObject)">validateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key, + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>> p)</code> +<div class="block">Ensures that the instance is safe to be returned by the pool.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#wrap(V)">wrap</a></strong>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a> value)</code> +<div class="block">Wrap the provided instance with an implementation of + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a>.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BaseKeyedPooledObjectFactory()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BaseKeyedPooledObjectFactory</h4> +<pre>public <a href="../../../../src-html/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#line.35">BaseKeyedPooledObjectFactory</a>()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="create(java.lang.Object)"> +<!-- --> +</a><a name="create(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>create</h4> +<pre>public abstract <a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a> <a href="../../../../src-html/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#line.47">create</a>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key) + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Create an instance that can be served by the pool.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when constructing the object</dd> +<dt><span class="strong">Returns:</span></dt><dd>an instance that can be served by the pool</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if there is a problem creating a new instance, + this will be propagated to the code requesting an object.</dd></dl> +</li> +</ul> +<a name="wrap(java.lang.Object)"> +<!-- --> +</a><a name="wrap(V)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>wrap</h4> +<pre>public abstract <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>> <a href="../../../../src-html/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#line.58">wrap</a>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a> value)</pre> +<div class="block">Wrap the provided instance with an implementation of + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a>.</div> +<dl><dt><span class="strong">Parameters:</span></dt><dd><code>value</code> - the instance to wrap</dd> +<dt><span class="strong">Returns:</span></dt><dd>The provided instance, wrapped by a <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a></dd></dl> +</li> +</ul> +<a name="makeObject(java.lang.Object)"> +<!-- --> +</a><a name="makeObject(K)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>makeObject</h4> +<pre>public <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>> <a href="../../../../src-html/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#line.61">makeObject</a>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key) + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block"><strong>Description copied from interface: <code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#makeObject(K)">KeyedPooledObjectFactory</a></code></strong></div> +<div class="block">Create an instance that can be served by the pool and + wrap it in a <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a> to be managed by the pool.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#makeObject(K)">makeObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2">KeyedPooledObjectFactory</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a>,<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when constructing the object</dd> +<dt><span class="strong">Returns:</span></dt><dd>a <code>PooledObject</code> wrapping an instance that can + be served by the pool.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if there is a problem creating a new instance, + this will be propagated to the code requesting an object.</dd></dl> +</li> +</ul> +<a name="destroyObject(java.lang.Object,org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a><a name="destroyObject(K, org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>destroyObject</h4> +<pre>public void <a href="../../../../src-html/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#line.74">destroyObject</a>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key, + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>> p) + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Destroy an instance no longer needed by the pool. + <p> + The default implementation is a no-op.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)">destroyObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2">KeyedPooledObjectFactory</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a>,<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when selecting the instance</dd><dd><code>p</code> - a <code>PooledObject</code> wrapping the the instance to be destroyed</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - should be avoided as it may be swallowed by + the pool implementation.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#validateObject(K,%20org.apache.commons.pool2.PooledObject)"><code>KeyedPooledObjectFactory.validateObject(K, org.apache.commons.pool2.PooledObject<V>)</code></a>, +<a href="../../../../org/apache/commons/pool2/KeyedObjectPool.html#invalidateObject(K,%20V)"><code>KeyedObjectPool.invalidateObject(K, V)</code></a></dd></dl> +</li> +</ul> +<a name="validateObject(java.lang.Object,org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a><a name="validateObject(K, org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>validateObject</h4> +<pre>public boolean <a href="../../../../src-html/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#line.88">validateObject</a>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key, + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>> p)</pre> +<div class="block">Ensures that the instance is safe to be returned by the pool. + <p> + The default implementation always returns <code>true</code>.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#validateObject(K,%20org.apache.commons.pool2.PooledObject)">validateObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2">KeyedPooledObjectFactory</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a>,<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when selecting the object</dd><dd><code>p</code> - a <code>PooledObject</code> wrapping the the instance to be validated</dd> +<dt><span class="strong">Returns:</span></dt><dd>always <code>true</code> in the default implementation</dd></dl> +</li> +</ul> +<a name="activateObject(java.lang.Object,org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a><a name="activateObject(K, org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>activateObject</h4> +<pre>public void <a href="../../../../src-html/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#line.101">activateObject</a>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key, + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>> p) + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Reinitialize an instance to be returned by the pool. + <p> + The default implementation is a no-op.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#activateObject(K,%20org.apache.commons.pool2.PooledObject)">activateObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2">KeyedPooledObjectFactory</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a>,<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when selecting the object</dd><dd><code>p</code> - a <code>PooledObject</code> wrapping the the instance to be activated</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if there is a problem activating <code>obj</code>, + this exception may be swallowed by the pool.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)"><code>KeyedPooledObjectFactory.destroyObject(K, org.apache.commons.pool2.PooledObject<V>)</code></a></dd></dl> +</li> +</ul> +<a name="passivateObject(java.lang.Object,org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a><a name="passivateObject(K, org.apache.commons.pool2.PooledObject)"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>passivateObject</h4> +<pre>public void <a href="../../../../src-html/org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html#line.114">passivateObject</a>(<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a> key, + <a href="../../../../org/apache/commons/pool2/PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>> p) + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></pre> +<div class="block">Uninitialize an instance to be returned to the idle object pool. + <p> + The default implementation is a no-op.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#passivateObject(K,%20org.apache.commons.pool2.PooledObject)">passivateObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html" title="interface in org.apache.commons.pool2">KeyedPooledObjectFactory</a><<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">K</a>,<a href="../../../../org/apache/commons/pool2/BaseKeyedPooledObjectFactory.html" title="type parameter in BaseKeyedPooledObjectFactory">V</a>></code></dd> +<dt><span class="strong">Parameters:</span></dt><dd><code>key</code> - the key used when selecting the object</dd><dd><code>p</code> - a <code>PooledObject</code> wrapping the the instance to be passivated</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if there is a problem passivating <code>obj</code>, + this exception may be swallowed by the pool.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/KeyedPooledObjectFactory.html#destroyObject(K,%20org.apache.commons.pool2.PooledObject)"><code>KeyedPooledObjectFactory.destroyObject(K, org.apache.commons.pool2.PooledObject<V>)</code></a></dd></dl> +</li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +</div> +<!-- ========= END OF CLASS DATA ========= --> +<!-- ======= START OF BOTTOM NAVBAR ====== --> +<div class="bottomNav"><a name="navbar_bottom"> +<!-- --> +</a><a href="#skip-navbar_bottom" title="Skip navigation links"></a><a name="navbar_bottom_firstrow"> +<!-- --> +</a> +<ul class="navList" title="Navigation"> +<li><a href="../../../../overview-summary.html">Overview</a></li> +<li><a href="package-summary.html">Package</a></li> +<li class="navBarCell1Rev">Class</li> +<li><a href="class-use/BaseKeyedPooledObjectFactory.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>Prev Class</li> +<li><a href="../../../../org/apache/commons/pool2/BaseObjectPool.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/BaseKeyedPooledObjectFactory.html" target="_top">Frames</a></li> +<li><a href="BaseKeyedPooledObjectFactory.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/BaseKeyedPooledObjectFactory.html ------------------------------------------------------------------------------ svn:eol-style = native Added: websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/BaseObjectPool.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/BaseObjectPool.html (added) +++ websites/production/commons/content/proper/commons-pool/api-2.3/org/apache/commons/pool2/BaseObjectPool.html Wed Dec 31 14:00:19 2014 @@ -0,0 +1,528 @@ +<!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>BaseObjectPool (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="BaseObjectPool (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/BaseObjectPool.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/BaseKeyedPooledObjectFactory.html" title="class in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.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/BaseObjectPool.html" target="_top">Frames</a></li> +<li><a href="BaseObjectPool.html" target="_top">No Frames</a></li> +</ul> +<ul class="navList" id="allclasses_navbar_top"> +<li><a href="../../../../allclasses-noframe.html">All Classes</a></li> +</ul> +<div> +<script type="text/javascript"><!-- + allClassesLink = document.getElementById("allclasses_navbar_top"); + if(window==top) { + allClassesLink.style.display = "block"; + } + else { + allClassesLink.style.display = "none"; + } + //--> +</script> +</div> +<div> +<ul class="subNavList"> +<li>Summary: </li> +<li>Nested | </li> +<li>Field | </li> +<li><a href="#constructor_summary">Constr</a> | </li> +<li><a href="#method_summary">Method</a></li> +</ul> +<ul class="subNavList"> +<li>Detail: </li> +<li>Field | </li> +<li><a href="#constructor_detail">Constr</a> | </li> +<li><a href="#method_detail">Method</a></li> +</ul> +</div> +<a name="skip-navbar_top"> +<!-- --> +</a></div> +<!-- ========= END OF TOP NAVBAR ========= --> +<!-- ======== START OF CLASS DATA ======== --> +<div class="header"> +<div class="subTitle">org.apache.commons.pool2</div> +<h2 title="Class BaseObjectPool" class="title">Class BaseObjectPool<T></h2> +</div> +<div class="contentContainer"> +<ul class="inheritance"> +<li><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li> +<li> +<ul class="inheritance"> +<li>org.apache.commons.pool2.BaseObjectPool<T></li> +</ul> +</li> +</ul> +<div class="description"> +<ul class="blockList"> +<li class="blockList"> +<dl><dt><span class="strong">Type Parameters:</span></dt><dd><code>T</code> - Type of element 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> +<dl> +<dt>Direct Known Subclasses:</dt> +<dd><a href="../../../../org/apache/commons/pool2/impl/SoftReferenceObjectPool.html" title="class in org.apache.commons.pool2.impl">SoftReferenceObjectPool</a></dd> +</dl> +<hr> +<br> +<pre>public abstract class <a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line.32">BaseObjectPool</a><T> +extends <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a> +implements <a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><T></pre> +<div class="block">A simple base implementation of <a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2"><code>ObjectPool</code></a>. + Optional operations are implemented to either do nothing, return a value + indicating it is unsupported or throw <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang"><code>UnsupportedOperationException</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: 1566605 $</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/BaseObjectPool.html#BaseObjectPool()">BaseObjectPool</a></strong>()</code> </td> +</tr> +</table> +</li> +</ul> +<!-- ========== METHOD SUMMARY =========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_summary"> +<!-- --> +</a> +<h3>Method Summary</h3> +<table class="overviewSummary" border="0" cellpadding="3" cellspacing="0" summary="Method Summary table, listing methods, and an explanation"> +<caption><span>Methods</span><span class="tabEnd"> </span></caption> +<tr> +<th class="colFirst" scope="col">Modifier and Type</th> +<th class="colLast" scope="col">Method and Description</th> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html#addObject()">addObject</a></strong>()</code> +<div class="block">Not supported in this base implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>protected void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html#assertOpen()">assertOpen</a></strong>()</code> +<div class="block">Throws an <code>IllegalStateException</code> when this pool has been + closed.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>abstract <a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a></code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html#borrowObject()">borrowObject</a></strong>()</code> +<div class="block">Obtains an instance from this pool.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html#clear()">clear</a></strong>()</code> +<div class="block">Not supported in this base implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html#close()">close</a></strong>()</code> +<div class="block">Close this pool, and free any resources associated with it.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html#getNumActive()">getNumActive</a></strong>()</code> +<div class="block">Not supported in this base implementation.</div> +</td> +</tr> +<tr class="altColor"> +<td class="colFirst"><code>int</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html#getNumIdle()">getNumIdle</a></strong>()</code> +<div class="block">Not supported in this base implementation.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html#invalidateObject(T)">invalidateObject</a></strong>(<a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a> obj)</code> +<div class="block">Invalidates an object from the 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/BaseObjectPool.html#isClosed()">isClosed</a></strong>()</code> +<div class="block">Has this pool instance been closed.</div> +</td> +</tr> +<tr class="rowColor"> +<td class="colFirst"><code>abstract void</code></td> +<td class="colLast"><code><strong><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html#returnObject(T)">returnObject</a></strong>(<a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a> obj)</code> +<div class="block">Return an instance to the pool.</div> +</td> +</tr> +</table> +<ul class="blockList"> +<li class="blockList"><a name="methods_inherited_from_class_java.lang.Object"> +<!-- --> +</a> +<h3>Methods inherited from class java.lang.<a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">Object</a></h3> +<code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#clone()" title="class or interface in java.lang">clone</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#equals(java.lang.Object)" title="class or interface in java.lang">equals</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#finalize()" title="class or interface in java.lang">finalize</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#getClass()" title="class or interface in java.lang">getClass</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#hashCode()" title="class or interface in java.lang">hashCode</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#notify()" title="class or interface in java.lang">notify</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang /Object.html?is-external=true#notifyAll()" title="class or interface in java.lang">notifyAll</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#toString()" title="class or interface in java.lang">toString</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait()" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long)" title="class or interface in java.lang">wait</a>, <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Object.html?is-external=true#wait(long,%20int)" title="class or interface in java.lang">wait</a></code></li> +</ul> +</li> +</ul> +</li> +</ul> +</div> +<div class="details"> +<ul class="blockList"> +<li class="blockList"> +<!-- ========= CONSTRUCTOR DETAIL ======== --> +<ul class="blockList"> +<li class="blockList"><a name="constructor_detail"> +<!-- --> +</a> +<h3>Constructor Detail</h3> +<a name="BaseObjectPool()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>BaseObjectPool</h4> +<pre>public <a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line.32">BaseObjectPool</a>()</pre> +</li> +</ul> +</li> +</ul> +<!-- ============ METHOD DETAIL ========== --> +<ul class="blockList"> +<li class="blockList"><a name="method_detail"> +<!-- --> +</a> +<h3>Method Detail</h3> +<a name="borrowObject()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>borrowObject</h4> +<pre>public abstract <a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a> <a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line.35">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"><strong>Description copied from interface: <code><a href="../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()">ObjectPool</a></code></strong></div> +<div class="block">Obtains an instance from this pool. + <p> + Instances returned from this method will have been either newly created + with <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.makeObject()</code></a> or will be a previously + idle object and have been activated with + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#activateObject(org.apache.commons.pool2.PooledObject)"><code>PooledObjectFactory.activateObject(org.apache.commons.pool2.PooledObject<T>)</code></a> and then validated with + <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#validateObject(org.apache.commons.pool2.PooledObject)"><code>PooledObjectFactory.validateObject(org.apache.commons.pool2.PooledObject<T>)</code></a>. + <p> + By contract, clients <strong>must</strong> return the borrowed instance + using <a href="../../../../org/apache/commons/pool2/ObjectPool.html#returnObject(T)"><code>ObjectPool.returnObject(T)</code></a>, <a href="../../../../org/apache/commons/pool2/ObjectPool.html#invalidateObject(T)"><code>ObjectPool.invalidateObject(T)</code></a>, or a related + method as defined in an implementation or sub-interface. + <p> + The behaviour of this method when the pool has been exhausted + is not strictly specified (although it may be specified by + implementations).</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()">borrowObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>an instance from this pool.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - after <a href="../../../../org/apache/commons/pool2/ObjectPool.html#close()"><code>close</code></a> has been called on this pool.</dd> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.makeObject()</code></a> throws an + exception.</dd> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/util/NoSuchElementException.html?is-external=true" title="class or interface in java.util">NoSuchElementException</a></code> - when the pool is exhausted and cannot or will not return + another instance.</dd></dl> +</li> +</ul> +<a name="returnObject(java.lang.Object)"> +<!-- --> +</a><a name="returnObject(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>returnObject</h4> +<pre>public abstract void <a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line.38">returnObject</a>(<a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="type parameter in BaseObjectPool">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"><strong>Description copied from interface: <code><a href="../../../../org/apache/commons/pool2/ObjectPool.html#returnObject(T)">ObjectPool</a></code></strong></div> +<div class="block">Return an instance to the pool. By contract, <code>obj</code> + <strong>must</strong> have been obtained using <a href="../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()"><code>ObjectPool.borrowObject()</code></a> or + a related method as defined in an implementation or sub-interface.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/commons/pool2/ObjectPool.html#returnObject(T)">returnObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="type parameter in BaseObjectPool">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 returned.</dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - if an attempt is made to return an object to the pool that + is in any state other than allocated (i.e. borrowed). + Attempting to return an object more than once or attempting + to return an object that was never borrowed from the pool + will trigger this exception.</dd> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if an instance cannot be returned to the pool</dd></dl> +</li> +</ul> +<a name="invalidateObject(java.lang.Object)"> +<!-- --> +</a><a name="invalidateObject(T)"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>invalidateObject</h4> +<pre>public abstract void <a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line.41">invalidateObject</a>(<a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="type parameter in BaseObjectPool">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"><strong>Description copied from interface: <code><a href="../../../../org/apache/commons/pool2/ObjectPool.html#invalidateObject(T)">ObjectPool</a></code></strong></div> +<div class="block">Invalidates an object from the pool. + <p> + By contract, <code>obj</code> <strong>must</strong> have been obtained + using <a href="../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()"><code>ObjectPool.borrowObject()</code></a> or a related method as defined in an + implementation or sub-interface. + <p> + This method should be used when an object that has been borrowed is + determined (due to an exception or other problem) to be invalid.</div> +<dl> +<dt><strong>Specified by:</strong></dt> +<dd><code><a href="../../../../org/apache/commons/pool2/ObjectPool.html#invalidateObject(T)">invalidateObject</a></code> in interface <code><a href="../../../../org/apache/commons/pool2/ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="../../../../org/apache/commons/pool2/BaseObjectPool.html" title="type parameter in BaseObjectPool">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="getNumIdle()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>getNumIdle</h4> +<pre>public int <a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line.49">getNumIdle</a>()</pre> +<div class="block">Not supported in this base implementation.</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/BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a negative value.</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/BaseObjectPool.html#line.59">getNumActive</a>()</pre> +<div class="block">Not supported in this base implementation.</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/BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a>></code></dd> +<dt><span class="strong">Returns:</span></dt><dd>a negative value.</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/BaseObjectPool.html#line.70">clear</a>() + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>, + <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre> +<div class="block">Not supported in this base implementation.</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/BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the pool does not implement this + method</dd> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - if the pool cannot be cleared</dd></dl> +</li> +</ul> +<a name="addObject()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>addObject</h4> +<pre>public void <a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line.82">addObject</a>() + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a>, + <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></pre> +<div class="block">Not supported in this base implementation. Subclasses should override + this behavior.</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/BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a>></code></dd> +<dt><span class="strong">Throws:</span></dt> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/UnsupportedOperationException.html?is-external=true" title="class or interface in java.lang">UnsupportedOperationException</a></code> - if the pool does not implement this + method</dd> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/Exception.html?is-external=true" title="class or interface in java.lang">Exception</a></code> - when <a href="../../../../org/apache/commons/pool2/PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.makeObject()</code></a> fails.</dd> +<dd><code><a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></code> - after <a href="../../../../org/apache/commons/pool2/ObjectPool.html#close()"><code>ObjectPool.close()</code></a> has been called on this pool.</dd></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/BaseObjectPool.html#line.93">close</a>()</pre> +<div class="block">Close this pool, and free any resources associated with it. + <p> + Calling <a href="../../../../org/apache/commons/pool2/ObjectPool.html#addObject()"><code>ObjectPool.addObject()</code></a> or <a href="../../../../org/apache/commons/pool2/ObjectPool.html#borrowObject()"><code>ObjectPool.borrowObject()</code></a> after invoking this + method on a pool will cause them to throw an <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang"><code>IllegalStateException</code></a>. + <p> + Implementations should silently fail if not all resources can be freed. + <p> + This affects the behavior of <code>isClosed</code> and + <code>assertOpen</code>.</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/BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a>></code></dd> +</dl> +</li> +</ul> +<a name="isClosed()"> +<!-- --> +</a> +<ul class="blockList"> +<li class="blockList"> +<h4>isClosed</h4> +<pre>public final boolean <a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line.102">isClosed</a>()</pre> +<div class="block">Has this pool instance been closed.</div> +<dl><dt><span class="strong">Returns:</span></dt><dd><code>true</code> when this pool has been closed.</dd></dl> +</li> +</ul> +<a name="assertOpen()"> +<!-- --> +</a> +<ul class="blockListLast"> +<li class="blockList"> +<h4>assertOpen</h4> +<pre>protected final void <a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line.114">assertOpen</a>() + throws <a href="http://docs.oracle.com/javase/6/docs/api/java/lang/IllegalStateException.html?is-external=true" title="class or interface in java.lang">IllegalStateException</a></pre> +<div class="block">Throws an <code>IllegalStateException</code> when this pool has been + closed.</div> +<dl><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> - when this pool has been closed.</dd><dt><span class="strong">See Also:</span></dt><dd><a href="../../../../org/apache/commons/pool2/BaseObjectPool.html#isClosed()"><code>isClosed()</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/BaseObjectPool.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/BaseKeyedPooledObjectFactory.html" title="class in org.apache.commons.pool2"><span class="strong">Prev Class</span></a></li> +<li><a href="../../../../org/apache/commons/pool2/BasePooledObjectFactory.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/BaseObjectPool.html" target="_top">Frames</a></li> +<li><a href="BaseObjectPool.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/BaseObjectPool.html ------------------------------------------------------------------------------ svn:eol-style = native