Skip to content

Commit

Permalink
Javadoc: Use {@value} in constant descriptions
Browse files Browse the repository at this point in the history
  • Loading branch information
@garydgregory
garydgregory committed Nov 4, 2024
1 parent 5bd618c commit 4d7dbfe
Show file tree
Hide file tree
Showing 3 changed files with 29 additions and 22 deletions.
30 changes: 15 additions & 15 deletions src/main/java/org/apache/commons/pool2/impl/BaseObjectPoolConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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()
Expand All @@ -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()
Expand Down Expand Up @@ -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()
Expand Down Expand Up @@ -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()
Expand All @@ -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()
Expand All @@ -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()
Expand Down Expand Up @@ -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()
Expand Down
12 changes: 8 additions & 4 deletions src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPoolConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down
9 changes: 6 additions & 3 deletions src/main/java/org/apache/commons/pool2/impl/GenericObjectPoolConfig.java
View file
Original file line number Diff line number Diff line change
Expand Up @@ -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;
Expand Down

0 comments on commit 4d7dbfe

Please sign in to comment.