This is an automated email from the ASF dual-hosted git repository.
ggregory pushed a commit to branch master
in repository https://gitbox.apache.org/repos/asf/commons-pool.git
The following commit(s) were added to refs/heads/master by this push:
new f012187f Javadoc
f012187f is described below
commit f012187f2bf487ac76d7ba90a78b92bdcc5e78e3
Author: Gary Gregory <garydgreg...@gmail.com>
AuthorDate: Tue Jul 18 08:24:21 2023 -0400
Javadoc
---
.../pool3/impl/DefaultPooledObjectInfoMBean.java | 48 +++++++++-------------
1 file changed, 19 insertions(+), 29 deletions(-)
diff --git
a/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObjectInfoMBean.java
b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObjectInfoMBean.java
index 1a1813f6..6e97d9db 100644
---
a/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObjectInfoMBean.java
+++
b/src/main/java/org/apache/commons/pool3/impl/DefaultPooledObjectInfoMBean.java
@@ -17,15 +17,12 @@
package org.apache.commons.pool3.impl;
/**
- * The interface that defines the information about pooled objects that will be
- * exposed via JMX.
+ * The interface that defines the information about pooled objects that will
be exposed via JMX.
+ * <h2>Note</h2>
* <p>
- * 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.
+ * 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>
*
* @since 2.0
@@ -34,72 +31,65 @@ public interface DefaultPooledObjectInfoMBean {
/**
* Gets the number of times this object has been borrowed.
+ *
* @return The number of times this object has been borrowed.
* @since 2.1
*/
long getBorrowedCount();
/**
- * Gets the time (using the same basis as
- * {@link java.time.Clock#instant()}) that pooled object was created.
+ * Gets the time (using the same basis as {@link
java.time.Clock#instant()}) that pooled object was created.
*
- * @return The creation time for the pooled object
+ * @return The creation time for the pooled object.
*/
long getCreateTime();
/**
* Gets the time that pooled object was created.
*
- * @return The creation time for the pooled object formatted as
- * {@code yyyy-MM-dd HH:mm:ss Z}
+ * @return The creation time for the pooled object formatted as {@code
yyyy-MM-dd HH:mm:ss Z}.
*/
String getCreateTimeFormatted();
/**
- * Gets the time (using the same basis as
- * {@link java.time.Clock#instant()}) the polled object was last borrowed.
+ * Gets the time (using the same basis as {@link
java.time.Clock#instant()}) the polled object was last borrowed.
*
- * @return The time the pooled object was last borrowed
+ * @return The time the pooled object was last borrowed.
*/
long getLastBorrowTime();
/**
* Gets the time that pooled object was last borrowed.
*
- * @return The last borrowed time for the pooled object formatted as
- * {@code yyyy-MM-dd HH:mm:ss Z}
+ * @return The last borrowed time for the pooled object formatted as
{@code yyyy-MM-dd HH:mm:ss Z}.
*/
String getLastBorrowTimeFormatted();
/**
* Gets the stack trace recorded when the pooled object was last borrowed.
*
- * @return The stack trace showing which code last borrowed the pooled
- * object
+ * @return The stack trace showing which code last borrowed the pooled
object.
*/
String getLastBorrowTrace();
/**
- * Gets the time (using the same basis as
- * {@link java.time.Clock#instant()})the wrapped object was last returned.
+ * Gets the time (using the same basis as {@link
java.time.Clock#instant()})the wrapped object was last returned.
*
- * @return The time the object was last returned
+ * @return The time the object was last returned.
*/
long getLastReturnTime();
/**
* Gets the time that pooled object was last returned.
*
- * @return The last returned time for the pooled object formatted as
- * {@code yyyy-MM-dd HH:mm:ss Z}
+ * @return The last returned time for the pooled object formatted as
{@code yyyy-MM-dd HH:mm:ss Z}.
*/
String getLastReturnTimeFormatted();
/**
- * Gets a String form of the wrapper for debug purposes. The format is
- * not fixed and may change at any time.
+ * Gets a String form of the wrapper for debug purposes. The format is not
fixed and may change at any time.
*
- * @return A string representation of the pooled object
+ * @return A string representation of the pooled object.
*
* @see Object#toString()
*/
@@ -108,7 +98,7 @@ public interface DefaultPooledObjectInfoMBean {
/**
* Gets the name of the class of the pooled object.
*
- * @return The pooled object's class name
+ * @return The pooled object's class name.
*
* @see Class#getName()
*/
