Add DurationUtils.get(String, TemporalUnit, long)

- Add DurationUtils.getMillis(String, long)
- Add DurationUtils.getSeconds(String, long)

Author: garydgregory

src/changes/changes.xml

@@ -93,6 +93,9 @@ The <action> type attribute can be add,update,fix,remove.
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add DoubleRange.fit(double).</action>
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add IntegerRange.fit(int).</action>
     <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add LongRange.fit(long).</action>
+    <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add DurationUtils.get(String, TemporalUnit, long).</action>
+    <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add DurationUtils.getMillis(String, long).</action>
+    <action                   type="add" dev="ggregory" due-to="Gary Gregory">Add DurationUtils.getSeconds(String, long).</action>
     <!-- UPDATE -->
     <action type="update" dev="ggregory" due-to="Gary Gregory">[test] Bump org.apache.commons:commons-text from 1.13.1 to 1.14.0.</action>
     <action type="update" dev="ggregory" due-to="Gary Gregory">Bump org.apache.commons:commons-parent from 85 to 87.</action>

src/main/java/org/apache/commons/lang3/time/DurationUtils.java

@@ -21,11 +21,13 @@
 import java.time.Instant;
 import java.time.temporal.ChronoUnit;
 import java.time.temporal.Temporal;
+import java.time.temporal.TemporalUnit;
 import java.util.Objects;
 import java.util.concurrent.TimeUnit;
 
 import org.apache.commons.lang3.LongRange;
 import org.apache.commons.lang3.ObjectUtils;
+import org.apache.commons.lang3.StringUtils;
 import org.apache.commons.lang3.function.FailableBiConsumer;
 import org.apache.commons.lang3.function.FailableConsumer;
 import org.apache.commons.lang3.function.FailableRunnable;
@@ -60,6 +62,35 @@ public static <T extends Throwable> void accept(final FailableBiConsumer<Long, I
         }
     }
 
+    /**
+     * Gets a Duration of unit stored in the system property at the given key.
+     *
+     * @param key  The property name.
+     * @param unit The unit that the duration is measured in, not null.
+     * @param def  The default value in the given unit.
+     * @return a Duration of seconds.
+     * @since 3.19.0
+     */
+    public static Duration get(final String key, final TemporalUnit unit, final long def) {
+        return Duration.of(getLong(key, def), unit);
+    }
+
+    private static long getLong(final String key, final long def) {
+        return StringUtils.isEmpty(key) ? def : Long.getLong(key, def);
+    }
+
+    /**
+     * Gets a Duration of milliseconds stored in the system property at the given key.
+     *
+     * @param key The property name.
+     * @param def The default value in milliseconds.
+     * @return a Duration of milliseconds.
+     * @since 3.19.0
+     */
+    public static Duration getMillis(final String key, final long def) {
+        return Duration.ofMillis(getLong(key, def));
+    }
+
     /**
      * Gets the nanosecond part of a Duration converted to milliseconds.
      * <p>
@@ -97,6 +128,18 @@ public static int getNanosOfMilli(final Duration duration) {
         return zeroIfNull(duration).getNano() % 1_000_000;
     }
 
+    /**
+     * Gets a Duration of seconds stored in the system property at the given key.
+     *
+     * @param key The property name.
+     * @param def The default value in seconds.
+     * @return a Duration of seconds.
+     * @since 3.19.0
+     */
+    public static Duration getSeconds(final String key, final long def) {
+        return Duration.ofSeconds(getLong(key, def));
+    }
+
     /**
      * Tests whether the given Duration is positive (duration &gt; 0).
      *

src/test/java/org/apache/commons/lang3/time/DurationUtilsTest.java

@@ -26,17 +26,48 @@
 import java.io.IOException;
 import java.time.Duration;
 import java.time.Instant;
+import java.time.temporal.ChronoUnit;
 import java.util.concurrent.TimeUnit;
 
 import org.apache.commons.lang3.AbstractLangTest;
 import org.apache.commons.lang3.math.NumberUtils;
 import org.junit.jupiter.api.Test;
+import org.junitpioneer.jupiter.SetSystemProperty;
+import org.junitpioneer.jupiter.SetSystemProperty.SetSystemProperties;
 
 /**
  * Tests {@link DurationUtils}.
  */
 class DurationUtilsTest extends AbstractLangTest {
 
+    @Test
+    @SetSystemProperties({
+        @SetSystemProperty(key = "Seconds1", value = "1"),
+        @SetSystemProperty(key = "Seconds2", value = "9223372036854775807") }) // Long.MAX_VALUE
+    void testGet() {
+        // ChronoUnit.SECONDS
+        assertEquals(Duration.ofSeconds(0), DurationUtils.get(null, ChronoUnit.SECONDS, 0));
+        assertEquals(Duration.ofSeconds(0), DurationUtils.get("", ChronoUnit.SECONDS, 0));
+        assertEquals(Duration.ofSeconds(1), DurationUtils.get("Seconds1", ChronoUnit.SECONDS, 0));
+        assertEquals(Duration.ofSeconds(Long.MAX_VALUE), DurationUtils.get("Seconds2", ChronoUnit.SECONDS, 0));
+        // ChronoUnit.MILLIS
+        assertEquals(Duration.ofMillis(0), DurationUtils.get(null, ChronoUnit.MILLIS, 0));
+        assertEquals(Duration.ofMillis(0), DurationUtils.get("", ChronoUnit.MILLIS, 0));
+        assertEquals(Duration.ofMillis(1), DurationUtils.get("Seconds1", ChronoUnit.MILLIS, 0));
+        assertEquals(Duration.ofMillis(Long.MAX_VALUE), DurationUtils.get("Seconds2", ChronoUnit.MILLIS, 0));
+    }
+
+    @Test
+    @SetSystemProperties({
+        @SetSystemProperty(key = "Seconds1", value = "1"),
+        @SetSystemProperty(key = "Seconds2", value = "9223372036854775807") }) // Long.MAX_VALUE
+    void testGetMilliseconds() {
+        assertEquals(Duration.ofMillis(0), DurationUtils.getMillis(null, 0));
+        assertEquals(Duration.ofMillis(0), DurationUtils.getMillis("", 0));
+        assertEquals(Duration.ofMillis(1), DurationUtils.getMillis("Seconds1", 0));
+        assertEquals(Duration.ofMillis(Long.MAX_VALUE), DurationUtils.getMillis("Seconds2", 0));
+    }
+
     @Test
     void testGetNanosOfMiili() {
         assertEquals(0, DurationUtils.getNanosOfMiili(null));
@@ -65,6 +96,17 @@ void testGetNanosOfMilli() {
         assertEquals(1, DurationUtils.getNanosOfMilli(Duration.ofNanos(1_000_001)));
     }
 
+    @Test
+    @SetSystemProperties({
+        @SetSystemProperty(key = "Seconds1", value = "1"),
+        @SetSystemProperty(key = "Seconds2", value = "9223372036854775807") }) // Long.MAX_VALUE
+    void testGetSeconds() {
+        assertEquals(Duration.ofSeconds(0), DurationUtils.getSeconds(null, 0));
+        assertEquals(Duration.ofSeconds(0), DurationUtils.getSeconds("", 0));
+        assertEquals(Duration.ofSeconds(1), DurationUtils.getSeconds("Seconds1", 0));
+        assertEquals(Duration.ofSeconds(Long.MAX_VALUE), DurationUtils.getSeconds("Seconds2", 0));
+    }
+
     @Test
     void testIsPositive() {
         assertFalse(DurationUtils.isPositive(Duration.ZERO));