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 9df8d27 Javadoc: Use "Gets..." for getters and "Borrows..." for
borrowers.
9df8d27 is described below
commit 9df8d2734c2ff2c83fd54c6ea3b200ac5e477d92
Author: Gary Gregory <[email protected]>
AuthorDate: Mon Feb 15 18:00:40 2021 -0500
Javadoc: Use "Gets..." for getters and "Borrows..." for borrowers.
---
src/main/java/org/apache/commons/pool2/KeyedObjectPool.java | 2 +-
src/main/java/org/apache/commons/pool2/ObjectPool.java | 2 +-
src/main/java/org/apache/commons/pool2/PooledObject.java | 12 ++++++------
.../org/apache/commons/pool2/impl/GenericObjectPool.java | 2 +-
.../java/org/apache/commons/pool2/impl/PoolImplUtils.java | 2 +-
5 files changed, 10 insertions(+), 10 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
index 65f2d37..84c3788 100644
--- a/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/KeyedObjectPool.java
@@ -138,7 +138,7 @@ public interface KeyedObjectPool<K, V> extends Closeable {
}
/**
- * Obtains an instance from this pool for the specified {@code key}.
+ * Borrows an instance from this pool for the specified {@code key}.
* <p>
* Instances returned from this method will have been either newly created
* with {@link KeyedPooledObjectFactory#makeObject makeObject} or will be
diff --git a/src/main/java/org/apache/commons/pool2/ObjectPool.java
b/src/main/java/org/apache/commons/pool2/ObjectPool.java
index 9d01dde..7a86141 100644
--- a/src/main/java/org/apache/commons/pool2/ObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/ObjectPool.java
@@ -92,7 +92,7 @@ public interface ObjectPool<T> extends Closeable {
}
/**
- * Obtains an instance from this pool.
+ * Borrows an instance from this pool.
* <p>
* Instances returned from this method will have been either newly created
* with {@link PooledObjectFactory#makeObject} or will be a previously
diff --git a/src/main/java/org/apache/commons/pool2/PooledObject.java
b/src/main/java/org/apache/commons/pool2/PooledObject.java
index 1547445..25d7736 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObject.java
@@ -75,7 +75,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
boolean equals(Object obj);
/**
- * Obtains the time in milliseconds that this object last spent in the
+ * Gets the time in milliseconds that this object last spent in the
* active state (it may still be active in which case subsequent calls will
* return an increased value).
*
@@ -94,7 +94,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
}
/**
- * Obtains the time (using the same basis as
+ * Gets the time (using the same basis as
* {@link System#currentTimeMillis()}) that this object was created.
*
* @return The creation time for the wrapped object
@@ -102,7 +102,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
long getCreateTime();
/**
- * Obtains the time in milliseconds that this object last spend in the
+ * Gets the time in milliseconds that this object last spend in the
* idle state (it may still be idle in which case subsequent calls will
* return an increased value).
*
@@ -111,14 +111,14 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
long getIdleTimeMillis();
/**
- * Obtains the time the wrapped object was last borrowed.
+ * Gets the time the wrapped object was last borrowed.
*
* @return The time the object was last borrowed
*/
long getLastBorrowTime();
/**
- * Obtains the time the wrapped object was last returned.
+ * Gets the time the wrapped object was last returned.
*
* @return The time the object was last returned
*/
@@ -136,7 +136,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
long getLastUsedTime();
/**
- * Obtains the underlying object that is wrapped by this instance of
+ * Gets the underlying object that is wrapped by this instance of
* {@link PooledObject}.
*
* @return The wrapped object
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 183bcc1..d4bfc44 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
@@ -715,7 +715,7 @@ public class GenericObjectPool<T> extends
BaseGenericObjectPool<T>
}
/**
- * Obtains a reference to the factory used to create, destroy and validate
+ * Gets a reference to the factory used to create, destroy and validate
* the objects used by this pool.
*
* @return the factory
diff --git a/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
b/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
index 1233e08..90b5039 100644
--- a/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
+++ b/src/main/java/org/apache/commons/pool2/impl/PoolImplUtils.java
@@ -67,7 +67,7 @@ class PoolImplUtils {
}
/**
- * Obtains the concrete type used by an implementation of an interface
that uses a generic type.
+ * Gets the concrete type used by an implementation of an interface that
uses a generic type.
*
* @param type
* The interface that defines a generic type
