Javadoc: Use {@value} in constant descriptions

Author: garydgregory

src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java

@@ -33,23 +33,23 @@
 public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Cloneable {
 
     /**
-     * The default value for the {@code lifo} configuration attribute.
+     * The default value for the {@code lifo} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getLifo()
      * @see GenericKeyedObjectPool#getLifo()
      */
     public static final boolean DEFAULT_LIFO = true;
 
     /**
-     * The default value for the {@code fairness} configuration attribute.
+     * The default value for the {@code fairness} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getFairness()
      * @see GenericKeyedObjectPool#getFairness()
      */
     public static final boolean DEFAULT_FAIRNESS = false;
 
     /**
-     * The default value for the {@code maxWait} configuration attribute.
+     * The default value for the {@code maxWait} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getMaxWaitDuration()
      * @see GenericKeyedObjectPool#getMaxWaitDuration()
@@ -68,7 +68,7 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon
     public static final Duration DEFAULT_MAX_WAIT = Duration.ofMillis(DEFAULT_MAX_WAIT_MILLIS);
 
     /**
-     * The default value for the {@code minEvictableIdleDuration} configuration attribute.
+     * The default value for the {@code minEvictableIdleDuration} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getMinEvictableIdleDuration()
      * @see GenericKeyedObjectPool#getMinEvictableIdleDuration()
@@ -98,7 +98,7 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon
     public static final Duration DEFAULT_MIN_EVICTABLE_IDLE_TIME = Duration.ofMillis(DEFAULT_MIN_EVICTABLE_IDLE_TIME_MILLIS);
 
     /**
-     * The default value for the {@code softMinEvictableIdleTime} configuration attribute.
+     * The default value for the {@code softMinEvictableIdleTime} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getSoftMinEvictableIdleDuration()
      * @see GenericKeyedObjectPool#getSoftMinEvictableIdleDuration()
@@ -128,7 +128,7 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon
     public static final Duration DEFAULT_SOFT_MIN_EVICTABLE_IDLE_DURATION = Duration.ofMillis(DEFAULT_SOFT_MIN_EVICTABLE_IDLE_TIME_MILLIS);
 
     /**
-     * The default value for {@code evictorShutdownTimeout} configuration attribute.
+     * The default value for {@code evictorShutdownTimeout} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getEvictorShutdownTimeoutDuration()
      * @see GenericKeyedObjectPool#getEvictorShutdownTimeoutDuration()
@@ -147,15 +147,15 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon
     public static final Duration DEFAULT_EVICTOR_SHUTDOWN_TIMEOUT = Duration.ofMillis(DEFAULT_EVICTOR_SHUTDOWN_TIMEOUT_MILLIS);
 
     /**
-     * The default value for the {@code numTestsPerEvictionRun} configuration attribute.
+     * The default value for the {@code numTestsPerEvictionRun} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getNumTestsPerEvictionRun()
      * @see GenericKeyedObjectPool#getNumTestsPerEvictionRun()
      */
     public static final int DEFAULT_NUM_TESTS_PER_EVICTION_RUN = 3;
 
     /**
-     * The default value for the {@code testOnCreate} configuration attribute.
+     * The default value for the {@code testOnCreate} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getTestOnCreate()
      * @see GenericKeyedObjectPool#getTestOnCreate()
@@ -165,31 +165,31 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon
     public static final boolean DEFAULT_TEST_ON_CREATE = false;
 
     /**
-     * The default value for the {@code testOnBorrow} configuration attribute.
+     * The default value for the {@code testOnBorrow} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getTestOnBorrow()
      * @see GenericKeyedObjectPool#getTestOnBorrow()
      */
     public static final boolean DEFAULT_TEST_ON_BORROW = false;
 
     /**
-     * The default value for the {@code testOnReturn} configuration attribute.
+     * The default value for the {@code testOnReturn} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getTestOnReturn()
      * @see GenericKeyedObjectPool#getTestOnReturn()
      */
     public static final boolean DEFAULT_TEST_ON_RETURN = false;
 
     /**
-     * The default value for the {@code testWhileIdle} configuration attribute.
+     * The default value for the {@code testWhileIdle} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getTestWhileIdle()
      * @see GenericKeyedObjectPool#getTestWhileIdle()
      */
     public static final boolean DEFAULT_TEST_WHILE_IDLE = false;
 
     /**
-     * The default value for the {@code timeBetweenEvictionRuns} configuration attribute.
+     * The default value for the {@code timeBetweenEvictionRuns} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getDurationBetweenEvictionRuns()
      * @see GenericKeyedObjectPool#getDurationBetweenEvictionRuns()
@@ -218,20 +218,20 @@ public abstract class BaseObjectPoolConfig<T> extends BaseObject implements Clon
     public static final Duration DEFAULT_TIME_BETWEEN_EVICTION_RUNS = Duration.ofMillis(DEFAULT_TIME_BETWEEN_EVICTION_RUNS_MILLIS);
 
     /**
-     * The default value for the {@code blockWhenExhausted} configuration attribute.
+     * The default value for the {@code blockWhenExhausted} configuration attribute: {@value}.
      *
      * @see GenericObjectPool#getBlockWhenExhausted()
      * @see GenericKeyedObjectPool#getBlockWhenExhausted()
      */
     public static final boolean DEFAULT_BLOCK_WHEN_EXHAUSTED = true;
 
     /**
-     * The default value for enabling JMX for pools created with a configuration instance.
+     * The default value for enabling JMX for pools created with a configuration instance: {@value}.
      */
     public static final boolean DEFAULT_JMX_ENABLE = true;
 
     /**
-     * The default value for the prefix used to name JMX enabled pools created with a configuration instance.
+     * The default value for the prefix used to name JMX enabled pools created with a configuration instance: {@value}.
      *
      * @see GenericObjectPool#getJmxName()
      * @see GenericKeyedObjectPool#getJmxName()

src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.java

@@ -31,25 +31,29 @@
 public class GenericKeyedObjectPoolConfig<T> extends BaseObjectPoolConfig<T> {
 
     /**
-     * The default value for the {@code maxTotalPerKey} configuration attribute.
+     * The default value for the {@code maxTotalPerKey} configuration attribute: {@value}.
+     *
      * @see GenericKeyedObjectPool#getMaxTotalPerKey()
      */
     public static final int DEFAULT_MAX_TOTAL_PER_KEY = 8;
 
     /**
-     * The default value for the {@code maxTotal} configuration attribute.
+     * The default value for the {@code maxTotal} configuration attribute: {@value}.
+     *
      * @see GenericKeyedObjectPool#getMaxTotal()
      */
     public static final int DEFAULT_MAX_TOTAL = -1;
 
     /**
-     * The default value for the {@code minIdlePerKey} configuration attribute.
+     * The default value for the {@code minIdlePerKey} configuration attribute: {@value}.
+     *
      * @see GenericKeyedObjectPool#getMinIdlePerKey()
      */
     public static final int DEFAULT_MIN_IDLE_PER_KEY = 0;
 
     /**
-     * The default value for the {@code maxIdlePerKey} configuration attribute.
+     * The default value for the {@code maxIdlePerKey} configuration attribute: {@value}.
+     *
      * @see GenericKeyedObjectPool#getMaxIdlePerKey()
      */
     public static final int DEFAULT_MAX_IDLE_PER_KEY = 8;

src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolConfig.java

@@ -31,19 +31,22 @@
 public class GenericObjectPoolConfig<T> extends BaseObjectPoolConfig<T> {
 
     /**
-     * The default value for the {@code maxTotal} configuration attribute.
+     * The default value for the {@code maxTotal} configuration attribute: {@value}.
+     *
      * @see GenericObjectPool#getMaxTotal()
      */
     public static final int DEFAULT_MAX_TOTAL = 8;
 
     /**
-     * The default value for the {@code maxIdle} configuration attribute.
+     * The default value for the {@code maxIdle} configuration attribute: {@value}.
+     *
      * @see GenericObjectPool#getMaxIdle()
      */
     public static final int DEFAULT_MAX_IDLE = 8;
 
     /**
-     * The default value for the {@code minIdle} configuration attribute.
+     * The default value for the {@code minIdle} configuration attribute: {@value}.
+     *
      * @see GenericObjectPool#getMinIdle()
      */
     public static final int DEFAULT_MIN_IDLE = 0;