Class/Object

scala.concurrent.duration

Duration

Related Docs: object Duration | package duration

Permalink

sealed abstract class Duration extends Serializable with Ordered[Duration]

Utility for working with java.util.concurrent.TimeUnit durations.

This class is not meant as a general purpose representation of time, it is optimized for the needs of scala.concurrent.

Basic Usage

Examples:

import scala.concurrent.duration._

val duration = Duration(100, MILLISECONDS)
val duration = Duration(100, "millis")

duration.toNanos
duration < 1.second
duration <= Duration.Inf

Invoking inexpressible conversions (like calling toSeconds on an infinite duration) will throw an IllegalArgumentException.

Implicits are also provided for Int, Long and Double. Example usage:

import scala.concurrent.duration._

val duration = 100 millis

The DSL provided by the implicit conversions always allows construction of finite durations, even for infinite Double inputs; use Duration.Inf instead.

Extractors, parsing and arithmetic are also included:

val d = Duration("1.2 µs")
val Duration(length, unit) = 5 millis
val d2 = d * 2.5
val d3 = d2 + 1.millisecond

Handling of Time Units

Calculations performed on finite durations always retain the more precise unit of either operand, no matter whether a coarser unit would be able to exactly express the same duration. This means that Duration can be used as a lossless container for a (length, unit) pair if it is constructed using the corresponding methods and no arithmetic is performed on it; adding/subtracting durations should in that case be done with care.

Correspondence to Double Semantics

The semantics of arithmetic operations on Duration are two-fold:

The conversion between Duration and Double is done using Duration.toUnit (with unit NANOSECONDS) and Duration.fromNanos(Double)

Ordering

The default ordering is consistent with the ordering of Double numbers, which means that Undefined is considered greater than all other durations, including Duration.Inf.

Linear Supertypes
math.Ordered[Duration], Comparable[Duration], Serializable, java.io.Serializable, AnyRef, Any
Known Subclasses
FiniteDuration, Infinite
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. Duration
  2. Ordered
  3. Comparable
  4. Serializable
  5. Serializable
  6. AnyRef
  7. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Abstract Value Members

  1. abstract def *(factor: Double): Duration

    Permalink

    Return this duration multiplied by the scalar factor.

    Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.

    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  2. abstract def +(other: Duration): Duration

    Permalink

    Return the sum of that duration and this.

    Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.

    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  3. abstract def -(other: Duration): Duration

    Permalink

    Return the difference of that duration and this.

    Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.

    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  4. abstract def /(divisor: Duration): Double

    Permalink

    Return the quotient of this and that duration as floating-point number.

    Return the quotient of this and that duration as floating-point number. The semantics are determined by Double as if calculating the quotient of the nanosecond lengths of both factors.

  5. abstract def /(divisor: Double): Duration

    Permalink

    Return this duration divided by the scalar factor.

    Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.

    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  6. abstract def compare(that: Duration): Int

    Permalink

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Implement this method to determine how instances of A will be sorted.

    Returns x where:

    • x < 0 when this < that
    • x == 0 when this == that
    • x > 0 when this > that
    Definition Classes
    Ordered

  7. abstract def isFinite(): Boolean

    Permalink

    This method returns whether this duration is finite, which is not the same as !isInfinite for Double because this method also returns false for Duration.Undefined.

  8. abstract def length: Long

    Permalink

    Obtain the length of this Duration measured in the unit obtained by the unit method.

    Obtain the length of this Duration measured in the unit obtained by the unit method.

    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  9. abstract def toCoarsest: Duration

    Permalink

    Return duration which is equal to this duration but with a coarsest Unit, or self in case it is already the coarsest Unit

    Return duration which is equal to this duration but with a coarsest Unit, or self in case it is already the coarsest Unit

    Examples:

    Duration(60, MINUTES).toCoarsest // Duration(1, HOURS)
Duration(1000, MILLISECONDS).toCoarsest // Duration(1, SECONDS)
Duration(48, HOURS).toCoarsest // Duration(2, DAYS)
Duration(5, SECONDS).toCoarsest // Duration(5, SECONDS)

  10. abstract def toDays: Long

    Permalink

    Return the length of this duration measured in whole days, rounding towards zero.

    Return the length of this duration measured in whole days, rounding towards zero.

    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  11. abstract def toHours: Long

    Permalink

    Return the length of this duration measured in whole hours, rounding towards zero.

    Return the length of this duration measured in whole hours, rounding towards zero.

    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  12. abstract def toMicros: Long

    Permalink

    Return the length of this duration measured in whole microseconds, rounding towards zero.

    Return the length of this duration measured in whole microseconds, rounding towards zero.

    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  13. abstract def toMillis: Long

    Permalink

    Return the length of this duration measured in whole milliseconds, rounding towards zero.

    Return the length of this duration measured in whole milliseconds, rounding towards zero.

    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  14. abstract def toMinutes: Long

    Permalink

    Return the length of this duration measured in whole minutes, rounding towards zero.

    Return the length of this duration measured in whole minutes, rounding towards zero.

    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  15. abstract def toNanos: Long

    Permalink

    Return the length of this duration measured in whole nanoseconds, rounding towards zero.

    Return the length of this duration measured in whole nanoseconds, rounding towards zero.

    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  16. abstract def toSeconds: Long

    Permalink

    Return the length of this duration measured in whole seconds, rounding towards zero.

    Return the length of this duration measured in whole seconds, rounding towards zero.

    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

  17. abstract def toUnit(unit: TimeUnit): Double

    Permalink

    Return the number of nanoseconds as floating point number, scaled down to the given unit.

    Return the number of nanoseconds as floating point number, scaled down to the given unit. The result may not precisely represent this duration due to the Double datatype's inherent limitations (mantissa size effectively 53 bits). Non-finite durations are represented as

  18. abstract def unary_-: Duration

    Permalink

    Negate this duration.

    Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.

  19. abstract def unit: TimeUnit

    Permalink

    Obtain the time unit in which the length of this duration is measured.

    Obtain the time unit in which the length of this duration is measured.

    Exceptions thrown

    IllegalArgumentException when invoked on a non-finite duration

Concrete Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  3. def <(that: Duration): Boolean

    Permalink

    Returns true if this is less than that

    Returns true if this is less than that

    Definition Classes
    Ordered

  4. def <=(that: Duration): Boolean

    Permalink

    Returns true if this is less than or equal to that.

    Returns true if this is less than or equal to that.

    Definition Classes
    Ordered

  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  6. def >(that: Duration): Boolean

    Permalink

    Returns true if this is greater than that.

    Returns true if this is greater than that.

    Definition Classes
    Ordered

  7. def >=(that: Duration): Boolean

    Permalink

    Returns true if this is greater than or equal to that.

    Returns true if this is greater than or equal to that.

    Definition Classes
    Ordered

  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any

  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  10. def compareTo(that: Duration): Int

    Permalink

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Definition Classes
    Ordered → Comparable

  11. def div(other: Duration): Double

    Permalink

    Return the quotient of this and that duration as floating-point number.

    Return the quotient of this and that duration as floating-point number. The semantics are determined by Double as if calculating the quotient of the nanosecond lengths of both factors.

  12. def div(divisor: Double): Duration

    Permalink

    Return this duration divided by the scalar factor.

    Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.

    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  13. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  14. def equals(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any

  15. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )

  16. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any

  17. def gt(other: Duration): Boolean

    Permalink

  18. def gteq(other: Duration): Boolean

    Permalink

  19. def hashCode(): Int

    Permalink
    Definition Classes
    AnyRef → Any

  20. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any

  21. def lt(other: Duration): Boolean

    Permalink

  22. def lteq(other: Duration): Boolean

    Permalink

  23. def max(other: Duration): Duration

    Permalink

    Return the larger of this and that duration as determined by the natural ordering.

  24. def min(other: Duration): Duration

    Permalink

    Return the smaller of this and that duration as determined by the natural ordering.

  25. def minus(other: Duration): Duration

    Permalink

    Return the difference of that duration and this.

    Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.

    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  26. def mul(factor: Double): Duration

    Permalink

    Return this duration multiplied by the scalar factor.

    Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.

    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  27. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef

  28. def neg(): Duration

    Permalink

    Negate this duration.

    Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.

  29. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef

  30. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef

  31. def plus(other: Duration): Duration

    Permalink

    Return the sum of that duration and this.

    Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.

    Exceptions thrown

    IllegalArgumentException in case of a finite overflow: the range of a finite duration is +-(2^63-1)ns, and no conversion to infinite durations takes place.

  32. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef

  33. def toString(): String

    Permalink
    Definition Classes
    AnyRef → Any

  34. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  35. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

  36. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )

Inherited from math.Ordered[Duration]

Inherited from Comparable[Duration]

Inherited from Serializable

Inherited from java.io.Serializable

Inherited from AnyRef

Inherited from Any

Ungrouped