Type to the interface where we can

- Reduce visibility of some private class' methods
- Javadoc

Author: garydgregory

src/main/java/org/apache/commons/pool3/impl/GenericKeyedObjectPool.java

@@ -28,6 +28,7 @@
 import java.util.NoSuchElementException;
 import java.util.Objects;
 import java.util.TreeMap;
+import java.util.concurrent.BlockingDeque;
 import java.util.concurrent.ConcurrentHashMap;
 import java.util.concurrent.TimeUnit;
 import java.util.concurrent.atomic.AtomicBoolean;
@@ -136,37 +137,37 @@ private static final class ObjectDeque<S> {
         /**
          * Gets all the objects for the current key.
          *
-         * @return All the objects
+         * @return All the objects.
          */
-        public Map<IdentityWrapper<S>, PooledObject<S>> getAllObjects() {
+        Map<IdentityWrapper<S>, PooledObject<S>> getAllObjects() {
             return allObjects;
         }
 
         /**
          * Gets the number of instances created - number destroyed.
          * Should always be less than or equal to maxTotalPerKey.
          *
-         * @return The net instance addition count for this deque
+         * @return The net instance addition count for this deque.
          */
-        public AtomicInteger getCreateCount() {
+        AtomicInteger getCreateCount() {
             return createCount;
         }
 
         /**
          * Gets the idle objects for the current key.
          *
-         * @return The idle objects
+         * @return The idle objects.
          */
-        public LinkedBlockingDeque<PooledObject<S>> getIdleObjects() {
+        LinkedBlockingDeque<PooledObject<S>> getIdleObjects() {
             return idleObjects;
         }
 
         /**
          * Gets the number of threads with an interest registered in this key.
          *
-         * @return The number of threads with a registered interest in this key
+         * @return The number of threads with a registered interest in this key.
          */
-        public AtomicLong getNumInterested() {
+        AtomicLong getNumInterested() {
             return numInterested;
         }
 
@@ -306,7 +307,7 @@ public GenericKeyedObjectPool(final KeyedPooledObjectFactory<K, T, E> factory,
     private void addIdleObject(final K key, final PooledObject<T> p) throws E {
         if (PooledObject.nonNull(p)) {
             factory.passivateObject(key, p);
-            final LinkedBlockingDeque<PooledObject<T>> idleObjects = poolMap.get(key).getIdleObjects();
+            final BlockingDeque<PooledObject<T>> idleObjects = poolMap.get(key).getIdleObjects();
             if (getLifo()) {
                 idleObjects.addFirst(p);
             } else {
@@ -617,7 +618,7 @@ public void clear(final K key, final boolean reuseCapacity) {
         final ObjectDeque<T> objectDeque = register(key);
         int freedCapacity = 0;
         try {
-            final LinkedBlockingDeque<PooledObject<T>> idleObjects = objectDeque.getIdleObjects();
+            final BlockingDeque<PooledObject<T>> idleObjects = objectDeque.getIdleObjects();
             PooledObject<T> p = idleObjects.poll();
             while (p != null) {
                 try {
@@ -1505,7 +1506,7 @@ public void returnObject(final K key, final T obj) {
             }
 
             final int maxIdle = getMaxIdlePerKey();
-            final LinkedBlockingDeque<PooledObject<T>> idleObjects = objectDeque.getIdleObjects();
+            final BlockingDeque<PooledObject<T>> idleObjects = objectDeque.getIdleObjects();
 
             if (isClosed() || maxIdle > -1 && maxIdle <= idleObjects.size()) {
                 try {
@@ -1550,9 +1551,8 @@ public void returnObject(final K key, final T obj) {
     private void reuseCapacity() {
         final int maxTotalPerKeySave = getMaxTotalPerKey();
         int maxQueueLength = 0;
-        LinkedBlockingDeque<PooledObject<T>> mostLoadedPool = null;
+        BlockingDeque<PooledObject<T>> mostLoadedPool = null;
         K mostLoadedKey = null;
-
         // Find the most loaded pool that could take a new instance
         for (final Map.Entry<K, ObjectDeque<T>> entry : poolMap.entrySet()) {
             final K k = entry.getKey();
@@ -1564,7 +1564,6 @@ private void reuseCapacity() {
                 mostLoadedKey = k;
             }
         }
-
         // Attempt to add an instance to the most loaded pool.
         if (mostLoadedPool != null) {
             register(mostLoadedKey);

src/main/java/org/apache/commons/pool3/impl/InterruptibleReentrantLock.java

@@ -37,14 +37,14 @@ final class InterruptibleReentrantLock extends ReentrantLock {
      * Constructs a new InterruptibleReentrantLock with the given fairness policy.
      *
      * @param fairness true means threads should acquire contended locks as if
-     * waiting in a FIFO queue
+     * waiting in a FIFO queue.
      */
     InterruptibleReentrantLock(final boolean fairness) {
         super(fairness);
     }
 
     /**
-     * Interrupts the threads that are waiting on a specific condition
+     * Interrupts the threads that are waiting on a specific condition.
      *
      * @param condition the condition on which the threads are waiting.
      */

src/main/java/org/apache/commons/pool3/impl/SoftReferenceObjectPool.java

@@ -24,6 +24,7 @@
 import java.util.NoSuchElementException;
 import java.util.Objects;
 import java.util.Optional;
+import java.util.concurrent.BlockingDeque;
 
 import org.apache.commons.pool3.BaseObjectPool;
 import org.apache.commons.pool3.ObjectPool;
@@ -65,7 +66,7 @@ public class SoftReferenceObjectPool<T, E extends Exception> extends BaseObjectP
     private long createCount; // @GuardedBy("this")
 
     /** Idle references - waiting to be borrowed */
-    private final LinkedBlockingDeque<PooledSoftReference<T>> idleReferences = new LinkedBlockingDeque<>();
+    private final BlockingDeque<PooledSoftReference<T>> idleReferences = new LinkedBlockingDeque<>();
 
     /** All references - checked out or waiting to be borrowed. */
     private final ArrayList<PooledSoftReference<T>> allReferences = new ArrayList<>();