[commons-pool] branch master updated: Add and use Duration APIs in PooledObject: getActiveDuration().

[gg...@apache.org]

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 5eef5be  Add and use Duration APIs in PooledObject: getActiveDuration().
5eef5be is described below

commit 5eef5be1493238d9bc9bb49b04e6b6d291c629c7
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Sun Aug 8 11:42:24 2021 -0400

    Add and use Duration APIs in PooledObject: getActiveDuration().
---
 src/changes/changes.xml                                 |  2 +-
 .../java/org/apache/commons/pool2/PooledObject.java     | 17 +++++++++++++++--
 .../apache/commons/pool2/impl/DefaultPooledObject.java  |  2 +-
 .../commons/pool2/impl/GenericKeyedObjectPool.java      |  2 +-
 .../apache/commons/pool2/impl/GenericObjectPool.java    |  2 +-
 5 files changed, 19 insertions(+), 6 deletions(-)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 9dedc4b..d2e5f37 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -87,7 +87,7 @@ The <action> type attribute can be add,update,fix,remove.
       - Add and use Duration APIs in BaseGenericObjectPool: getDurationBetweenEvictionRuns(), getEvictorShutdownTimeoutDuration(), getMinEvictableIdleDuration(), getSoftMinEvictableIdleDuration(), setMaxWait(Duration), setMinEvictableIdle(Duration), setSoftMinEvictableIdle(Duration).
       - Add and use Duration APIs in BaseObjectPoolConfig: getDurationBetweenEvictionRuns(), getEvictorShutdownTimeoutDuration(),getMinEvictableIdleDuration(), getSoftMinEvictableIdleDuration().
       - Add and use Duration APIs in EvictionConfig: getIdleEvictDuration(), getIdleSoftEvictDuration().
-      - Add and use Duration APIs in PooledObject: getIdleDuration().
+      - Add and use Duration APIs in PooledObject: getIdleDuration(), getActiveDuration().
       - No need to initialize instance variables to their default values.
       - Update Javadocs.
       - Update toString() implementations with duration labels.
diff --git a/src/main/java/org/apache/commons/pool2/PooledObject.java b/src/main/java/org/apache/commons/pool2/PooledObject.java
index 1e8ce4f..608f990 100644
--- a/src/main/java/org/apache/commons/pool2/PooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/PooledObject.java
@@ -81,9 +81,9 @@ public interface PooledObject<T> extends Comparable<PooledObject<T>> {
      * subsequent calls will return an increased value).
      *
      * @return The duration last spent in the active state.
-     * @since 2.10.0
+     * @since 2.11.0
      */
-    default Duration getActiveTime() {
+    default Duration getActiveDuration() {
         final Instant lastReturnInstant = getLastReturnInstant();
         final Instant lastBorrowInstant = getLastBorrowInstant();
         // @formatter:off
@@ -94,6 +94,19 @@ public interface PooledObject<T> extends Comparable<PooledObject<T>> {
     }
 
     /**
+     * Gets the amount of time this object last spent in the active state (it may still be active in which case
+     * subsequent calls will return an increased value).
+     *
+     * @return The duration last spent in the active state.
+     * @since 2.10.0
+     * @deprecated Use {@link #getActiveDuration()}.
+     */
+    @Deprecated
+    default Duration getActiveTime() {
+        return getActiveDuration();
+    }
+
+    /**
      * Gets the amount of time in milliseconds this object last spent in the
      * active state (it may still be active in which case subsequent calls will
      * return an increased value).
diff --git a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
index d6ef972..a9818ba 100644
--- a/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
+++ b/src/main/java/org/apache/commons/pool2/impl/DefaultPooledObject.java
@@ -139,7 +139,7 @@ public class DefaultPooledObject<T> implements PooledObject<T> {
 
     @Override
     public long getActiveTimeMillis() {
-        return getActiveTime().toMillis();
+        return getActiveDuration().toMillis();
     }
 
     /**
diff --git a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
index 4d42aaa..fd1934b 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericKeyedObjectPool.java
@@ -1467,7 +1467,7 @@ public class GenericKeyedObjectPool<K, T> extends BaseGenericObjectPool<T>
 
         markReturningState(p);
 
-        final Duration activeTime = p.getActiveTime();
+        final Duration activeTime = p.getActiveDuration();
 
         try {
             if (getTestOnReturn() && !factory.validateObject(key, p)) {
diff --git a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
index 3014508..e778101 100644
--- a/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
+++ b/src/main/java/org/apache/commons/pool2/impl/GenericObjectPool.java
@@ -1024,7 +1024,7 @@ public class GenericObjectPool<T> extends BaseGenericObjectPool<T>
 
         markReturningState(p);
 
-        final Duration activeTime = p.getActiveTime();
+        final Duration activeTime = p.getActiveDuration();
 
         if (getTestOnReturn() && !factory.validateObject(p)) {
             try {