Consistently use Javadoc descriptions for BoundedPoolConfig #1337

redis · Jul 9, 2020 · 485902e · 485902e
1 parent 2c7d0ba
commit 485902e
Showing 1 changed file with 5 additions and 4 deletions.
diff --git a/src/main/java/io/lettuce/core/support/BoundedPoolConfig.java b/src/main/java/io/lettuce/core/support/BoundedPoolConfig.java
@@ -153,7 +153,8 @@ public Builder testOnRelease(boolean testOnRelease) {
 
         /**
          * Configures the maximum number of objects that can be allocated by the pool (checked out to clients, or idle awaiting
-         * checkout) at a given time.
+         * checkout) at a given time. When negative, there is no limit to the number of objects that can be managed by
+         * the pool at one time.
          *
          * @param maxTotal maximum number of objects that can be allocated by the pool.
          * @return {@code this} {@link Builder}.
@@ -181,10 +182,10 @@ public Builder maxIdle(int maxIdle) {
         }
 
         /**
-         * Configures the maximum number of objects that can be allocated by the pool (checked out to clients, or idle awaiting
-         * checkout) at a given time.
+         * Configures the minimum number of idle objects to maintain in the pool. If this is the case, an attempt is
+         * made to ensure that the pool has the required minimum number of instances during idle object eviction runs.
          *
-         * @param minIdle maximum number of objects that can be allocated by the pool.
+         * @param minIdle minimum number of idle objects to maintain in the pool.
          * @return {@code this} {@link Builder}.
          */
         public Builder minIdle(int minIdle) {