Package org.forgerock.util.time

Class Duration

java.lang.Object
org.forgerock.util.time.Duration
All Implemented Interfaces:
Comparable<Duration>
@Deprecated(since="27.0.0", forRemoval=true) public class Duration extends Object implements Comparable<Duration>
Deprecated, for removal: This API element is subject to removal in a future version.
Use Duration instead.
Represents a duration in english. Cases is not important, plurals units are accepted. Notice that negative durations are not supported. 6 days 59 minutes and 1 millisecond 1 minute and 10 seconds 42 millis unlimited none zero

  • Field Summary

    Fields
    Modifier and Type
    Field
    Description
    static final Duration
    UNLIMITED
    Deprecated, for removal: This API element is subject to removal in a future version.
    Special duration that represents an unlimited duration (or indefinite).
    static final Duration
    ZERO
    Deprecated, for removal: This API element is subject to removal in a future version.
    Special duration that represents a zero-length duration.

  • Constructor Summary

    Constructors
    Constructor
    Description
    Duration(Long number, TimeUnit unit)
    Deprecated.
    Prefer the use of duration(long, TimeUnit).

  • Method Summary

    Modifier and Type
    Method
    Description
    int
    compareTo(Duration that)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    Duration
    convertTo(TimeUnit targetUnit)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Convert the current duration to a given TimeUnit.
    static Duration
    duration(long number, TimeUnit unit)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Provides a Duration, given a number and time unit.
    static Duration
    duration(String value)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Provides a Duration that represents the given duration expressed in english.
    boolean
    equals(Object other)
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    static Duration
    fromJavaDuration(Duration duration)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Creates a Duration instance from a Java Duration.
    TimeUnit
    getUnit()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the TimeUnit this duration is expressed in.
    long
    getValue()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns the number of TimeUnit this duration represents.
    int
    hashCode()
    Deprecated, for removal: This API element is subject to removal in a future version.
     
    boolean
    isUnlimited()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns true if this Duration represents an unlimited (or indefinite) duration.
    boolean
    isZero()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns true if this Duration represents a zero-length duration.
    long
    to(TimeUnit targetUnit)
    Deprecated, for removal: This API element is subject to removal in a future version.
    Convert the current duration to a number of given TimeUnit.
    Duration
    toJavaDuration()
    Deprecated, for removal: This API element is subject to removal in a future version.
    Returns this duration as a Java Duration.
    String
    toString()
    Deprecated, for removal: This API element is subject to removal in a future version.
     

    Methods inherited from class java.lang.Object

    clone, finalize, getClass, notify, notifyAll, wait, wait, wait

  • Field Details

    • UNLIMITED

      public static final Duration UNLIMITED
      Deprecated, for removal: This API element is subject to removal in a future version.
      Special duration that represents an unlimited duration (or indefinite).

    • ZERO

      public static final Duration ZERO
      Deprecated, for removal: This API element is subject to removal in a future version.
      Special duration that represents a zero-length duration.

  • Constructor Details

    • Duration

      @Deprecated public Duration(Long number, TimeUnit unit)
      Deprecated.
      Prefer the use of duration(long, TimeUnit).
      Builds a new Duration.
      Parameters:
      number - number of time unit (cannot be null).
      unit - TimeUnit to express the duration in (cannot be null).

  • Method Details

    • duration

      public static Duration duration(long number, TimeUnit unit)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Provides a Duration, given a number and time unit.
      Parameters:
      number - number of time unit.
      unit - TimeUnit to express the duration in (cannot be null).
      Returns:
      Duration instance

    • duration

      public static Duration duration(String value)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Provides a Duration that represents the given duration expressed in english.
      Parameters:
      value - natural speech duration
      Returns:
      Duration instance
      Throws:
      IllegalArgumentException - if the input string is incorrectly formatted.

    • getValue

      public long getValue()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the number of TimeUnit this duration represents.
      Returns:
      the number of TimeUnit this duration represents

    • toJavaDuration

      public Duration toJavaDuration()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns this duration as a Java Duration.
      Returns:
      a new equivalent Java Duration

    • fromJavaDuration

      public static Duration fromJavaDuration(Duration duration)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Creates a Duration instance from a Java Duration.
      Parameters:
      duration - the Java Duration to convert
      Returns:
      a new equivalent Duration

    • getUnit

      public TimeUnit getUnit()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns the TimeUnit this duration is expressed in.
      Returns:
      the TimeUnit this duration is expressed in.

    • convertTo

      public Duration convertTo(TimeUnit targetUnit)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Convert the current duration to a given TimeUnit. Conversions from finer to coarser granularities truncate, so loose precision.
      Parameters:
      targetUnit - target unit of the conversion.
      Returns:
      converted duration
      See Also:

    • to

      public long to(TimeUnit targetUnit)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Convert the current duration to a number of given TimeUnit. Conversions from finer to coarser granularities truncate, so loose precision.
      Parameters:
      targetUnit - target unit of the conversion.
      Returns:
      converted duration value
      See Also:

    • isUnlimited

      public boolean isUnlimited()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns true if this Duration represents an unlimited (or indefinite) duration.
      Returns:
      true if this Duration represents an unlimited duration.

    • isZero

      public boolean isZero()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Returns true if this Duration represents a zero-length duration.
      Returns:
      true if this Duration represents a zero-length duration

    • toString

      public String toString()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      toString in class Object

    • compareTo

      public int compareTo(Duration that)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Specified by:
      compareTo in interface Comparable<Duration>

    • equals

      public boolean equals(Object other)
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      equals in class Object

    • hashCode

      public int hashCode()
      Deprecated, for removal: This API element is subject to removal in a future version.
      Overrides:
      hashCode in class Object