scala.concurrent.duration

FiniteDuration

final class FiniteDuration extends Duration

This class represents a finite duration. Its addition and subtraction operators are overloaded to retain this guarantee statically. The range of this class is limited to +-(2^63-1)ns, which is roughly 292 years.

Source
Duration.scala
Linear Supertypes
Duration, Ordered[Duration], Comparable[Duration], Serializable, Serializable, AnyRef, Any
Ordering
  1. Alphabetic
  2. By inheritance
Inherited
  1. Hide All
  2. Show all
  1. FiniteDuration
  2. Duration
  3. Ordered
  4. Comparable
  5. Serializable
  6. Serializable
  7. AnyRef
  8. Any
Visibility
  1. Public
  2. All

Instance Constructors

  1. new FiniteDuration(length: Long, unit: TimeUnit)

Value Members

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

    Definition Classes
    AnyRef
  2. final def !=(arg0: Any): Boolean

    Test two objects for inequality.

    Test two objects for inequality.

    returns

    true if !(this == that), false otherwise.

    Definition Classes
    Any
  3. final def ##(): Int

    Equivalent to x.hashCode except for boxed numeric types.

    Equivalent to x.hashCode except for boxed numeric types. For numerics, it returns a hash value which is consistent with value equality: if two value type instances compare as true, then ## will produce the same hash value for each of them.

    returns

    a hash value consistent with ==

    Definition Classes
    AnyRef → Any
  4. def *(factor: Long): FiniteDuration

    Return the product of this duration and the given integer factor.

    Return the product of this duration and the given integer factor.

    Exceptions thrown
    IllegalArgumentException

    if the result would overflow the range of FiniteDuration

  5. def *(factor: Double): Duration

    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.

    Definition Classes
    FiniteDurationDuration
    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. def +(other: FiniteDuration): FiniteDuration

  7. def +(other: Duration): Duration

    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.

    Definition Classes
    FiniteDurationDuration
    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.

  8. def -(other: FiniteDuration): FiniteDuration

  9. def -(other: Duration): Duration

    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.

    Definition Classes
    FiniteDurationDuration
    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.

  10. def /(divisor: Long): FiniteDuration

    Return the quotient of this duration and the given integer factor.

    Return the quotient of this duration and the given integer factor.

    Exceptions thrown
    ArithmeticException

    if the factor is 0

  11. def /(divisor: Duration): Double

    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.

    Definition Classes
    FiniteDurationDuration
  12. def /(divisor: Double): Duration

    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.

    Definition Classes
    FiniteDurationDuration
    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. def <(that: Duration): Boolean

    Returns true if this is less than that

    Returns true if this is less than that

    Definition Classes
    Ordered
  14. def <=(that: Duration): Boolean

    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
  15. final def ==(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  16. final def ==(arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    Any
  17. def >(that: Duration): Boolean

    Returns true if this is greater than that.

    Returns true if this is greater than that.

    Definition Classes
    Ordered
  18. def >=(that: Duration): Boolean

    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
  19. final def asInstanceOf[T0]: T0

    Cast the receiver object to be of type T0.

    Cast the receiver object to be of type T0.

    Note that the success of a cast at runtime is modulo Scala's erasure semantics. Therefore the expression 1.asInstanceOf[String] will throw a ClassCastException at runtime, while the expression List(1).asInstanceOf[List[String]] will not. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the requested type.

    returns

    the receiver object.

    Definition Classes
    Any
    Exceptions thrown
    ClassCastException

    if the receiver object is not an instance of the erasure of type T0.

  20. def clone(): AnyRef

    Create a copy of the receiver object.

    Create a copy of the receiver object.

    The default implementation of the clone method is platform dependent.

    returns

    a copy of the receiver object.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  21. def compare(other: Duration): Int

    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
    FiniteDurationOrdered
  22. def compareTo(that: Duration): Int

    Result of comparing this with operand that.

    Result of comparing this with operand that.

    Definition Classes
    Ordered → Comparable
  23. def div(divisor: Long): FiniteDuration

    Return the quotient of this duration and the given integer factor.

    Return the quotient of this duration and the given integer factor.

    Exceptions thrown
    ArithmeticException

    if the factor is 0

  24. def div(other: Duration): Double

    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.

    Definition Classes
    Duration
  25. def div(divisor: Double): Duration

    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.

    Definition Classes
    Duration
    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. final def eq(arg0: AnyRef): Boolean

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    Tests whether the argument (arg0) is a reference to the receiver object (this).

    The eq method implements an equivalence relation on non-null instances of AnyRef, and has three additional properties:

    • It is consistent: for any non-null instances x and y of type AnyRef, multiple invocations of x.eq(y) consistently returns true or consistently returns false.
    • For any non-null instance x of type AnyRef, x.eq(null) and null.eq(x) returns false.
    • null.eq(null) returns true.

    When overriding the equals or hashCode methods, it is important to ensure that their behavior is consistent with reference equality. Therefore, if two objects are references to each other (o1 eq o2), they should be equal to each other (o1 == o2) and they should hash to the same value (o1.hashCode == o2.hashCode).

    returns

    true if the argument is a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  27. def equals(other: Any): Boolean

    The equality method for reference types.

    The equality method for reference types. See equals in Any.

    returns

    true if the receiver object is equivalent to the argument; false otherwise.

    Definition Classes
    FiniteDuration → AnyRef → Any
  28. def finalize(): Unit

    Called by the garbage collector on the receiver object when there are no more references to the object.

    Called by the garbage collector on the receiver object when there are no more references to the object.

    The details of when and if the finalize method is invoked, as well as the interaction between finalize and non-local returns and exceptions, are all platform dependent.

    Attributes
    protected[lang]
    Definition Classes
    AnyRef
    Annotations
    @throws()
    Note

    not specified by SLS as a member of AnyRef

  29. def fromNow: Deadline

    Construct a Deadline from this duration by adding it to the current instant Deadline.now.

  30. final def getClass(): java.lang.Class[_]

    A representation that corresponds to the dynamic class of the receiver object.

    A representation that corresponds to the dynamic class of the receiver object.

    The nature of the representation is platform dependent.

    returns

    a representation that corresponds to the dynamic class of the receiver object.

    Definition Classes
    AnyRef → Any
    Note

    not specified by SLS as a member of AnyRef

  31. def gt(other: Duration): Boolean

    Definition Classes
    Duration
  32. def gteq(other: Duration): Boolean

    Definition Classes
    Duration
  33. def hashCode(): Int

    The hashCode method for reference types.

    The hashCode method for reference types. See hashCode in Any.

    returns

    the hash code value for this object.

    Definition Classes
    FiniteDuration → AnyRef → Any
  34. final def isFinite(): Boolean

    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.

    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.

    Definition Classes
    FiniteDurationDuration
  35. final def isInstanceOf[T0]: Boolean

    Test whether the dynamic type of the receiver object is T0.

    Test whether the dynamic type of the receiver object is T0.

    Note that the result of the test is modulo Scala's erasure semantics. Therefore the expression 1.isInstanceOf[String] will return false, while the expression List(1).isInstanceOf[List[String]] will return true. In the latter example, because the type argument is erased as part of compilation it is not possible to check whether the contents of the list are of the specified type.

    returns

    true if the receiver object is an instance of erasure of type T0; false otherwise.

    Definition Classes
    Any
  36. val length: Long

    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.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown
    IllegalArgumentException

    when invoked on a non-finite duration

  37. def lt(other: Duration): Boolean

    Definition Classes
    Duration
  38. def lteq(other: Duration): Boolean

    Definition Classes
    Duration
  39. def max(other: FiniteDuration): FiniteDuration

  40. def max(other: Duration): Duration

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

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

    Definition Classes
    Duration
  41. def min(other: FiniteDuration): FiniteDuration

  42. def min(other: Duration): Duration

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

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

    Definition Classes
    Duration
  43. def minus(other: FiniteDuration): FiniteDuration

  44. def minus(other: Duration): Duration

    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.

    Definition Classes
    Duration
    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.

  45. def mul(factor: Long): FiniteDuration

    Return the product of this duration and the given integer factor.

    Return the product of this duration and the given integer factor.

    Exceptions thrown
    IllegalArgumentException

    if the result would overflow the range of FiniteDuration

  46. def mul(factor: Double): Duration

    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.

    Definition Classes
    Duration
    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.

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

    Equivalent to !(this eq that).

    Equivalent to !(this eq that).

    returns

    true if the argument is not a reference to the receiver object; false otherwise.

    Definition Classes
    AnyRef
  48. def neg(): Duration

    Negate this duration.

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

    Definition Classes
    Duration
  49. final def notify(): Unit

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Wakes up a single thread that is waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  50. final def notifyAll(): Unit

    Wakes up all threads that are waiting on the receiver object's monitor.

    Wakes up all threads that are waiting on the receiver object's monitor.

    Definition Classes
    AnyRef
    Note

    not specified by SLS as a member of AnyRef

  51. def plus(other: FiniteDuration): FiniteDuration

  52. def plus(other: Duration): Duration

    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.

    Definition Classes
    Duration
    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.

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

    Definition Classes
    AnyRef
  54. def toDays: Long

    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.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown
    IllegalArgumentException

    when invoked on a non-finite duration

  55. def toHours: Long

    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.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown
    IllegalArgumentException

    when invoked on a non-finite duration

  56. def toMicros: Long

    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.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown
    IllegalArgumentException

    when invoked on a non-finite duration

  57. def toMillis: Long

    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.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown
    IllegalArgumentException

    when invoked on a non-finite duration

  58. def toMinutes: Long

    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.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown
    IllegalArgumentException

    when invoked on a non-finite duration

  59. def toNanos: Long

    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.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown
    IllegalArgumentException

    when invoked on a non-finite duration

  60. def toSeconds: Long

    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.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown
    IllegalArgumentException

    when invoked on a non-finite duration

  61. def toString(): String

    Creates a String representation of this object.

    Creates a String representation of this object. The default representation is platform dependent. On the java platform it is the concatenation of the class name, "@", and the object's hashcode in hexadecimal.

    returns

    a String representation of the object.

    Definition Classes
    FiniteDuration → AnyRef → Any
  62. def toUnit(u: TimeUnit): Double

    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

    • Duration.Undefined is mapped to Double.NaN
    • Duration.Inf is mapped to Double.PositiveInfinity
    • Duration.MinusInf is mapped to Double.NegativeInfinity
    Definition Classes
    FiniteDurationDuration
  63. def unary_-: FiniteDuration

    Negate this duration.

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

    Definition Classes
    FiniteDurationDuration
  64. val unit: TimeUnit

    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.

    Definition Classes
    FiniteDurationDuration
    Exceptions thrown
    IllegalArgumentException

    when invoked on a non-finite duration

  65. final def wait(): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  66. final def wait(arg0: Long, arg1: Int): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()
  67. final def wait(arg0: Long): Unit

    Definition Classes
    AnyRef
    Annotations
    @throws()

Inherited from Duration

Inherited from Ordered[Duration]

Inherited from Comparable[Duration]

Inherited from Serializable

Inherited from Serializable

Inherited from AnyRef

Inherited from Any