This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git
The following commit(s) were added to refs/heads/master by this push:
new cbe231a Doc and Javadoc.
cbe231a is described below
commit cbe231a1cdea9cd91b9340cc689ddc91722e29b2
Author: Gary Gregory <gardgreg...@gmail.com>
AuthorDate: Thu Jun 3 09:26:48 2021 -0400
Doc and Javadoc.
---
src/main/java/org/apache/commons/pool2/KeyedObjectPool.java | 4 ++--
.../org/apache/commons/pool2/KeyedPooledObjectFactory.java | 10 +++++-----
src/main/java/org/apache/commons/pool2/PooledObject.java | 8 ++++----
.../org/apache/commons/pool2/SwallowedExceptionListener.java | 2 +-
src/site/xdoc/index.xml | 12 +++++++-----
5 files changed, 19 insertions(+), 17 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
index 84c3788..2a1acd4 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
@@ -70,7 +70,7 @@ import java.util.NoSuchElementException;
public interface KeyedObjectPool<K, V> extends Closeable {
/**
- * Create an object using the {@link KeyedPooledObjectFactory factory} or
+ * Creates an object using the {@link KeyedPooledObjectFactory factory} or
* other implementation dependent mechanism, passivate it, and then place
it
* in the idle object pool. {@code addObject} is useful for
* "pre-loading" a pool with idle objects (Optional operation).
@@ -199,7 +199,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
void clear(K key) throws Exception, UnsupportedOperationException;
/**
- * Close this pool, and free any resources associated with it.
+ * Closes this pool, and free any resources associated with it.
* <p>
* Calling {@link #addObject addObject} or
* {@link #borrowObject borrowObject} after invoking this method on a pool
diff --git
a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
index 9f4d734..ac93114 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedPooledObjectFactory.java
@@ -77,7 +77,7 @@ package org.apache.commons.pool2;
public interface KeyedPooledObjectFactory<K, V> {
/**
- * Reinitialize an instance to be returned by the pool.
+ * Reinitializes an instance to be returned by the pool.
*
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the instance to be activated
@@ -90,7 +90,7 @@ public interface KeyedPooledObjectFactory<K, V> {
void activateObject(K key, PooledObject<V> p) throws Exception;
/**
- * Destroy an instance no longer needed by the pool.
+ * Destroys an instance no longer needed by the pool.
* <p>
* It is important for implementations of this method to be aware that
there
* is no guarantee about what state {@code obj} will be in and the
@@ -113,7 +113,7 @@ public interface KeyedPooledObjectFactory<K, V> {
void destroyObject(K key, PooledObject<V> p) throws Exception;
/**
- * Destroy an instance no longer needed by the pool, using the provided
{@link DestroyMode}.
+ * Destroys an instance no longer needed by the pool, using the provided
{@link DestroyMode}.
*
* @param key the key used when selecting the instance
* @param p a {@code PooledObject} wrapping the instance to be destroyed
@@ -133,7 +133,7 @@ public interface KeyedPooledObjectFactory<K, V> {
}
/**
- * Create an instance that can be served by the pool and
+ * Creates an instance that can be served by the pool and
* wrap it in a {@link PooledObject} to be managed by the pool.
*
* @param key the key used when constructing the object
@@ -147,7 +147,7 @@ public interface KeyedPooledObjectFactory<K, V> {
PooledObject<V> makeObject(K key) throws Exception;
/**
- * Uninitialize an instance to be returned to the idle object pool.
+ * Uninitializes an instance to be returned to the idle object pool.
*
* @param key the key used when selecting the object
* @param p a {@code PooledObject} wrapping the instance to be passivated
diff --git a/src/main/java/org/apache/commons/pool2/PooledObject.java
b/src/main/java/org/apache/commons/pool2/PooledObject.java
index cebcf2b..19bfc13 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObject.java
@@ -64,7 +64,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
boolean deallocate();
/**
- * Called to inform the object that the eviction test has ended.
+ * Notifies the object that the eviction test has ended.
*
* @param idleQueue The queue of idle objects to which the object should be
* returned.
@@ -262,7 +262,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
void printStackTrace(PrintWriter writer);
/**
- * Is abandoned object tracking being used? If this is true the
+ * Sets whether to use abandoned object tracking. If this is true the
* implementation will need to record the stack trace of the last caller to
* borrow this object.
*
@@ -272,7 +272,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
void setLogAbandoned(boolean logAbandoned);
/**
- * Configures the stack trace generation strategy based on whether or not
fully detailed stack traces are required.
+ * Sets the stack trace generation strategy based on whether or not fully
detailed stack traces are required.
* When set to false, abandoned logs may only include caller class
information rather than method names, line
* numbers, and other normal metadata available in a full stack trace.
*
@@ -294,7 +294,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
boolean startEvictionTest();
/**
- * Provides a String form of the wrapper for debug purposes. The format is
+ * Gets a String form of the wrapper for debug purposes. The format is
* not fixed and may change at any time.
* <p>
* {@inheritDoc}
diff --git
a/src/main/java/org/apache/commons/pool2/SwallowedExceptionListener.java
b/src/main/java/org/apache/commons/pool2/SwallowedExceptionListener.java
index e109005..69df396 100644
--- a/src/main/java/org/apache/commons/pool2/SwallowedExceptionListener.java
+++ b/src/main/java/org/apache/commons/pool2/SwallowedExceptionListener.java
@@ -27,7 +27,7 @@ package org.apache.commons.pool2;
public interface SwallowedExceptionListener {
/**
- * This method is called every time the implementation unavoidably swallows
+ * Notifies this instance every time the implementation unavoidably
swallows
* an exception.
*
* @param e The exception that was swallowed
diff --git a/src/site/xdoc/index.xml b/src/site/xdoc/index.xml
index 870de8e..c74fbf8 100644
--- a/src/site/xdoc/index.xml
+++ b/src/site/xdoc/index.xml
@@ -33,6 +33,7 @@
instance tracking and pool monitoring.
</p>
<ul>
+ <li>Version 2.11.x requires Java 8 or above.</li>
<li>Version 2.10.x requires Java 8 or above.</li>
<li>Version 2.9.x requires Java 8 or above.</li>
<li>Version 2.8.x requires Java 8 or above.</li>
@@ -64,11 +65,12 @@
</p>
<source>
public interface PooledObjectFactory<T> {
- PooledObject<T> makeObject();
- void activateObject(PooledObject<T> obj);
- void passivateObject(PooledObject<T> obj);
- boolean validateObject(PooledObject<T> obj);
- void destroyObject(PooledObject<T> obj);
+ activateObject(PooledObject<T>)
+ destroyObject(PooledObject<T>)
+ destroyObject(PooledObject<T>, DestroyMode)
+ makeObject()
+ passivateObject(PooledObject<T>)
+ validateObject(PooledObject<T>)
}
</source>
<p>
