This is an automated email from the ASF dual-hosted git repository.
garydgregory 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 96be0de7 Javadoc
96be0de7 is described below
commit 96be0de7b0a76d992be9eaca2641476e2cfaa7a3
Author: Gary Gregory <[email protected]>
AuthorDate: Sat Jul 11 08:57:28 2026 -0400
Javadoc
---
.../org/apache/commons/pool3/KeyedObjectPool.java | 8 +++---
.../java/org/apache/commons/pool3/ObjectPool.java | 4 +--
.../java/org/apache/commons/pool3/PoolUtils.java | 8 +++---
.../org/apache/commons/pool3/PooledObject.java | 4 +--
.../java/org/apache/commons/pool3/TrackedUse.java | 2 +-
.../apache/commons/pool3/impl/AbandonedConfig.java | 2 +-
.../commons/pool3/impl/BaseGenericObjectPool.java | 32 +++++++++++-----------
.../commons/pool3/impl/DefaultPooledObject.java | 4 +--
.../pool3/impl/DefaultPooledObjectInfo.java | 2 +-
.../apache/commons/pool3/impl/EvictionTimer.java | 4 +--
.../commons/pool3/impl/GenericKeyedObjectPool.java | 6 ++--
.../commons/pool3/impl/GenericObjectPool.java | 4 +--
.../commons/pool3/impl/LinkedBlockingDeque.java | 24 ++++++++--------
.../apache/commons/pool3/impl/PoolImplUtils.java | 8 +++---
.../pool3/impl/ResilientPooledObjectFactory.java | 28 +++++++++----------
.../pool3/impl/SoftReferenceObjectPool.java | 4 +--
.../commons/pool3/proxy/BaseProxyHandler.java | 4 +--
.../apache/commons/pool3/proxy/ProxySource.java | 2 +-
.../commons/pool3/AbstractTestKeyedObjectPool.java | 4 +--
.../commons/pool3/AbstractTestObjectPool.java | 2 +-
.../apache/commons/pool3/TestBaseObjectPool.java | 2 +-
.../org/apache/commons/pool3/WaiterFactory.java | 2 +-
22 files changed, 80 insertions(+), 80 deletions(-)
diff --git a/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java
b/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java
index 7cc7ed13..da5a5400 100644
--- a/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/KeyedObjectPool.java
@@ -221,7 +221,7 @@ public interface KeyedObjectPool<K, V, E extends Exception>
extends Closeable {
* 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
+ * @return The total number of instances currently borrowed from this pool
but
* not yet returned.
*/
int getNumActive();
@@ -232,7 +232,7 @@ public interface KeyedObjectPool<K, V, E extends Exception>
extends Closeable {
* Returns a negative value if this information is not available.
*
* @param key the key to query
- * @return the number of instances currently borrowed from but not yet
+ * @return The number of instances currently borrowed from but not yet
* returned to the pool corresponding to the given {@code key}.
*/
int getNumActive(K key);
@@ -241,7 +241,7 @@ public interface KeyedObjectPool<K, V, E extends Exception>
extends Closeable {
* 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.
+ * @return The total number of instances currently idle in this pool.
*/
int getNumIdle();
@@ -251,7 +251,7 @@ public interface KeyedObjectPool<K, V, E extends Exception>
extends Closeable {
* this information is not available.
*
* @param key the key to query
- * @return the number of instances corresponding to the given
+ * @return The number of instances corresponding to the given
* {@code key} currently idle in this pool.
*/
int getNumIdle(K key);
diff --git a/src/main/java/org/apache/commons/pool3/ObjectPool.java
b/src/main/java/org/apache/commons/pool3/ObjectPool.java
index 92df52d6..fe2130e4 100644
--- a/src/main/java/org/apache/commons/pool3/ObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/ObjectPool.java
@@ -149,7 +149,7 @@ public interface ObjectPool<T, E extends Exception> extends
Closeable {
* 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.
+ * @return The number of instances currently borrowed from this pool.
*/
int getNumActive();
@@ -159,7 +159,7 @@ public interface ObjectPool<T, E extends Exception> extends
Closeable {
* {@link #borrowObject borrowed} without creating any new instances.
* Returns a negative value if this information is not available.
*
- * @return the number of instances currently idle in this pool.
+ * @return The number of instances currently idle in this pool.
*/
int getNumIdle();
diff --git a/src/main/java/org/apache/commons/pool3/PoolUtils.java
b/src/main/java/org/apache/commons/pool3/PoolUtils.java
index f6d503c6..bf29b04d 100644
--- a/src/main/java/org/apache/commons/pool3/PoolUtils.java
+++ b/src/main/java/org/apache/commons/pool3/PoolUtils.java
@@ -223,7 +223,7 @@ public final class PoolUtils {
/**
* Gets the underlying pool
*
- * @return the keyed pool that this ErodingKeyedObjectPool wraps
+ * @return The keyed pool that this ErodingKeyedObjectPool wraps
*/
protected KeyedObjectPool<K, V, E> getKeyedPool() {
return keyedPool;
@@ -1394,7 +1394,7 @@ public final class PoolUtils {
* @param <K> The type of the pool key
* @param <V> The type of pool entries
* @param <E> The type of exception thrown by a pool
- * @return the {@link TimerTask} that will periodically check the pools
idle
+ * @return The {@link TimerTask} that will periodically check the pools
idle
* object count.
* @throws IllegalArgumentException
* when {@code keyedPool}, {@code key} is {@code null} or
@@ -1435,7 +1435,7 @@ public final class PoolUtils {
* see {@link Timer#schedule(TimerTask, long, long)}.
* @param <T> The type of objects in the pool
* @param <E> type of exceptions from the pool
- * @return the {@link TimerTask} that will periodically check the pools
idle
+ * @return The {@link TimerTask} that will periodically check the pools
idle
* object count.
* @throws IllegalArgumentException
* when {@code pool} is {@code null} or when {@code minIdle} is
@@ -1658,7 +1658,7 @@ public final class PoolUtils {
/**
* Gets the {@code Timer} for checking keyedPool's idle count.
*
- * @return the {@link Timer} for checking keyedPool's idle count.
+ * @return The {@link Timer} for checking keyedPool's idle count.
*/
private static Timer getMinIdleTimer() {
return TimerHolder.MIN_IDLE_TIMER;
diff --git a/src/main/java/org/apache/commons/pool3/PooledObject.java
b/src/main/java/org/apache/commons/pool3/PooledObject.java
index 173f7b1d..762f27cd 100644
--- a/src/main/java/org/apache/commons/pool3/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool3/PooledObject.java
@@ -38,7 +38,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
*
* @param <T> The type of object in the pool.
* @param pooledObject the PooledObject to unwrap, may be null.
- * @return the wrapped object or null.
+ * @return The wrapped object or null.
* @since 2.13.0
*/
static <T> T getObject(final PooledObject<T> pooledObject) {
@@ -185,7 +185,7 @@ public interface PooledObject<T> extends
Comparable<PooledObject<T>> {
* {@link TrackedUse}, what is returned is the maximum of {@link
TrackedUse#getLastUsedInstant()} and
* {@link #getLastBorrowInstant()}; otherwise this method gives the same
value as {@link #getLastBorrowInstant()}.
*
- * @return the last time this object was used
+ * @return The last time this object was used
* @since 2.11.0
*/
Instant getLastUsedInstant();
diff --git a/src/main/java/org/apache/commons/pool3/TrackedUse.java
b/src/main/java/org/apache/commons/pool3/TrackedUse.java
index 5e70b047..435482d5 100644
--- a/src/main/java/org/apache/commons/pool3/TrackedUse.java
+++ b/src/main/java/org/apache/commons/pool3/TrackedUse.java
@@ -34,7 +34,7 @@ public interface TrackedUse {
* of microseconds, depending on the OS, Hardware, and JVM implementation.
* </p>
*
- * @return the last Instant this object was used.
+ * @return The last Instant this object was used.
* @since 2.11.0
*/
Instant getLastUsedInstant();
diff --git a/src/main/java/org/apache/commons/pool3/impl/AbandonedConfig.java
b/src/main/java/org/apache/commons/pool3/impl/AbandonedConfig.java
index 01a5ed9b..e5e92fc2 100644
--- a/src/main/java/org/apache/commons/pool3/impl/AbandonedConfig.java
+++ b/src/main/java/org/apache/commons/pool3/impl/AbandonedConfig.java
@@ -186,7 +186,7 @@ public class AbandonedConfig {
*
* <p>The default value is 300 seconds.</p>
*
- * @return the abandoned object timeout.
+ * @return The abandoned object timeout.
* @since 2.10.0
*/
public Duration getRemoveAbandonedTimeoutDuration() {
diff --git
a/src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java
b/src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java
index 1b4cf354..51039293 100644
--- a/src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/impl/BaseGenericObjectPool.java
@@ -89,7 +89,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
/**
* Gets the idle object deque referenced by this iterator.
*
- * @return the idle object deque
+ * @return The idle object deque
*/
public Deque<PooledObject<T>> getIdleObjects() {
return idleObjects;
@@ -239,7 +239,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
}
/**
- * @return the wrapped object
+ * @return The wrapped object
*/
public T getObject() {
return instance;
@@ -303,7 +303,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
/**
* Gets the mean of the cached values.
*
- * @return the mean of the cache, truncated to long
+ * @return The mean of the cache, truncated to long
*/
public long getMean() {
double result = 0;
@@ -321,7 +321,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
/**
* Gets the mean Duration of the cached values.
*
- * @return the mean Duration of the cache, truncated to long
milliseconds of a Duration.
+ * @return The mean Duration of the cache, truncated to long
milliseconds of a Duration.
*/
Duration getMeanDuration() {
return Duration.ofMillis(getMean());
@@ -330,7 +330,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
/**
* Gets the current values as a List.
*
- * @return the current values as a List.
+ * @return The current values as a List.
*/
synchronized List<AtomicLong> getValues() {
return Arrays.stream(values, 0,
index).collect(Collectors.toList());
@@ -474,7 +474,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
* Casts the given throwable to {@code E}.
*
* @param throwable the throwable.
- * @return the input.
+ * @return The input.
* @since 2.12.0
*/
@SuppressWarnings("unchecked")
@@ -549,7 +549,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
* Gets the total number of objects successfully borrowed from this pool
over the
* lifetime of the pool.
*
- * @return the borrowed object count
+ * @return The borrowed object count
*/
public final long getBorrowedCount() {
return borrowedCount.get();
@@ -559,7 +559,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
* Gets the total number of objects created for this pool over the
lifetime of
* the pool.
*
- * @return the created object count
+ * @return The created object count
*/
public final long getCreatedCount() {
return createdCount.get();
@@ -593,7 +593,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
* Gets the total number of objects destroyed by the evictor associated
with this
* pool over the lifetime of the pool.
*
- * @return the evictor destroyed object count
+ * @return The evictor destroyed object count
*/
public final long getDestroyedByEvictorCount() {
return destroyedByEvictorCount.get();
@@ -603,7 +603,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
* Gets the total number of objects destroyed by this pool over the
lifetime of
* the pool.
*
- * @return the destroyed object count
+ * @return The destroyed object count
*/
public final long getDestroyedCount() {
return destroyedCount.get();
@@ -625,7 +625,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
/**
* Gets the {@link EvictionPolicy} defined for this pool.
*
- * @return the eviction policy
+ * @return The eviction policy
* @since 2.4
* @since 2.6.0 Changed access from protected to public.
*/
@@ -673,7 +673,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
* platform MBean server or {@code null} if the pool has not been
* registered.
*
- * @return the JMX name
+ * @return The JMX name
*/
public final ObjectName getJmxName() {
return objectName;
@@ -724,7 +724,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
* negative, there is no limit to the number of objects that can be
* managed by the pool at one time.
*
- * @return the cap on the total number of object instances managed by the
+ * @return The cap on the total number of object instances managed by the
* pool.
*
* @see #setMaxTotal
@@ -740,7 +740,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
* {@link #getBlockWhenExhausted} is true. When less than 0, the
* {@code borrowObject()} method may block indefinitely.
*
- * @return the maximum number of milliseconds {@code borrowObject()}
+ * @return The maximum number of milliseconds {@code borrowObject()}
* will block.
*
* @see #setMaxWait
@@ -758,7 +758,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
* {@link #getBlockWhenExhausted} is true. When less than 0, the
* {@code borrowObject()} method may block indefinitely.
*
- * @return the maximum number of milliseconds {@code borrowObject()}
+ * @return The maximum number of milliseconds {@code borrowObject()}
* will block.
* @see #setMaxWait
* @see #setBlockWhenExhausted
@@ -992,7 +992,7 @@ public abstract class BaseGenericObjectPool<T, E extends
Exception> extends Base
* the pool. This excludes attempts to return the same object multiple
* times.
*
- * @return the returned object count
+ * @return The returned object count
*/
public final long getReturnedCount() {
return returnedCount.get();
diff --git
a/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java
b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java
index c332d24f..1b17abd1 100644
--- a/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java
+++ b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObject.java
@@ -178,7 +178,7 @@ public class DefaultPooledObject<T> implements
PooledObject<T> {
* {@link #getLastBorrowInstant()}; otherwise this method gives the same
* value as {@link #getLastBorrowInstant()}.
*
- * @return the last Instant this object was used.
+ * @return The last Instant this object was used.
*/
@Override
public Instant getLastUsedInstant() {
@@ -230,7 +230,7 @@ public class DefaultPooledObject<T> implements
PooledObject<T> {
/**
* Gets the current instant of the clock.
*
- * @return the current instant of the clock.
+ * @return The current instant of the clock.
*/
private Instant now() {
return systemClock.instant();
diff --git
a/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObjectInfo.java
b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObjectInfo.java
index f95646b7..008bb6ad 100644
--- a/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObjectInfo.java
+++ b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObjectInfo.java
@@ -107,7 +107,7 @@ public class DefaultPooledObjectInfo implements
DefaultPooledObjectInfoMBean {
* This can't be a traditional getter as that would expose the pooled
object via JMX.
* </p>
*
- * @return the pooled object for debugging, use at your own risk, changing
the state of this object may have unintended consequences for the pool.
+ * @return The pooled object for debugging, use at your own risk, changing
the state of this object may have unintended consequences for the pool.
* @since 2.14.0
*/
public PooledObject<?> pooledObject() {
diff --git a/src/main/java/org/apache/commons/pool3/impl/EvictionTimer.java
b/src/main/java/org/apache/commons/pool3/impl/EvictionTimer.java
index 7957c55e..61cfcc6e 100644
--- a/src/main/java/org/apache/commons/pool3/impl/EvictionTimer.java
+++ b/src/main/java/org/apache/commons/pool3/impl/EvictionTimer.java
@@ -177,7 +177,7 @@ final class EvictionTimer {
/**
* Gets the number of eviction tasks under management.
*
- * @return the number of eviction tasks under management.
+ * @return The number of eviction tasks under management.
*/
static synchronized int getNumTasks() {
return TASK_MAP.size();
@@ -186,7 +186,7 @@ final class EvictionTimer {
/**
* Gets the task map. Keys are weak references to tasks, values are
runners managed by executor.
*
- * @return the task map.
+ * @return The task map.
*/
static HashMap<WeakReference<BaseGenericObjectPool<?, ?>.Evictor>,
WeakRunner<BaseGenericObjectPool<?, ?>.Evictor>> getTaskMap() {
return TASK_MAP;
diff --git
a/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java
b/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java
index 781371b8..8cd71a69 100644
--- a/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java
@@ -1111,7 +1111,7 @@ public class GenericKeyedObjectPool<K, T, E extends
Exception> extends BaseGener
* Gets a reference to the factory used to create, destroy and validate
* the objects used by this pool.
*
- * @return the factory
+ * @return The factory
*/
public KeyedPooledObjectFactory<K, T, E> getFactory() {
return factory;
@@ -1139,7 +1139,7 @@ public class GenericKeyedObjectPool<K, T, E extends
Exception> extends BaseGener
* maxIdlePerKey for heavily loaded system will vary but the default is a
* good starting point.
*
- * @return the maximum number of "idle" instances that can be held in a
+ * @return The maximum number of "idle" instances that can be held in a
* given keyed sub-pool or a negative value if there is no limit
*
* @see #setMaxIdlePerKey
@@ -1154,7 +1154,7 @@ public class GenericKeyedObjectPool<K, T, E extends
Exception> extends BaseGener
* (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.
*
- * @return the limit on the number of active instances per key
+ * @return The limit on the number of active instances per key
* @see #setMaxTotalPerKey
*/
@Override
diff --git a/src/main/java/org/apache/commons/pool3/impl/GenericObjectPool.java
b/src/main/java/org/apache/commons/pool3/impl/GenericObjectPool.java
index fcfecd2b..43038fbe 100644
--- a/src/main/java/org/apache/commons/pool3/impl/GenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/impl/GenericObjectPool.java
@@ -793,7 +793,7 @@ public class GenericObjectPool<T, E extends Exception>
extends BaseGenericObject
* Gets a reference to the factory used to create, destroy and validate
* the objects used by this pool.
*
- * @return the factory
+ * @return The factory
*/
public PooledObjectFactory<T, E> getFactory() {
return factory;
@@ -830,7 +830,7 @@ public class GenericObjectPool<T, E extends Exception>
extends BaseGenericObject
* objects to rise above maxIdle. The best value for maxIdle for heavily
* loaded system will vary but the default is a good starting point.
*
- * @return the maximum number of "idle" instances that can be held in the
+ * @return The maximum number of "idle" instances that can be held in the
* pool or a negative value if there is no limit
*
* @see #setMaxIdle
diff --git
a/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java
b/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java
index 63c67996..60374963 100644
--- a/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java
+++ b/src/main/java/org/apache/commons/pool3/impl/LinkedBlockingDeque.java
@@ -542,7 +542,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* <p>This method is equivalent to {@link #getFirst() getFirst}.
*
- * @return the head of the queue represented by this deque
+ * @return The head of the queue represented by this deque
* @throws NoSuchElementException if this deque is empty
*/
@Override
@@ -883,7 +883,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* <p>This method is equivalent to {@link #pollFirst(long, TimeUnit)}.
*
* @param timeout length of time to wait
- * @return the unlinked element
+ * @return The unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
E poll(final Duration timeout) throws InterruptedException {
@@ -898,7 +898,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* @param timeout length of time to wait
* @param unit units that timeout is expressed in
- * @return the unlinked element
+ * @return The unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@Override
@@ -921,7 +921,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* to do so if the queue is empty.
*
* @param timeout length of time to wait
- * @return the unlinked element
+ * @return The unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
E pollFirst(final Duration timeout) throws InterruptedException {
@@ -947,7 +947,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* @param timeout length of time to wait
* @param unit units that timeout is expressed in
- * @return the unlinked element
+ * @return The unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@Override
@@ -970,7 +970,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
* to do so if the queue is empty.
*
* @param timeout length of time to wait
- * @return the unlinked element
+ * @return The unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
E pollLast(final Duration timeout) throws InterruptedException {
@@ -996,7 +996,7 @@ final class LinkedBlockingDeque<E> extends AbstractQueue<E>
*
* @param timeout length of time to wait
* @param unit units that timeout is expressed in
- * @return the unlinked element
+ * @return The unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@Override
@@ -1140,7 +1140,7 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
* This method is equivalent to {@link #removeFirst() removeFirst}.
* </p>
*
- * @return the head of the queue represented by this deque
+ * @return The head of the queue represented by this deque
* @throws NoSuchElementException if this deque is empty
*/
@Override
@@ -1275,7 +1275,7 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
/**
* Returns the number of elements in this deque.
*
- * @return the number of elements in this deque
+ * @return The number of elements in this deque
*/
@Override
public int size() {
@@ -1295,7 +1295,7 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
* This method is equivalent to {@link #takeFirst()}.
* </p>
*
- * @return the unlinked element
+ * @return The unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@Override
@@ -1307,7 +1307,7 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
* Unlinks the first element in the queue, waiting until there is an
element
* to unlink if the queue is empty.
*
- * @return the unlinked element
+ * @return The unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@Override
@@ -1328,7 +1328,7 @@ final class LinkedBlockingDeque<E> extends
AbstractQueue<E>
* Unlinks the last element in the queue, waiting until there is an element
* to unlink if the queue is empty.
*
- * @return the unlinked element
+ * @return The unlinked element
* @throws InterruptedException if the current thread is interrupted
*/
@Override
diff --git a/src/main/java/org/apache/commons/pool3/impl/PoolImplUtils.java
b/src/main/java/org/apache/commons/pool3/impl/PoolImplUtils.java
index 1abb5612..d10dc456 100644
--- a/src/main/java/org/apache/commons/pool3/impl/PoolImplUtils.java
+++ b/src/main/java/org/apache/commons/pool3/impl/PoolImplUtils.java
@@ -38,7 +38,7 @@ final class PoolImplUtils {
* Identifies the concrete type of object that an object factory creates.
*
* @param factoryClass The factory to examine
- * @return the type of object the factory creates
+ * @return The type of object the factory creates
*/
@SuppressWarnings("rawtypes")
static Class<?> getFactoryType(final Class<? extends PooledObjectFactory>
factoryClass) {
@@ -111,7 +111,7 @@ final class PoolImplUtils {
* @param type The interface that defines a generic type.
* @param clazz The class that implements the interface with a concrete
type.
* @param <T> The interface type.
- * @return the matching parameterized type or null.
+ * @return The matching parameterized type or null.
*/
private static <T> ParameterizedType getParameterizedType(final Class<T>
type, final Class<? extends T> clazz) {
for (final Type iface : clazz.getGenericInterfaces()) {
@@ -159,7 +159,7 @@ final class PoolImplUtils {
*
* @param a an argument.
* @param b another argument.
- * @return the larger of {@code a} and {@code b}.
+ * @return The larger of {@code a} and {@code b}.
*/
static Instant max(final Instant a, final Instant b) {
return a.compareTo(b) > 0 ? a : b;
@@ -171,7 +171,7 @@ final class PoolImplUtils {
*
* @param a an argument.
* @param b another argument.
- * @return the smaller of {@code a} and {@code b}.
+ * @return The smaller of {@code a} and {@code b}.
*/
static Instant min(final Instant a, final Instant b) {
return a.compareTo(b) < 0 ? a : b;
diff --git
a/src/main/java/org/apache/commons/pool3/impl/ResilientPooledObjectFactory.java
b/src/main/java/org/apache/commons/pool3/impl/ResilientPooledObjectFactory.java
index 0f1de832..a93d5da6 100644
---
a/src/main/java/org/apache/commons/pool3/impl/ResilientPooledObjectFactory.java
+++
b/src/main/java/org/apache/commons/pool3/impl/ResilientPooledObjectFactory.java
@@ -122,21 +122,21 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
}
/**
- * @return the time the makeObject call ended
+ * @return The time the makeObject call ended
*/
public Instant getEndTime() {
return endTime;
}
/**
- * @return the exception thrown by the makeObject call
+ * @return The exception thrown by the makeObject call
*/
public Throwable getException() {
return exception;
}
/**
- * @return the start time of the makeObject call
+ * @return The start time of the makeObject call
*/
public Instant getStartTime() {
return startTime;
@@ -198,7 +198,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets the default time between makeObject calls by the adder thread.
*
- * @return the default time between makeObject calls by the adder thread.
+ * @return The default time between makeObject calls by the adder thread.
*/
public static Duration getDefaultDelay() {
return DEFAULT_DELAY;
@@ -207,7 +207,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets the default makeObject log size.
*
- * @return the default makeObject log size.
+ * @return The default makeObject log size.
*/
public static int getDefaultLogSize() {
return DEFAULT_LOG_SIZE;
@@ -216,7 +216,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets the default look back duration.
*
- * @return the default look back duration.
+ * @return The default look back duration.
*/
public static Duration getDefaultLookBack() {
return DEFAULT_LOOK_BACK;
@@ -225,7 +225,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets the default time between monitor checks.
*
- * @return the default time between monitor checks.
+ * @return The default time between monitor checks.
*/
public static Duration getDefaultTimeBetweenChecks() {
return DEFAULT_TIME_BETWEEN_CHECKS;
@@ -260,7 +260,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
private boolean up = true;
/**
- * @return the factory wrapped by this resilient factory
+ * @return The factory wrapped by this resilient factory
*/
/** Whether or not the monitor thread is running */
@@ -320,7 +320,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets the time to wait between object creations by the adder thread.
*
- * @return the time to wait between object creations by the adder thread.
+ * @return The time to wait between object creations by the adder thread.
*/
public Duration getDelay() {
return delay;
@@ -329,7 +329,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets the start time of the last factory outage.
*
- * @return the start time of the last factory outage.
+ * @return The start time of the last factory outage.
*/
public Instant getDownStart() {
return downStart;
@@ -338,7 +338,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets the size of the makeObject log.
*
- * @return the size of the makeObject log.
+ * @return The size of the makeObject log.
*/
public int getLogSize() {
return logSize;
@@ -347,7 +347,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets the look back duration.
*
- * @return the look back duration.
+ * @return The look back duration.
*/
public Duration getLookBack() {
return lookBack;
@@ -366,7 +366,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets the duration between monitor checks.
*
- * @return the duration between monitor checks.
+ * @return The duration between monitor checks.
*/
public Duration getTimeBetweenChecks() {
return timeBetweenChecks;
@@ -375,7 +375,7 @@ public class ResilientPooledObjectFactory<T, E extends
Exception> implements Poo
/**
* Gets the time of the last factory outage recovery.
*
- * @return the time of the last factory outage recovery.
+ * @return The time of the last factory outage recovery.
*/
public Instant getUpStart() {
return upStart;
diff --git
a/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java
b/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java
index cc53e293..7dcfc940 100644
--- a/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java
+++ b/src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java
@@ -288,7 +288,7 @@ public class SoftReferenceObjectPool<T, E extends
Exception> extends BaseObjectP
* Gets the {@link PooledObjectFactory} used by this pool to create and
* manage object instances.
*
- * @return the factory
+ * @return The factory
*/
public synchronized PooledObjectFactory<T, E> getFactory() {
return factory;
@@ -297,7 +297,7 @@ public class SoftReferenceObjectPool<T, E extends
Exception> extends BaseObjectP
/**
* Gets the number of instances currently borrowed from this pool.
*
- * @return the number of instances currently borrowed from this pool
+ * @return The number of instances currently borrowed from this pool
*/
@Override
public synchronized int getNumActive() {
diff --git a/src/main/java/org/apache/commons/pool3/proxy/BaseProxyHandler.java
b/src/main/java/org/apache/commons/pool3/proxy/BaseProxyHandler.java
index 085caab1..b81e862e 100644
--- a/src/main/java/org/apache/commons/pool3/proxy/BaseProxyHandler.java
+++ b/src/main/java/org/apache/commons/pool3/proxy/BaseProxyHandler.java
@@ -55,7 +55,7 @@ class BaseProxyHandler<T> {
* the pool. Further use of the wrapper should result in an
* {@link IllegalStateException}.
*
- * @return the object that this proxy was wrapping
+ * @return The object that this proxy was wrapping
*/
T disableProxy() {
final T result = pooledObject;
@@ -90,7 +90,7 @@ class BaseProxyHandler<T> {
/**
* Gets the wrapped, pooled object.
*
- * @return the underlying pooled object
+ * @return The underlying pooled object
*/
T getPooledObject() {
return pooledObject;
diff --git a/src/main/java/org/apache/commons/pool3/proxy/ProxySource.java
b/src/main/java/org/apache/commons/pool3/proxy/ProxySource.java
index 02ba68b6..14f8ceb1 100644
--- a/src/main/java/org/apache/commons/pool3/proxy/ProxySource.java
+++ b/src/main/java/org/apache/commons/pool3/proxy/ProxySource.java
@@ -35,7 +35,7 @@ interface ProxySource<T> {
* be provided with usage tracking information for
this
* wrapped object
*
- * @return the new proxy object
+ * @return The new proxy object
*/
T createProxy(T pooledObject, UsageTracking<T> usageTracking);
diff --git
a/src/test/java/org/apache/commons/pool3/AbstractTestKeyedObjectPool.java
b/src/test/java/org/apache/commons/pool3/AbstractTestKeyedObjectPool.java
index 31410e50..de93c860 100644
--- a/src/test/java/org/apache/commons/pool3/AbstractTestKeyedObjectPool.java
+++ b/src/test/java/org/apache/commons/pool3/AbstractTestKeyedObjectPool.java
@@ -192,7 +192,7 @@ public abstract class AbstractTestKeyedObjectPool {
*
* @param key Key for the object to be obtained
* @param n index of the object to be obtained
- * @return the requested object
+ * @return The requested object
*/
protected abstract Object getNthObject(Object key, int n);
@@ -206,7 +206,7 @@ public abstract class AbstractTestKeyedObjectPool {
*
* @param <E> Type of exception thrown by this pool.
* @param minCapacity Minimum capacity of the pool to create
- * @return the newly created keyed object pool
+ * @return The newly created keyed object pool
*/
protected abstract <E extends Exception> KeyedObjectPool<Object, Object,
E> makeEmptyPool(int minCapacity);
diff --git a/src/test/java/org/apache/commons/pool3/AbstractTestObjectPool.java
b/src/test/java/org/apache/commons/pool3/AbstractTestObjectPool.java
index 2c19bab3..ef297375 100644
--- a/src/test/java/org/apache/commons/pool3/AbstractTestObjectPool.java
+++ b/src/test/java/org/apache/commons/pool3/AbstractTestObjectPool.java
@@ -63,7 +63,7 @@ public abstract class AbstractTestObjectPool {
*
* @param <E> The exception type throws by the pool
* @param factory The factory to be used by the object pool
- * @return the newly created empty pool
+ * @return The newly created empty pool
* @throws UnsupportedOperationException if the pool being tested does not
* follow pool contracts.
*/
diff --git a/src/test/java/org/apache/commons/pool3/TestBaseObjectPool.java
b/src/test/java/org/apache/commons/pool3/TestBaseObjectPool.java
index d3a1b0a5..0733e9c1 100644
--- a/src/test/java/org/apache/commons/pool3/TestBaseObjectPool.java
+++ b/src/test/java/org/apache/commons/pool3/TestBaseObjectPool.java
@@ -47,7 +47,7 @@ public class TestBaseObjectPool extends
AbstractTestObjectPool {
/**
* @param n Ignored by this implemented. Used by sub-classes.
- * @return the Nth object (zero indexed)
+ * @return The Nth object (zero indexed)
*/
protected Object getNthObject(final int n) {
if (this.getClass() != TestBaseObjectPool.class) {
diff --git a/src/test/java/org/apache/commons/pool3/WaiterFactory.java
b/src/test/java/org/apache/commons/pool3/WaiterFactory.java
index c6507cfe..c64d1bba 100644
--- a/src/test/java/org/apache/commons/pool3/WaiterFactory.java
+++ b/src/test/java/org/apache/commons/pool3/WaiterFactory.java
@@ -133,7 +133,7 @@ public class WaiterFactory<K> implements
PooledObjectFactory<Waiter, IllegalStat
}
/**
- * @return the maxActive
+ * @return The maxActive
*/
public synchronized long getMaxActive() {
return maxActive;
