This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch POOL_2_X
in repository https://gitbox.apache.org/repos/asf/commons-pool.git
The following commit(s) were added to refs/heads/POOL_2_X by this push:
new 6aab63a9 Javadoc
6aab63a9 is described below
commit 6aab63a9ba06753f0c041b40b0937bfd6e1b785c
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Jul 18 08:28:18 2023 -0400
Javadoc
---
.../pool2/impl/GenericKeyedObjectPoolMXBean.java | 206 ++++++++++++---------
1 file changed, 120 insertions(+), 86 deletions(-)
diff --git
a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.java
b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.java
index 884a42ba..13a77ca8 100644
---
a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.java
+++
b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPoolMXBean.java
@@ -21,79 +21,85 @@ import java.util.Map;
/**
* Defines the methods that will be made available via JMX.
- *
- * NOTE: This interface exists only to define those attributes and methods that
- * will be made available via JMX. It must not be implemented by clients
- * as it is subject to change between major, minor and patch version
- * releases of commons pool. Clients that implement this interface may
- * not, therefore, be able to upgrade to a new minor or patch release
- * without requiring code changes.
+ * <h2>Note</h2>
+ * <p>
+ * This interface exists only to define those attributes and methods that will
be made available via JMX. It must not be implemented by clients as it is
subject
+ * to change between major, minor and patch version releases of commons pool.
Clients that implement this interface may not, therefore, be able to upgrade to
a
+ * new minor or patch release without requiring code changes.
+ * </p>
*
* @param <K> The type of keys maintained by the pool.
- *
* @since 2.0
*/
public interface GenericKeyedObjectPoolMXBean<K> {
- // Expose getters for configuration settings
-
/**
- * See {@link GenericKeyedObjectPool#getBlockWhenExhausted()}
- * @return See {@link GenericKeyedObjectPool#getBlockWhenExhausted()}
+ * See {@link GenericKeyedObjectPool#getBlockWhenExhausted()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getBlockWhenExhausted()}.
*/
boolean getBlockWhenExhausted();
/**
- * See {@link GenericKeyedObjectPool#getBorrowedCount()}
- * @return See {@link GenericKeyedObjectPool#getBorrowedCount()}
+ * See {@link GenericKeyedObjectPool#getBorrowedCount()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getBorrowedCount()}.
*/
long getBorrowedCount();
/**
- * See {@link GenericKeyedObjectPool#getCreatedCount()}
- * @return See {@link GenericKeyedObjectPool#getCreatedCount()}
+ * See {@link GenericKeyedObjectPool#getCreatedCount()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getCreatedCount()}.
*/
long getCreatedCount();
/**
- * See {@link GenericKeyedObjectPool#getCreationStackTrace()}
- * @return See {@link GenericKeyedObjectPool#getCreationStackTrace()}
+ * See {@link GenericKeyedObjectPool#getCreationStackTrace()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getCreationStackTrace()}.
*/
String getCreationStackTrace();
/**
- * See {@link GenericKeyedObjectPool#getDestroyedByBorrowValidationCount()}
- * @return See {@link
GenericKeyedObjectPool#getDestroyedByBorrowValidationCount()}
+ * See {@link
GenericKeyedObjectPool#getDestroyedByBorrowValidationCount()}.
+ *
+ * @return See {@link
GenericKeyedObjectPool#getDestroyedByBorrowValidationCount()}.
*/
long getDestroyedByBorrowValidationCount();
/**
- * See {@link GenericKeyedObjectPool#getDestroyedByEvictorCount()}
- * @return See {@link GenericKeyedObjectPool#getDestroyedByEvictorCount()}
+ * See {@link GenericKeyedObjectPool#getDestroyedByEvictorCount()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getDestroyedByEvictorCount()}.
*/
long getDestroyedByEvictorCount();
/**
- * See {@link GenericKeyedObjectPool#getDestroyedCount()}
- * @return See {@link GenericKeyedObjectPool#getDestroyedCount()}
+ * See {@link GenericKeyedObjectPool#getDestroyedCount()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getDestroyedCount()}.
*/
long getDestroyedCount();
/**
- * See {@link GenericKeyedObjectPool#getFairness()}
- * @return See {@link GenericKeyedObjectPool#getFairness()}
+ * See {@link GenericKeyedObjectPool#getFairness()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getFairness()}.
*/
boolean getFairness();
/**
- * See {@link GenericKeyedObjectPool#getLifo()}
- * @return See {@link GenericKeyedObjectPool#getLifo()}
+ * See {@link GenericKeyedObjectPool#getLifo()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getLifo()}.
*/
boolean getLifo();
/**
- * See {@link GenericKeyedObjectPool#getLogAbandoned()}
- * @return See {@link GenericKeyedObjectPool#getLogAbandoned()}
+ * See {@link GenericKeyedObjectPool#getLogAbandoned()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getLogAbandoned()}.
* @since 2.10.0
*/
default boolean getLogAbandoned() {
@@ -101,106 +107,123 @@ public interface GenericKeyedObjectPoolMXBean<K> {
}
/**
- * See {@link GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis()}
- * @return See {@link GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis()}
+ * See {@link GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis()}.
*/
long getMaxBorrowWaitTimeMillis();
/**
- * See {@link GenericKeyedObjectPool#getMaxIdlePerKey()}
- * @return See {@link GenericKeyedObjectPool#getMaxIdlePerKey()}
+ * See {@link GenericKeyedObjectPool#getMaxIdlePerKey()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getMaxIdlePerKey()}.
*/
int getMaxIdlePerKey();
/**
- * See {@link GenericKeyedObjectPool#getMaxTotal()}
- * @return See {@link GenericKeyedObjectPool#getMaxTotal()}
+ * See {@link GenericKeyedObjectPool#getMaxTotal()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getMaxTotal()}.
*/
int getMaxTotal();
/**
- * See {@link GenericKeyedObjectPool#getMaxTotalPerKey()}
- * @return See {@link GenericKeyedObjectPool#getMaxTotalPerKey()}
+ * See {@link GenericKeyedObjectPool#getMaxTotalPerKey()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getMaxTotalPerKey()}.
*/
int getMaxTotalPerKey();
/**
- * See {@link GenericKeyedObjectPool#getMaxWaitDuration()}
- * @return See {@link GenericKeyedObjectPool#getMaxWaitDuration()}
+ * See {@link GenericKeyedObjectPool#getMaxWaitDuration()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getMaxWaitDuration()}.
*/
long getMaxWaitMillis();
/**
- * See {@link GenericKeyedObjectPool#getMeanActiveTimeMillis()}
- * @return See {@link GenericKeyedObjectPool#getMeanActiveTimeMillis()}
+ * See {@link GenericKeyedObjectPool#getMeanActiveTimeMillis()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getMeanActiveTimeMillis()}.
*/
long getMeanActiveTimeMillis();
/**
- * See {@link GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis()}
- * @return See {@link GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis()}
+ * See {@link GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getMaxBorrowWaitTimeMillis()}.
*/
long getMeanBorrowWaitTimeMillis();
/**
- * See {@link GenericKeyedObjectPool#getMeanIdleTimeMillis()}
- * @return See {@link GenericKeyedObjectPool#getMeanIdleTimeMillis()}
+ * See {@link GenericKeyedObjectPool#getMeanIdleTimeMillis()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getMeanIdleTimeMillis()}.
*/
long getMeanIdleTimeMillis();
/**
- * See {@link GenericKeyedObjectPool#getMinEvictableIdleDuration()}
- * @return See {@link GenericKeyedObjectPool#getMinEvictableIdleDuration()}
+ * See {@link GenericKeyedObjectPool#getMinEvictableIdleDuration()}.
+ *
+ * @return See {@link
GenericKeyedObjectPool#getMinEvictableIdleDuration()}.
*/
long getMinEvictableIdleTimeMillis();
// Expose getters for monitoring attributes
/**
- * See {@link GenericKeyedObjectPool#getMinIdlePerKey()}
- * @return See {@link GenericKeyedObjectPool#getMinIdlePerKey()}
+ * See {@link GenericKeyedObjectPool#getMinIdlePerKey()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getMinIdlePerKey()}.
*/
int getMinIdlePerKey();
/**
- * See {@link GenericKeyedObjectPool#getNumActive()}
- * @return See {@link GenericKeyedObjectPool#getNumActive()}
+ * See {@link GenericKeyedObjectPool#getNumActive()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getNumActive()}.
*/
int getNumActive();
/**
- * See {@link GenericKeyedObjectPool#getNumActivePerKey()}
- * @return See {@link GenericKeyedObjectPool#getNumActivePerKey()}
+ * See {@link GenericKeyedObjectPool#getNumActivePerKey()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getNumActivePerKey()}.
*/
Map<String, Integer> getNumActivePerKey();
/**
- * See {@link GenericKeyedObjectPool#getNumIdle()}
- * @return See {@link GenericKeyedObjectPool#getNumIdle()}
+ * See {@link GenericKeyedObjectPool#getNumIdle()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getNumIdle()}.
*/
int getNumIdle();
/**
- * See {@link GenericKeyedObjectPool#getNumTestsPerEvictionRun()}
- * @return See {@link GenericKeyedObjectPool#getNumTestsPerEvictionRun()}
+ * See {@link GenericKeyedObjectPool#getNumTestsPerEvictionRun()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getNumTestsPerEvictionRun()}.
*/
int getNumTestsPerEvictionRun();
/**
- * See {@link GenericKeyedObjectPool#getNumWaiters()}
- * @return See {@link GenericKeyedObjectPool#getNumWaiters()}
+ * See {@link GenericKeyedObjectPool#getNumWaiters()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getNumWaiters()}.
*/
int getNumWaiters();
/**
- * See {@link GenericKeyedObjectPool#getNumWaitersByKey()}
- * @return See {@link GenericKeyedObjectPool#getNumWaitersByKey()}
+ * See {@link GenericKeyedObjectPool#getNumWaitersByKey()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getNumWaitersByKey()}.
*/
Map<String, Integer> getNumWaitersByKey();
/**
- * See {@link GenericKeyedObjectPool#getRemoveAbandonedOnBorrow()}
- * @return See {@link GenericKeyedObjectPool#getRemoveAbandonedOnBorrow()}
+ * See {@link GenericKeyedObjectPool#getRemoveAbandonedOnBorrow()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getRemoveAbandonedOnBorrow()}.
* @since 2.10.0
*/
default boolean getRemoveAbandonedOnBorrow() {
@@ -208,17 +231,19 @@ public interface GenericKeyedObjectPoolMXBean<K> {
}
/**
- * See {@link GenericKeyedObjectPool#getRemoveAbandonedOnMaintenance()}
- * @return See {@link
GenericKeyedObjectPool#getRemoveAbandonedOnMaintenance()}
+ * See {@link GenericKeyedObjectPool#getRemoveAbandonedOnMaintenance()}.
+ *
+ * @return See {@link
GenericKeyedObjectPool#getRemoveAbandonedOnMaintenance()}.
* @since 2.10.0
*/
- default boolean getRemoveAbandonedOnMaintenance() {
+ default boolean getRemoveAbandonedOnMaintenance() {
return false;
}
/**
- * See {@link GenericKeyedObjectPool#getRemoveAbandonedTimeoutDuration()}
- * @return See {@link
GenericKeyedObjectPool#getRemoveAbandonedTimeoutDuration()}
+ * See {@link GenericKeyedObjectPool#getRemoveAbandonedTimeoutDuration()}.
+ *
+ * @return See {@link
GenericKeyedObjectPool#getRemoveAbandonedTimeoutDuration()}.
* @since 2.10.0
*/
default int getRemoveAbandonedTimeout() {
@@ -226,45 +251,52 @@ public interface GenericKeyedObjectPoolMXBean<K> {
}
/**
- * See {@link GenericKeyedObjectPool#getReturnedCount()}
- * @return See {@link GenericKeyedObjectPool#getReturnedCount()}
+ * See {@link GenericKeyedObjectPool#getReturnedCount()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getReturnedCount()}.
*/
long getReturnedCount();
/**
- * See {@link GenericKeyedObjectPool#getTestOnBorrow()}
- * @return See {@link GenericKeyedObjectPool#getTestOnBorrow()}
+ * See {@link GenericKeyedObjectPool#getTestOnBorrow()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getTestOnBorrow()}.
*/
boolean getTestOnBorrow();
/**
- * See {@link GenericKeyedObjectPool#getTestOnCreate()}
- * @return See {@link GenericKeyedObjectPool#getTestOnCreate()}
+ * See {@link GenericKeyedObjectPool#getTestOnCreate()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getTestOnCreate()}.
* @since 2.2
*/
boolean getTestOnCreate();
/**
- * See {@link GenericKeyedObjectPool#getTestOnReturn()}
- * @return See {@link GenericKeyedObjectPool#getTestOnReturn()}
+ * See {@link GenericKeyedObjectPool#getTestOnReturn()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getTestOnReturn()}.
*/
boolean getTestOnReturn();
/**
- * See {@link GenericKeyedObjectPool#getTestWhileIdle()}
- * @return See {@link GenericKeyedObjectPool#getTestWhileIdle()}
+ * See {@link GenericKeyedObjectPool#getTestWhileIdle()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#getTestWhileIdle()}.
*/
boolean getTestWhileIdle();
/**
* See {@link GenericKeyedObjectPool#getDurationBetweenEvictionRuns}
- * @return See {@link
GenericKeyedObjectPool#getDurationBetweenEvictionRuns()}
+ *
+ * @return See {@link
GenericKeyedObjectPool#getDurationBetweenEvictionRuns()}.
*/
long getTimeBetweenEvictionRunsMillis();
/**
- * See {@link GenericKeyedObjectPool#isAbandonedConfig()}
- * @return See {@link GenericKeyedObjectPool#isAbandonedConfig()}
+ * See {@link GenericKeyedObjectPool#isAbandonedConfig()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#isAbandonedConfig()}.
* @since 2.10.0
*/
default boolean isAbandonedConfig() {
@@ -272,14 +304,16 @@ public interface GenericKeyedObjectPoolMXBean<K> {
}
/**
- * See {@link GenericKeyedObjectPool#isClosed()}
- * @return See {@link GenericKeyedObjectPool#isClosed()}
+ * See {@link GenericKeyedObjectPool#isClosed()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#isClosed()}.
*/
boolean isClosed();
/**
- * See {@link GenericKeyedObjectPool#listAllObjects()}
- * @return See {@link GenericKeyedObjectPool#listAllObjects()}
+ * See {@link GenericKeyedObjectPool#listAllObjects()}.
+ *
+ * @return See {@link GenericKeyedObjectPool#listAllObjects()}.
*/
Map<String, List<DefaultPooledObjectInfo>> listAllObjects();
}
