[commons-lang] branch master updated: Add DurationUtils.since(Temporal)

[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-lang.git


The following commit(s) were added to refs/heads/master by this push:
     new 6eb223bb8 Add DurationUtils.since(Temporal)
6eb223bb8 is described below

commit 6eb223bb8c68540e3f2bfa08c3d87b4cf7dfb544
Author: Gary Gregory <ga...@gmail.com>
AuthorDate: Fri May 27 10:21:53 2022 -0400

    Add DurationUtils.since(Temporal)
---
 src/changes/changes.xml                                      |  1 +
 .../java/org/apache/commons/lang3/time/DurationUtils.java    | 12 ++++++++++++
 .../org/apache/commons/lang3/time/DurationUtilsTest.java     |  8 ++++++++
 3 files changed, 21 insertions(+)

diff --git a/src/changes/changes.xml b/src/changes/changes.xml
index 21f08d191..313bc1d26 100644
--- a/src/changes/changes.xml
+++ b/src/changes/changes.xml
@@ -140,6 +140,7 @@ The <action> type attribute can be add,update,fix,remove.
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add Consumers.</action>
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add github/codeql-action.</action>
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add coverage.yml.</action>
+    <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add DurationUtils.since(Temporal).</action>
     <!-- UPDATE -->
     <action                   type="update" dev="ggregory" due-to="Dependabot, XenoAmess, Gary Gregory">Bump actions/cache from 2.1.4 to 3.0.2 #742, #752, #764, #833, #867.</action>
     <action                   type="update" dev="ggregory" due-to="Dependabot">Bump actions/checkout from 2 to 3 #819, #825, #859.</action>
diff --git a/src/main/java/org/apache/commons/lang3/time/DurationUtils.java b/src/main/java/org/apache/commons/lang3/time/DurationUtils.java
index 139f85a2b..becd89316 100644
--- a/src/main/java/org/apache/commons/lang3/time/DurationUtils.java
+++ b/src/main/java/org/apache/commons/lang3/time/DurationUtils.java
@@ -18,7 +18,9 @@
 package org.apache.commons.lang3.time;
 
 import java.time.Duration;
+import java.time.Instant;
 import java.time.temporal.ChronoUnit;
+import java.time.temporal.Temporal;
 import java.util.Objects;
 import java.util.concurrent.TimeUnit;
 
@@ -83,6 +85,16 @@ public class DurationUtils {
         return !duration.isNegative() && !duration.isZero();
     }
 
+    /**
+     * Computes the Duration between a start instant and now.
+     *
+     * @param startInclusive the start instant, inclusive, not null.
+     * @return a {@code Duration}, not null.
+     */
+    public static Duration since(final Temporal startInclusive) {
+        return Duration.between(startInclusive, Instant.now());
+    }
+
     /**
      * Converts a {@link TimeUnit} to a {@link ChronoUnit}.
      *
diff --git a/src/test/java/org/apache/commons/lang3/time/DurationUtilsTest.java b/src/test/java/org/apache/commons/lang3/time/DurationUtilsTest.java
index 3b9c55b55..514e71aed 100644
--- a/src/test/java/org/apache/commons/lang3/time/DurationUtilsTest.java
+++ b/src/test/java/org/apache/commons/lang3/time/DurationUtilsTest.java
@@ -22,6 +22,7 @@ import static org.junit.jupiter.api.Assertions.assertFalse;
 import static org.junit.jupiter.api.Assertions.assertTrue;
 
 import java.time.Duration;
+import java.time.Instant;
 import java.util.concurrent.TimeUnit;
 
 import org.apache.commons.lang3.math.NumberUtils;
@@ -71,6 +72,13 @@ public class DurationUtilsTest {
         assertEquals(Short.MAX_VALUE, DurationUtils.LONG_TO_INT_RANGE.fit((long) Short.MAX_VALUE));
     }
 
+    @Test
+    public void testSince() {
+        assertTrue(DurationUtils.since(Instant.EPOCH).compareTo(Duration.ZERO) >= 0);
+        assertTrue(DurationUtils.since(Instant.MIN).compareTo(Duration.ZERO) >= 0);
+        assertTrue(DurationUtils.since(Instant.MAX).compareTo(Duration.ZERO) <= 0);
+    }
+
     @Test
     public void testToDuration() {
         assertEquals(Duration.ofDays(1), DurationUtils.toDuration(1, TimeUnit.DAYS));