Modified: websites/production/commons/content/proper/commons-pool/apidocs/org/apache/commons/pool2/BaseObjectPool.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/apidocs/org/apache/commons/pool2/BaseObjectPool.html (original) +++ websites/production/commons/content/proper/commons-pool/apidocs/org/apache/commons/pool2/BaseObjectPool.html Sat Feb 8 20:08:04 2025 @@ -2,7 +2,7 @@ <html lang> <head> <!-- Generated by javadoc (17) --> -<title>BaseObjectPool (Apache Commons Pool 2.12.1 API)</title> +<title>BaseObjectPool (Apache Commons Pool 2.12.2-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="description" content="declaration: package: org.apache.commons.pool2, class: BaseObjectPool"> @@ -72,7 +72,7 @@ loadScripts(document, 'script');</script <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.commons.pool2</a></div> <h1 title="Class BaseObjectPool" class="title">Class BaseObjectPool<T></h1> </div> -<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance"><a href="BaseObject.html" title="class in org.apache.commons.pool2">org.apache.commons.pool2.BaseObject</a> <div class="inheritance">org.apache.commons.pool2.BaseObjectPool<T></div> </div> @@ -84,7 +84,7 @@ loadScripts(document, 'script');</script </dl> <dl class="notes"> <dt>All Implemented Interfaces:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Closeable.html"; title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/AutoCloseable.html"; title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><T></code></dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html"; title="class or interface in java.io" class="external-link">Closeable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html"; title="class or interface in java.lang" class="external-link">AutoCloseable</a></code>, <code><a href="ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><T></code></dd> </dl> <dl class="notes"> <dt>Direct Known Subclasses:</dt> @@ -96,7 +96,7 @@ loadScripts(document, 'script');</script implements <a href="ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><T></span></div> <div class="block">A simple base implementation of <a href="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="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/UnsupportedOperationException.html"; title="class or interface in java.lang" class="external-link"><code>UnsupportedOperationException</code></a>. + indicating it is unsupported or throw <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html"; title="class or interface in java.lang" class="external-link"><code>UnsupportedOperationException</code></a>. <p> This class is intended to be thread-safe. </p></div> @@ -116,7 +116,9 @@ implements <a href="ObjectPool.html" tit <div class="table-header col-first">Constructor</div> <div class="table-header col-last">Description</div> <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BaseObjectPool</a>()</code></div> -<div class="col-last even-row-color"> </div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new instance.</div> +</div> </div> </section> </li> @@ -183,7 +185,7 @@ implements <a href="ObjectPool.html" tit <div class="block">Returns an instance to the pool.</div> </div> <div class="col-first even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code>protected void</code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toStringAppendFields(java.lang.StringBuilder)" class="member-name-link">toStringAppendFields</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/StringBuilder.html"; title="class or interface in java.lang" class="external-link">StringBuilder</a> builder)</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"><code><a href="#toStringAppendFields(java.lang.StringBuilder)" class="member-name-link">toStringAppendFields</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html"; title="class or interface in java.lang" class="external-link">StringBuilder</a> builder)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab2 method-summary-table-tab4"> <div class="block">Used by sub-classes to include the fields defined by the sub-class in the <a href="BaseObject.html#toString()"><code>BaseObject.toString()</code></a> output.</div> @@ -195,8 +197,8 @@ implements <a href="ObjectPool.html" tit <h3 id="methods-inherited-from-class-org.apache.commons.pool2.BaseObject">Methods inherited from class org.apache.commons.pool2.<a href="BaseObject.html" title="class in org.apache.commons.pool2">BaseObject</a></h3> <code><a href="BaseObject.html#toString()">toString</a></code></div> <div class="inherited-list"> -<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a></h3> -<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Objec t.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--"; title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-"; title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--"; title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--"; title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--"; title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--"; title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.o racle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--"; title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-"; title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-"; title="class or interface in java.lang" class="external-link">wait</a></code></div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-org.apache.commons.pool2.ObjectPool">Methods inherited from interface org.apache.commons.pool2.<a href="ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a></h3> <code><a href="ObjectPool.html#addObjects(int)">addObjects</a>, <a href="ObjectPool.html#invalidateObject(T,org.apache.commons.pool2.DestroyMode)">invalidateObject</a></code></div> @@ -214,7 +216,8 @@ implements <a href="ObjectPool.html" tit <li> <section class="detail" id="<init>()"> <h3>BaseObjectPool</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-30">BaseObjectPool</a></span>()</div> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-37">BaseObjectPool</a></span>()</div> +<div class="block">Constructs a new instance.</div> </section> </li> </ul> @@ -228,31 +231,31 @@ implements <a href="ObjectPool.html" tit <li> <section class="detail" id="addObject()"> <h3>addObject</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-41">addObject</a></span>() - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-48">addObject</a></span>() + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> <div class="block">Not supported in this base implementation. Subclasses should override this behavior.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="ObjectPool.html#addObject()">addObject</a></code> in interface <code><a href="ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a>></code></dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/UnsupportedOperationException.html"; title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if the pool does not implement this +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html"; title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if the pool does not implement this method</dd> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - when <a href="PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.makeObject()</code></a> fails.</dd> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - after <a href="ObjectPool.html#close()"><code>ObjectPool.close()</code></a> has been called on this pool.</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - when <a href="PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.makeObject()</code></a> fails.</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - after <a href="ObjectPool.html#close()"><code>ObjectPool.close()</code></a> has been called on this pool.</dd> </dl> </section> </li> <li> <section class="detail" id="assertOpen()"> <h3>assertOpen</h3> -<div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-53">assertOpen</a></span>() - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> +<div class="member-signature"><span class="modifiers">protected final</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-60">assertOpen</a></span>() + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link">IllegalStateException</a></span></div> <div class="block">Throws an <code>IllegalStateException</code> when this pool has been closed.</div> <dl class="notes"> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - when this pool has been closed.</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - when this pool has been closed.</dd> <dt>See Also:</dt> <dd> <ul class="see-list"> @@ -265,8 +268,8 @@ implements <a href="ObjectPool.html" tit <li> <section class="detail" id="borrowObject()"> <h3>borrowObject</h3> -<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-59">borrowObject</a></span>() - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-66">borrowObject</a></span>() + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ObjectPool.html#borrowObject()">ObjectPool</a></code></span></div> <div class="block">Borrows an instance from this pool. <p> @@ -292,10 +295,10 @@ implements <a href="ObjectPool.html" tit <dt>Returns:</dt> <dd>an instance from this pool.</dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - after <a href="ObjectPool.html#close()"><code>close</code></a> has been called on this pool.</dd> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - when <a href="PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.makeObject()</code></a> throws an +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - after <a href="ObjectPool.html#close()"><code>close</code></a> has been called on this pool.</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - when <a href="PooledObjectFactory.html#makeObject()"><code>PooledObjectFactory.makeObject()</code></a> throws an exception.</dd> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/util/NoSuchElementException.html"; title="class or interface in java.util" class="external-link">NoSuchElementException</a></code> - when the pool is exhausted and cannot or will not return +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/util/NoSuchElementException.html"; title="class or interface in java.util" class="external-link">NoSuchElementException</a></code> - when the pool is exhausted and cannot or will not return another instance.</dd> </dl> </section> @@ -303,27 +306,27 @@ implements <a href="ObjectPool.html" tit <li> <section class="detail" id="clear()"> <h3>clear</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-68">clear</a></span>() - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-75">clear</a></span>() + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> <div class="block">Not supported in this base implementation.</div> <dl class="notes"> <dt>Specified by:</dt> <dd><code><a href="ObjectPool.html#clear()">clear</a></code> in interface <code><a href="ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a>></code></dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/UnsupportedOperationException.html"; title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if the pool does not implement this +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/UnsupportedOperationException.html"; title="class or interface in java.lang" class="external-link">UnsupportedOperationException</a></code> - if the pool does not implement this method</dd> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if the pool cannot be cleared</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if the pool cannot be cleared</dd> </dl> </section> </li> <li> <section class="detail" id="close()"> <h3>close</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-80">close</a></span>()</div> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-87">close</a></span>()</div> <div class="block">Closes this pool, and free any resources associated with it. <p> Calling <a href="ObjectPool.html#addObject()"><code>ObjectPool.addObject()</code></a> or <a href="ObjectPool.html#borrowObject()"><code>ObjectPool.borrowObject()</code></a> after invoking this - method on a pool will cause them to throw an <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link"><code>IllegalStateException</code></a>. + method on a pool will cause them to throw an <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link"><code>IllegalStateException</code></a>. </p> <p> Implementations should silently fail if not all resources can be freed. @@ -334,9 +337,9 @@ implements <a href="ObjectPool.html" tit </p></div> <dl class="notes"> <dt>Specified by:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/AutoCloseable.html#close()" title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/AutoCloseable.html"; title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html#close--"; title="class or interface in java.lang" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/AutoCloseable.html"; title="class or interface in java.lang" class="external-link">AutoCloseable</a></code></dd> <dt>Specified by:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Closeable.html#close()" title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Closeable.html"; title="class or interface in java.io" class="external-link">Closeable</a></code></dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html#close--"; title="class or interface in java.io" class="external-link">close</a></code> in interface <code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Closeable.html"; title="class or interface in java.io" class="external-link">Closeable</a></code></dd> <dt>Specified by:</dt> <dd><code><a href="ObjectPool.html#close()">close</a></code> in interface <code><a href="ObjectPool.html" title="interface in org.apache.commons.pool2">ObjectPool</a><<a href="BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a>></code></dd> </dl> @@ -345,7 +348,7 @@ implements <a href="ObjectPool.html" tit <li> <section class="detail" id="getNumActive()"> <h3>getNumActive</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-90">getNumActive</a></span>()</div> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-97">getNumActive</a></span>()</div> <div class="block">Not supported in this base implementation.</div> <dl class="notes"> <dt>Specified by:</dt> @@ -358,7 +361,7 @@ implements <a href="ObjectPool.html" tit <li> <section class="detail" id="getNumIdle()"> <h3>getNumIdle</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-100">getNumIdle</a></span>()</div> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">int</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-107">getNumIdle</a></span>()</div> <div class="block">Not supported in this base implementation.</div> <dl class="notes"> <dt>Specified by:</dt> @@ -371,8 +374,8 @@ implements <a href="ObjectPool.html" tit <li> <section class="detail" id="invalidateObject(T)"> <h3 id="invalidateObject(java.lang.Object)">invalidateObject</h3> -<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-105">invalidateObject</a></span><wbr><span class="parameters">(<a href="BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a> obj)</span> - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-112">invalidateObject</a></span><wbr><span class="parameters">(<a href="BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a> obj)</span> + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ObjectPool.html#invalidateObject(T)">ObjectPool</a></code></span></div> <div class="block">Invalidates an object from the pool. <p> @@ -390,14 +393,14 @@ implements <a href="ObjectPool.html" tit <dt>Parameters:</dt> <dd><code>obj</code> - a <a href="ObjectPool.html#borrowObject()"><code>borrowed</code></a> instance to be disposed.</dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if the instance cannot be invalidated</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if the instance cannot be invalidated</dd> </dl> </section> </li> <li> <section class="detail" id="isClosed()"> <h3>isClosed</h3> -<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-113">isClosed</a></span>()</div> +<div class="member-signature"><span class="modifiers">public final</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-120">isClosed</a></span>()</div> <div class="block">Has this pool instance been closed.</div> <dl class="notes"> <dt>Returns:</dt> @@ -408,8 +411,8 @@ implements <a href="ObjectPool.html" tit <li> <section class="detail" id="returnObject(T)"> <h3 id="returnObject(java.lang.Object)">returnObject</h3> -<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-117">returnObject</a></span><wbr><span class="parameters">(<a href="BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a> obj)</span> - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-124">returnObject</a></span><wbr><span class="parameters">(<a href="BaseObjectPool.html" title="type parameter in BaseObjectPool">T</a> obj)</span> + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="ObjectPool.html#returnObject(T)">ObjectPool</a></code></span></div> <div class="block">Returns an instance to the pool. By contract, <code>obj</code> <strong>must</strong> have been obtained using <a href="ObjectPool.html#borrowObject()"><code>ObjectPool.borrowObject()</code></a> or @@ -420,19 +423,19 @@ implements <a href="ObjectPool.html" tit <dt>Parameters:</dt> <dd><code>obj</code> - a <a href="ObjectPool.html#borrowObject()"><code>borrowed</code></a> instance to be returned.</dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link">IllegalStateException</a></code> - if an attempt is made to return an object to the pool that +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalStateException.html"; title="class or interface in java.lang" class="external-link">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="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if an instance cannot be returned to the pool</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if an instance cannot be returned to the pool</dd> </dl> </section> </li> <li> <section class="detail" id="toStringAppendFields(java.lang.StringBuilder)"> <h3>toStringAppendFields</h3> -<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-120">toStringAppendFields</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/StringBuilder.html"; title="class or interface in java.lang" class="external-link">StringBuilder</a> builder)</span></div> +<div class="member-signature"><span class="modifiers">protected</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BaseObjectPool.html#line-127">toStringAppendFields</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/StringBuilder.html"; title="class or interface in java.lang" class="external-link">StringBuilder</a> builder)</span></div> <div class="block"><span class="descfrm-type-label">Description copied from class: <code><a href="BaseObject.html#toStringAppendFields(java.lang.StringBuilder)">BaseObject</a></code></span></div> <div class="block">Used by sub-classes to include the fields defined by the sub-class in the <a href="BaseObject.html#toString()"><code>BaseObject.toString()</code></a> output.</div>
Modified: websites/production/commons/content/proper/commons-pool/apidocs/org/apache/commons/pool2/BasePooledObjectFactory.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/apidocs/org/apache/commons/pool2/BasePooledObjectFactory.html (original) +++ websites/production/commons/content/proper/commons-pool/apidocs/org/apache/commons/pool2/BasePooledObjectFactory.html Sat Feb 8 20:08:04 2025 @@ -2,7 +2,7 @@ <html lang> <head> <!-- Generated by javadoc (17) --> -<title>BasePooledObjectFactory (Apache Commons Pool 2.12.1 API)</title> +<title>BasePooledObjectFactory (Apache Commons Pool 2.12.2-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="description" content="declaration: package: org.apache.commons.pool2, class: BasePooledObjectFactory"> @@ -72,7 +72,7 @@ loadScripts(document, 'script');</script <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.commons.pool2</a></div> <h1 title="Class BasePooledObjectFactory" class="title">Class BasePooledObjectFactory<T></h1> </div> -<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> <div class="inheritance"><a href="BaseObject.html" title="class in org.apache.commons.pool2">org.apache.commons.pool2.BaseObject</a> <div class="inheritance">org.apache.commons.pool2.BasePooledObjectFactory<T></div> </div> @@ -118,7 +118,9 @@ implements <a href="PooledObjectFactory. <div class="table-header col-first">Constructor</div> <div class="table-header col-last">Description</div> <div class="col-constructor-name even-row-color"><code><a href="#%3Cinit%3E()" class="member-name-link">BasePooledObjectFactory</a>()</code></div> -<div class="col-last even-row-color"> </div> +<div class="col-last even-row-color"> +<div class="block">Constructs a new instance.</div> +</div> </div> </section> </li> @@ -177,8 +179,8 @@ implements <a href="PooledObjectFactory. <h3 id="methods-inherited-from-class-org.apache.commons.pool2.BaseObject">Methods inherited from class org.apache.commons.pool2.<a href="BaseObject.html" title="class in org.apache.commons.pool2">BaseObject</a></h3> <code><a href="BaseObject.html#toString()">toString</a>, <a href="BaseObject.html#toStringAppendFields(java.lang.StringBuilder)">toStringAppendFields</a></code></div> <div class="inherited-list"> -<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a></h3> -<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Objec t.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int)" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#clone--"; title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#equals-java.lang.Object-"; title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#finalize--"; title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--"; title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#hashCode--"; title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--"; title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.o racle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--"; title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-"; title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-"; title="class or interface in java.lang" class="external-link">wait</a></code></div> <div class="inherited-list"> <h3 id="methods-inherited-from-class-org.apache.commons.pool2.PooledObjectFactory">Methods inherited from interface org.apache.commons.pool2.<a href="PooledObjectFactory.html" title="interface in org.apache.commons.pool2">PooledObjectFactory</a></h3> <code><a href="PooledObjectFactory.html#destroyObject(org.apache.commons.pool2.PooledObject,org.apache.commons.pool2.DestroyMode)">destroyObject</a></code></div> @@ -196,7 +198,8 @@ implements <a href="PooledObjectFactory. <li> <section class="detail" id="<init>()"> <h3>BasePooledObjectFactory</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-33">BasePooledObjectFactory</a></span>()</div> +<div class="member-signature"><span class="modifiers">public</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-38">BasePooledObjectFactory</a></span>()</div> +<div class="block">Constructs a new instance.</div> </section> </li> </ul> @@ -210,8 +213,8 @@ implements <a href="PooledObjectFactory. <li> <section class="detail" id="activateObject(org.apache.commons.pool2.PooledObject)"> <h3>activateObject</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-40">activateObject</a></span><wbr><span class="parameters">(<a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</span> - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-47">activateObject</a></span><wbr><span class="parameters">(<a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</span> + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> <div class="block">No-op.</div> <dl class="notes"> <dt>Specified by:</dt> @@ -219,7 +222,7 @@ implements <a href="PooledObjectFactory. <dt>Parameters:</dt> <dd><code>p</code> - ignored</dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if there is a problem activating <code>obj</code>, +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if there is a problem activating <code>obj</code>, this exception may be swallowed by the pool.</dd> <dt>See Also:</dt> <dd> @@ -233,8 +236,8 @@ implements <a href="PooledObjectFactory. <li> <section class="detail" id="create()"> <h3>create</h3> -<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-54">create</a></span>() - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-61">create</a></span>() + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> <div class="block">Creates an object instance, to be wrapped in a <a href="PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a>. <p>This method <strong>must</strong> support concurrent, multi-threaded invocation.</p></div> @@ -242,7 +245,7 @@ implements <a href="PooledObjectFactory. <dt>Returns:</dt> <dd>an instance to be served by the pool, not null.</dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if there is a problem creating a new instance, +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if there is a problem creating a new instance, this will be propagated to the code requesting an object.</dd> </dl> </section> @@ -250,8 +253,8 @@ implements <a href="PooledObjectFactory. <li> <section class="detail" id="destroyObject(org.apache.commons.pool2.PooledObject)"> <h3>destroyObject</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-61">destroyObject</a></span><wbr><span class="parameters">(<a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</span> - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-68">destroyObject</a></span><wbr><span class="parameters">(<a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</span> + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> <div class="block">No-op.</div> <dl class="notes"> <dt>Specified by:</dt> @@ -259,7 +262,7 @@ implements <a href="PooledObjectFactory. <dt>Parameters:</dt> <dd><code>p</code> - ignored</dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - should be avoided as it may be swallowed by +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - should be avoided as it may be swallowed by the pool implementation.</dd> <dt>See Also:</dt> <dd> @@ -274,8 +277,8 @@ implements <a href="PooledObjectFactory. <li> <section class="detail" id="makeObject()"> <h3>makeObject</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-66">makeObject</a></span>() - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type"><a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-73">makeObject</a></span>() + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> <div class="block"><span class="descfrm-type-label">Description copied from interface: <code><a href="PooledObjectFactory.html#makeObject()">PooledObjectFactory</a></code></span></div> <div class="block">Creates an instance that can be served by the pool and wrap it in a <a href="PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a> to be managed by the pool.</div> @@ -285,7 +288,7 @@ implements <a href="PooledObjectFactory. <dt>Returns:</dt> <dd>a <code>PooledObject</code> wrapping an instance that can be served by the pool, not null.</dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if there is a problem creating a new instance, +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if there is a problem creating a new instance, this will be propagated to the code requesting an object.</dd> </dl> </section> @@ -293,8 +296,8 @@ implements <a href="PooledObjectFactory. <li> <section class="detail" id="passivateObject(org.apache.commons.pool2.PooledObject)"> <h3>passivateObject</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-76">passivateObject</a></span><wbr><span class="parameters">(<a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</span> - throws <span class="exceptions"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">void</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-83">passivateObject</a></span><wbr><span class="parameters">(<a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</span> + throws <span class="exceptions"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></span></div> <div class="block">No-op.</div> <dl class="notes"> <dt>Specified by:</dt> @@ -302,7 +305,7 @@ implements <a href="PooledObjectFactory. <dt>Parameters:</dt> <dd><code>p</code> - ignored</dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if there is a problem passivating <code>obj</code>, +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Exception.html"; title="class or interface in java.lang" class="external-link">Exception</a></code> - if there is a problem passivating <code>obj</code>, this exception may be swallowed by the pool.</dd> <dt>See Also:</dt> <dd> @@ -316,7 +319,7 @@ implements <a href="PooledObjectFactory. <li> <section class="detail" id="validateObject(org.apache.commons.pool2.PooledObject)"> <h3>validateObject</h3> -<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-87">validateObject</a></span><wbr><span class="parameters">(<a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</span></div> +<div class="member-signature"><span class="modifiers">public</span> <span class="return-type">boolean</span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-94">validateObject</a></span><wbr><span class="parameters">(<a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>> p)</span></div> <div class="block">Always returns <code>true</code>.</div> <dl class="notes"> <dt>Specified by:</dt> @@ -331,7 +334,7 @@ implements <a href="PooledObjectFactory. <li> <section class="detail" id="wrap(T)"> <h3 id="wrap(java.lang.Object)">wrap</h3> -<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-99">wrap</a></span><wbr><span class="parameters">(<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a> obj)</span></div> +<div class="member-signature"><span class="modifiers">public abstract</span> <span class="return-type"><a href="PooledObject.html" title="interface in org.apache.commons.pool2">PooledObject</a><<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a>></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/BasePooledObjectFactory.html#line-106">wrap</a></span><wbr><span class="parameters">(<a href="BasePooledObjectFactory.html" title="type parameter in BasePooledObjectFactory">T</a> obj)</span></div> <div class="block">Wraps the provided instance with an implementation of <a href="PooledObject.html" title="interface in org.apache.commons.pool2"><code>PooledObject</code></a>.</div> <dl class="notes"> Modified: websites/production/commons/content/proper/commons-pool/apidocs/org/apache/commons/pool2/DestroyMode.html ============================================================================== --- websites/production/commons/content/proper/commons-pool/apidocs/org/apache/commons/pool2/DestroyMode.html (original) +++ websites/production/commons/content/proper/commons-pool/apidocs/org/apache/commons/pool2/DestroyMode.html Sat Feb 8 20:08:04 2025 @@ -2,7 +2,7 @@ <html lang> <head> <!-- Generated by javadoc (17) --> -<title>DestroyMode (Apache Commons Pool 2.12.1 API)</title> +<title>DestroyMode (Apache Commons Pool 2.12.2-SNAPSHOT API)</title> <meta name="viewport" content="width=device-width, initial-scale=1"> <meta http-equiv="Content-Type" content="text/html; charset=UTF-8"> <meta name="description" content="declaration: package: org.apache.commons.pool2, enum: DestroyMode"> @@ -72,19 +72,19 @@ loadScripts(document, 'script');</script <div class="sub-title"><span class="package-label-in-type">Package</span> <a href="package-summary.html">org.apache.commons.pool2</a></div> <h1 title="Enum DestroyMode" class="title">Enum DestroyMode</h1> </div> -<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> -<div class="inheritance"><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html"; title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="DestroyMode.html" title="enum in org.apache.commons.pool2">DestroyMode</a>> +<div class="inheritance" title="Inheritance Tree"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">java.lang.Object</a> +<div class="inheritance"><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html"; title="class or interface in java.lang" class="external-link">java.lang.Enum</a><<a href="DestroyMode.html" title="enum in org.apache.commons.pool2">DestroyMode</a>> <div class="inheritance">org.apache.commons.pool2.DestroyMode</div> </div> </div> <section class="class-description" id="class-description"> <dl class="notes"> <dt>All Implemented Interfaces:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/io/Serializable.html"; title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Comparable.html"; title="class or interface in java.lang" class="external-link">Comparable</a><<a href="DestroyMode.html" title="enum in org.apache.commons.pool2">DestroyMode</a>></code></dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/io/Serializable.html"; title="class or interface in java.io" class="external-link">Serializable</a></code>, <code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Comparable.html"; title="class or interface in java.lang" class="external-link">Comparable</a><<a href="DestroyMode.html" title="enum in org.apache.commons.pool2">DestroyMode</a>></code></dd> </dl> <hr> <div class="type-signature"><span class="modifiers">public enum </span><span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/DestroyMode.html#line-25">DestroyMode</a></span> -<span class="extends-implements">extends <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html"; title="class or interface in java.lang" class="external-link">Enum</a><<a href="DestroyMode.html" title="enum in org.apache.commons.pool2">DestroyMode</a>></span></div> +<span class="extends-implements">extends <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html"; title="class or interface in java.lang" class="external-link">Enum</a><<a href="DestroyMode.html" title="enum in org.apache.commons.pool2">DestroyMode</a>></span></div> <div class="block">Destroy context provided to object factories via <code>destroyObject</code> and <code>invalidateObject</code> methods. Values provide information about why the pool is asking for a pooled object to be destroyed.</div> <dl class="notes"> @@ -125,7 +125,7 @@ loadScripts(document, 'script');</script <div class="table-header col-second">Method</div> <div class="table-header col-last">Description</div> <div class="col-first even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code>static <a href="DestroyMode.html" title="enum in org.apache.commons.pool2">DestroyMode</a></code></div> -<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name)</code></div> +<div class="col-second even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"><code><a href="#valueOf(java.lang.String)" class="member-name-link">valueOf</a><wbr>(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name)</code></div> <div class="col-last even-row-color method-summary-table method-summary-table-tab1 method-summary-table-tab4"> <div class="block">Returns the enum constant of this type with the specified name.</div> </div> @@ -139,11 +139,11 @@ the order they are declared.</div> </div> </div> <div class="inherited-list"> -<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html"; title="class or interface in java.lang" class="external-link">Enum</a></h3> -<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html#clone()" title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html#compareTo(E)" title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html#equals(java.lang.Object)" title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html#finalize()" title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html#getDeclaringClass()" title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java /lang/Enum.html#hashCode()" title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html#name()" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html#ordinal()" title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html#toString()" title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Enum.html#valueOf(java.lang.Class,java.lang.String)" title="class or interface in java.lang" class="external-link">valueOf</a></code></div> +<h3 id="methods-inherited-from-class-java.lang.Enum">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html"; title="class or interface in java.lang" class="external-link">Enum</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#clone--"; title="class or interface in java.lang" class="external-link">clone</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#compareTo-E-"; title="class or interface in java.lang" class="external-link">compareTo</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#equals-java.lang.Object-"; title="class or interface in java.lang" class="external-link">equals</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#finalize--"; title="class or interface in java.lang" class="external-link">finalize</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#getDeclaringClass--"; title="class or interface in java.lang" class="external-link">getDeclaringClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#hashCode--"; title="class or interface in java.lang" class="external-link">hashCode</a>, <a href="h ttps://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#name--" title="class or interface in java.lang" class="external-link">name</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#ordinal--"; title="class or interface in java.lang" class="external-link">ordinal</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#toString--"; title="class or interface in java.lang" class="external-link">toString</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Enum.html#valueOf-java.lang.Class-java.lang.String-"; title="class or interface in java.lang" class="external-link">valueOf</a></code></div> <div class="inherited-list"> -<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a></h3> -<code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#getClass()" title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notify()" title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#notifyAll()" title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait()" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long)" title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/Object.html#wait(long,int )" title="class or interface in java.lang" class="external-link">wait</a></code></div> +<h3 id="methods-inherited-from-class-java.lang.Object">Methods inherited from class java.lang.<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html"; title="class or interface in java.lang" class="external-link">Object</a></h3> +<code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#getClass--"; title="class or interface in java.lang" class="external-link">getClass</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notify--"; title="class or interface in java.lang" class="external-link">notify</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#notifyAll--"; title="class or interface in java.lang" class="external-link">notifyAll</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait--"; title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-"; title="class or interface in java.lang" class="external-link">wait</a>, <a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html#wait-long-int-"; title="class or interface in java.lang" class="external-link">wait</a></code></div> </section> </li> </ul> @@ -192,7 +192,7 @@ the order they are declared.</div> <li> <section class="detail" id="valueOf(java.lang.String)"> <h3>valueOf</h3> -<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DestroyMode.html" title="enum in org.apache.commons.pool2">DestroyMode</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/DestroyMode.html#line-25">valueOf</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name)</span></div> +<div class="member-signature"><span class="modifiers">public static</span> <span class="return-type"><a href="DestroyMode.html" title="enum in org.apache.commons.pool2">DestroyMode</a></span> <span class="element-name"><a href="../../../../src-html/org/apache/commons/pool2/DestroyMode.html#line-25">valueOf</a></span><wbr><span class="parameters">(<a href="https://docs.oracle.com/javase/8/docs/api/java/lang/String.html"; title="class or interface in java.lang" class="external-link">String</a> name)</span></div> <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 @@ -203,8 +203,8 @@ not permitted.)</div> <dt>Returns:</dt> <dd>the enum constant with the specified name</dd> <dt>Throws:</dt> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/IllegalArgumentException.html"; title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> -<dd><code><a href="https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/lang/NullPointerException.html"; title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/IllegalArgumentException.html"; title="class or interface in java.lang" class="external-link">IllegalArgumentException</a></code> - if this enum type has no constant with the specified name</dd> +<dd><code><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/NullPointerException.html"; title="class or interface in java.lang" class="external-link">NullPointerException</a></code> - if the argument is null</dd> </dl> </section> </li>
