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
commit 77afafd599b15069a4920f8c0c79e4c528c081c7
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Mon Feb 15 17:06:39 2021 -0500
Javadoc: Use "Gets..." for getters and "Sets..." for setters.
---
.../java/org/apache/commons/pool2/KeyedObjectPool.java | 8 ++++----
src/main/java/org/apache/commons/pool2/ObjectPool.java | 4 ++--
src/main/java/org/apache/commons/pool2/PoolUtils.java | 8 ++++----
src/main/java/org/apache/commons/pool2/PooledObject.java | 4 ++--
.../org/apache/commons/pool2/impl/AbandonedConfig.java | 2 +-
.../apache/commons/pool2/impl/BaseGenericObjectPool.java | 16 ++++++++--------
.../org/apache/commons/pool2/impl/CallStackUtils.java | 2 +-
.../apache/commons/pool2/impl/DefaultPooledObject.java | 4 ++--
.../commons/pool2/impl/GenericKeyedObjectPool.java | 6 +++---
.../org/apache/commons/pool2/impl/GenericObjectPool.java | 10 +++++-----
.../apache/commons/pool2/impl/LinkedBlockingDeque.java | 2 +-
.../apache/commons/pool2/impl/PooledSoftReference.java | 4 ++--
.../commons/pool2/impl/SoftReferenceObjectPool.java | 6 +++---
13 files changed, 38 insertions(+), 38 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
index bb1380c..65f2d37 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
@@ -213,7 +213,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
void close();
/**
- * Returns the total number of instances currently borrowed from this pool
but
+ * Gets the total number of instances currently borrowed from this pool but
* not yet returned. Returns a negative value if this information is not
* available.
* @return the total number of instances currently borrowed from this pool
but
@@ -222,7 +222,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
int getNumActive();
/**
- * Returns the number of instances currently borrowed from but not yet
+ * Gets the number of instances currently borrowed from but not yet
* returned to the pool corresponding to the given {@code key}.
* Returns a negative value if this information is not available.
*
@@ -233,14 +233,14 @@ public interface KeyedObjectPool<K, V> extends Closeable {
int getNumActive(K key);
/**
- * Returns the total number of instances currently idle in this pool.
+ * Gets the total number of instances currently idle in this pool.
* Returns a negative value if this information is not available.
* @return the total number of instances currently idle in this pool.
*/
int getNumIdle();
/**
- * Returns the number of instances corresponding to the given
+ * Gets the number of instances corresponding to the given
* {@code key} currently idle in this pool. Returns a negative value if
* this information is not available.
*
diff --git a/src/main/java/org/apache/commons/pool2/ObjectPool.java
b/src/main/java/org/apache/commons/pool2/ObjectPool.java
index 5e171cb..9d01dde 100644
--- a/src/main/java/org/apache/commons/pool2/ObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/ObjectPool.java
@@ -151,14 +151,14 @@ public interface ObjectPool<T> extends Closeable {
void close();
/**
- * Returns the number of instances currently borrowed from this pool.
Returns
+ * Gets the number of instances currently borrowed from this pool. Returns
* a negative value if this information is not available.
* @return the number of instances currently borrowed from this pool.
*/
int getNumActive();
/**
- * Returns the number of instances currently idle in this pool. This may be
+ * Gets the number of instances currently idle in this pool. This may be
* considered an approximation of the number of objects that can be
* {@link #borrowObject borrowed} without creating any new instances.
* Returns a negative value if this information is not available.
diff --git a/src/main/java/org/apache/commons/pool2/PoolUtils.java
b/src/main/java/org/apache/commons/pool2/PoolUtils.java
index 70206b8..ac1ca5f 100644
--- a/src/main/java/org/apache/commons/pool2/PoolUtils.java
+++ b/src/main/java/org/apache/commons/pool2/PoolUtils.java
@@ -74,7 +74,7 @@ public final class PoolUtils {
}
/**
- * Returns the time of the next erosion event.
+ * Gets the time of the next erosion event.
*
* @return next shrink time
*/
@@ -210,7 +210,7 @@ public final class PoolUtils {
}
/**
- * Returns the eroding factor for the given key
+ * Gets the eroding factor for the given key
*
* @param key
* key
@@ -221,7 +221,7 @@ public final class PoolUtils {
}
/**
- * Returns the underlying pool
+ * Gets the underlying pool
*
* @return the keyed pool that this ErodingKeyedObjectPool wraps
*/
@@ -419,7 +419,7 @@ public final class PoolUtils {
}
/**
- * Returns obj to the pool, unless erosion is triggered, in which case
+ * Returns * Gets obj to the pool, unless erosion is triggered, in
which case
* obj is invalidated. Erosion is triggered when there are idle
* instances in the pool and more than the {@link #factor erosion
* factor}-determined time has elapsed since the last returnObject
diff --git a/src/main/java/org/apache/commons/pool2/PooledObject.java
b/src/main/java/org/apache/commons/pool2/PooledObject.java
index 1e5fc06..1547445 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObject.java
@@ -125,7 +125,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
long getLastReturnTime();
/**
- * Returns an estimate of the last time this object was used. If the class
+ * Gets an estimate of the last time this object was used. If the class
* of the pooled object implements {@link TrackedUse}, what is returned is
* the maximum of {@link TrackedUse#getLastUsed()} and
* {@link #getLastBorrowTime()}; otherwise this method gives the same
@@ -144,7 +144,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
T getObject();
/**
- * Returns the state of this object.
+ * Gets the state of this object.
* @return state
*/
PooledObjectState getState();
diff --git a/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
b/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
index 0d94c7d..08a79e7 100644
--- a/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
+++ b/src/main/java/org/apache/commons/pool2/impl/AbandonedConfig.java
@@ -95,7 +95,7 @@ public class AbandonedConfig {
}
/**
- * Returns the log writer being used by this configuration to log
+ * Gets the log writer being used by this configuration to log
* information on abandoned objects. If not set, a PrintWriter based on
* System.out with the system default encoding is used.
*
diff --git
a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
index a642426..78e5457 100644
--- a/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/BaseGenericObjectPool.java
@@ -176,7 +176,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
}
/**
- * Returns whether to block when the {@code borrowObject()} method is
+ * Gets whether to block when the {@code borrowObject()} method is
* invoked when the pool is exhausted (the maximum number of "active"
* objects has been reached).
*
@@ -268,7 +268,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
}
/**
- * Returns whether the pool has LIFO (last in, first out) behavior with
+ * Gets whether the pool has LIFO (last in, first out) behavior with
* respect to idle objects - always returning the most recently used object
* from the pool, or as a FIFO (first in, first out) queue, where the pool
* always returns the oldest object in the idle object pool.
@@ -284,7 +284,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
}
/**
- * Returns whether or not the pool serves threads waiting to borrow
objects fairly.
+ * Gets whether or not the pool serves threads waiting to borrow objects
fairly.
* True means that waiting threads are served as if waiting in a FIFO
queue.
*
* @return {@code true} if waiting threads are to be served
@@ -311,7 +311,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
}
/**
- * Returns whether objects created for the pool will be validated before
+ * Gets whether objects created for the pool will be validated before
* being returned from the {@code borrowObject()} method. Validation is
* performed by the {@code validateObject()} method of the factory
* associated with the pool. If the object fails to validate, then
@@ -348,7 +348,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
}
/**
- * Returns whether objects borrowed from the pool will be validated before
+ * Gets whether objects borrowed from the pool will be validated before
* being returned from the {@code borrowObject()} method. Validation is
* performed by the {@code validateObject()} method of the factory
* associated with the pool. If the object fails to validate, it will be
@@ -383,7 +383,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
}
/**
- * Returns whether objects borrowed from the pool will be validated when
+ * Gets whether objects borrowed from the pool will be validated when
* they are returned to the pool via the {@code returnObject()} method.
* Validation is performed by the {@code validateObject()} method of
* the factory associated with the pool. Returning objects that fail
validation
@@ -416,7 +416,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
}
/**
- * Returns whether objects sitting idle in the pool will be validated by
the
+ * Gets whether objects sitting idle in the pool will be validated by the
* idle object evictor (if any - see
* {@link #setTimeBetweenEvictionRuns(Duration)}). Validation is performed
* by the {@code validateObject()} method of the factory associated
@@ -433,7 +433,7 @@ public abstract class BaseGenericObjectPool<T> extends
BaseObject {
}
/**
- * Returns whether objects sitting idle in the pool will be validated by
the
+ * Sets whether objects sitting idle in the pool will be validated by the
* idle object evictor (if any - see
* {@link #setTimeBetweenEvictionRuns(Duration)}). Validation is performed
* by the {@code validateObject()} method of the factory associated
diff --git a/src/main/java/org/apache/commons/pool2/impl/CallStackUtils.java
b/src/main/java/org/apache/commons/pool2/impl/CallStackUtils.java
index 6b132a9..1fdcad2 100644
--- a/src/main/java/org/apache/commons/pool2/impl/CallStackUtils.java
+++ b/src/main/java/org/apache/commons/pool2/impl/CallStackUtils.java
@@ -26,7 +26,7 @@ import java.security.AccessControlException;
public final class CallStackUtils {
/**
- * Returns whether the caller can create a security manager in the current
environment.
+ * Tests whether the caller can create a security manager in the current
environment.
*
* @return {@code true} if it is able to create a security manager in the
current environment, {@code false}
* otherwise.
diff --git
a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
index f73f053..7d513e1 100644
--- a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
@@ -109,7 +109,7 @@ public class DefaultPooledObject<T> implements
PooledObject<T> {
}
/**
- * Returns an estimate of the last time this object was used. If the class
+ * Gets an estimate of the last time this object was used. If the class
* of the pooled object implements {@link TrackedUse}, what is returned is
* the maximum of {@link TrackedUse#getLastUsed()} and
* {@link #getLastBorrowTime()}; otherwise this method gives the same
@@ -248,7 +248,7 @@ public class DefaultPooledObject<T> implements
PooledObject<T> {
}
/**
- * Returns the state of this object.
+ * Gets the state of this object.
* @return state
*/
@Override
diff --git
a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
index 8e65a61..94a880a 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
@@ -121,7 +121,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
}
/**
- * Returns the limit on the number of object instances allocated by the
pool
+ * Gets the limit on the number of object instances allocated by the pool
* (checked out or idle), per key. When the limit is reached, the sub-pool
* is said to be exhausted. A negative value indicates no limit.
*
@@ -149,7 +149,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
/**
- * Returns the cap on the number of "idle" instances per key in the pool.
+ * Gets the cap on the number of "idle" instances per key in the pool.
* If maxIdlePerKey is set too low on heavily loaded systems it is possible
* you will see objects being destroyed and almost immediately new objects
* being created. This is a result of the active threads momentarily
@@ -211,7 +211,7 @@ public class GenericKeyedObjectPool<K, T> extends
BaseGenericObjectPool<T>
}
/**
- * Returns the target for the minimum number of idle objects to maintain in
+ * Gets the target for the minimum number of idle objects to maintain in
* each of the keyed sub-pools. This setting only has an effect if it is
* positive and {@link #getTimeBetweenEvictionRunsMillis()} is greater than
* zero. If this is the case, an attempt is made to ensure that each
diff --git a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
index f37f614..a0ec3e5 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
@@ -144,7 +144,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
}
/**
- * Returns the cap on the number of "idle" instances in the pool. If
maxIdle
+ * Gets the cap on the number of "idle" instances in the pool. If maxIdle
* is set too low on heavily loaded systems it is possible you will see
* objects being destroyed and almost immediately new objects being
created.
* This is a result of the active threads momentarily returning objects
@@ -163,7 +163,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
}
/**
- * Returns the cap on the number of "idle" instances in the pool. If
maxIdle
+ * Sets the cap on the number of "idle" instances in the pool. If maxIdle
* is set too low on heavily loaded systems it is possible you will see
* objects being destroyed and almost immediately new objects being
created.
* This is a result of the active threads momentarily returning objects
@@ -205,7 +205,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
}
/**
- * Returns the target for the minimum number of idle objects to maintain in
+ * Gets the target for the minimum number of idle objects to maintain in
* the pool. This setting only has an effect if it is positive and
* {@link #getTimeBetweenEvictionRunsMillis()} is greater than zero. If
this
* is the case, an attempt is made to ensure that the pool has the required
@@ -1137,7 +1137,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
private volatile String factoryType = null;
/**
- * Returns an estimate of the number of threads currently blocked waiting
for
+ * Gets an estimate of the number of threads currently blocked waiting for
* an object from the pool. This is intended for monitoring only, not for
* synchronization control.
*
@@ -1153,7 +1153,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
}
/**
- * Returns the type - including the specific type rather than the generic -
+ * Gets the type - including the specific type rather than the generic -
* of the factory.
*
* @return A string representation of the factory type
diff --git
a/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
b/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
index 1a48902..0a909e4 100644
--- a/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
+++ b/src/main/java/org/apache/commons/pool2/impl/LinkedBlockingDeque.java
@@ -562,7 +562,7 @@ class LinkedBlockingDeque<E> extends AbstractQueue<E>
}
/**
- * Returns the length of the queue of threads waiting to take instances
from this deque. See disclaimer on accuracy
+ * Gets the length of the queue of threads waiting to take instances from
this deque. See disclaimer on accuracy
* in {@link
java.util.concurrent.locks.ReentrantLock#getWaitQueueLength(Condition)}.
*
* @return number of threads waiting on this deque's notEmpty condition.
diff --git
a/src/main/java/org/apache/commons/pool2/impl/PooledSoftReference.java
b/src/main/java/org/apache/commons/pool2/impl/PooledSoftReference.java
index d93ee40..2e3c54c 100644
--- a/src/main/java/org/apache/commons/pool2/impl/PooledSoftReference.java
+++ b/src/main/java/org/apache/commons/pool2/impl/PooledSoftReference.java
@@ -44,7 +44,7 @@ public class PooledSoftReference<T> extends
DefaultPooledObject<T> {
}
/**
- * Returns the object that the wrapped SoftReference refers to.
+ * Gets the object that the wrapped SoftReference refers to.
* <p>
* Note that if the reference has been cleared, this method will return
* null.
@@ -74,7 +74,7 @@ public class PooledSoftReference<T> extends
DefaultPooledObject<T> {
}
/**
- * Returns the SoftReference wrapped by this object.
+ * Gets the SoftReference wrapped by this object.
*
* @return underlying SoftReference
*/
diff --git
a/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
b/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
index 5b9a4a6..eee0ff1 100644
--- a/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/SoftReferenceObjectPool.java
@@ -304,7 +304,7 @@ public class SoftReferenceObjectPool<T> extends
BaseObjectPool<T> {
}
/**
- * Returns an approximation not less than the of the number of idle
+ * Gets an approximation not less than the of the number of idle
* instances in the pool.
*
* @return estimated number of idle instances in the pool
@@ -316,7 +316,7 @@ public class SoftReferenceObjectPool<T> extends
BaseObjectPool<T> {
}
/**
- * Returns the number of instances currently borrowed from this pool.
+ * Gets the number of instances currently borrowed from this pool.
*
* @return the number of instances currently borrowed from this pool
*/
@@ -362,7 +362,7 @@ public class SoftReferenceObjectPool<T> extends
BaseObjectPool<T> {
}
/**
- * Returns the {@link PooledObjectFactory} used by this pool to create and
+ * Gets the {@link PooledObjectFactory} used by this pool to create and
* manage object instances.
*
* @return the factory
