scala.concurrent.duration

# Deadline

#### case class Deadline extends Ordered[Deadline] with Product with Serializable

This class stores a deadline, as obtained via `Deadline.now` or the duration DSL:

    import scala.concurrent.duration._
    3.seconds.fromNow

Its main purpose is to manage repeated attempts to achieve something (like awaiting a condition) by offering the methods `hasTimeLeft` and `timeLeft`. All durations are measured according to `System.nanoTime` aka wall-time; this does not take into account changes to the system clock (such as leap seconds).

Source
  Deadline.scala

Linear Supertypes
Serializable, java.io.Serializable, Product, Equals, math.Ordered[Deadline], Comparable[Deadline], AnyRef, Any
Type Hierarchy Learn more about scaladoc diagrams
Ordering

1. Alphabetic
2. By inheritance

Inherited

1. Deadline
2. Serializable
3. Serializable
4. Product
5. Equals
6. Ordered
7. Comparable
8. AnyRef
9. Any

Implicitly

1. by orderingToOrdered
2. by any2stringadd
3. by any2stringfmt
4. by any2ArrowAssoc
5. by any2Ensuring

1. Hide All
2. Show all

Learn more about member selection
Visibility

1. Public
2. All

### 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 and `null`.

   Equivalent to `x.hashCode` except for boxed numeric types and `null`. 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. For `null` returns a hashcode where `null.hashCode` throws a `NullPointerException`.

   returns

     a hash value consistent with ==

   Definition Classes
     AnyRef → Any

4. #### def +(other: FiniteDuration): Deadline

   Return a deadline advanced (i.

   Return a deadline advanced (i.e. moved into the future) by the given duration.

5. #### def -(other: Deadline): FiniteDuration

   Calculate time difference between this and the other deadline, where the result is directed (i.

   Calculate time difference between this and the other deadline, where the result is directed (i.e. may be negative).

6. #### def -(other: FiniteDuration): Deadline

   Return a deadline moved backwards (i.

   Return a deadline moved backwards (i.e. towards the past) by the given duration.

7. #### def ->[B](y: B): (Deadline, B)

   Implicit information
     This member is added by an implicit conversion from Deadline to ArrowAssoc[Deadline] performed by method any2ArrowAssoc in scala.Predef.
   Definition Classes
     ArrowAssoc
   Annotations
     @inline ()

8. #### def <(that: Deadline): Boolean

   Returns true if `this` is less than `that`

   Returns true if `this` is less than `that`

   Definition Classes
     Ordered

9. #### def <=(that: Deadline): 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

10. #### final def ==(arg0: AnyRef): Boolean

    Definition Classes
      AnyRef

11. #### final def ==(arg0: Any): Boolean

    Test two objects for equality.

    Test two objects for equality. The expression `x == that` is equivalent to `if (x eq null) that eq null else x.equals(that)`.

    returns

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

    Definition Classes
      Any

12. #### def >(that: Deadline): Boolean

    Returns true if `this` is greater than `that`.

    Returns true if `this` is greater than `that`.

    Definition Classes
      Ordered

13. #### def >=(that: Deadline): 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

14. #### 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`.

15. #### 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[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws ()
    Note

      not specified by SLS as a member of AnyRef

16. #### def compare(other: Deadline): Int

    The natural ordering for deadline is determined by the natural order of the underlying (finite) duration.

    The natural ordering for deadline is determined by the natural order of the underlying (finite) duration.

    Definition Classes
      Deadline → Ordered

17. #### def compareTo(that: Deadline): Int

    Result of comparing `this` with operand `that`.

    Result of comparing `this` with operand `that`.

    Definition Classes
      Ordered → Comparable

18. #### def ensuring(cond: (Deadline) ⇒ Boolean, msg: ⇒ Any): Deadline

    Implicit information
      This member is added by an implicit conversion from Deadline to Ensuring[Deadline] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

19. #### def ensuring(cond: (Deadline) ⇒ Boolean): Deadline

    Implicit information
      This member is added by an implicit conversion from Deadline to Ensuring[Deadline] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

20. #### def ensuring(cond: Boolean, msg: ⇒ Any): Deadline

    Implicit information
      This member is added by an implicit conversion from Deadline to Ensuring[Deadline] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

21. #### def ensuring(cond: Boolean): Deadline

    Implicit information
      This member is added by an implicit conversion from Deadline to Ensuring[Deadline] performed by method any2Ensuring in scala.Predef.
    Definition Classes
      Ensuring

22. #### 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

23. #### 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[java.lang]
    Definition Classes
      AnyRef
    Annotations
      @throws ()
    Note

      not specified by SLS as a member of AnyRef

24. #### def formatted(fmtstr: String): String

    Returns string formatted according to given `format` string.

    Returns string formatted according to given `format` string. Format strings are as for `String.format` (@see java.lang.String.format).

    Implicit information
      This member is added by an implicit conversion from Deadline to StringFormat performed by method any2stringfmt in scala.Predef.
    Definition Classes
      StringFormat
    Annotations
      @inline ()

25. #### final def getClass(): 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

26. #### def hasTimeLeft(): Boolean

    Determine whether the deadline still lies in the future at the point where this method is called.

    Determine whether the deadline still lies in the future at the point where this method is called.

    Note that on some systems this operation is costly because it entails a system call. Check `System.nanoTime` for your platform.

27. #### 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

28. #### def isOverdue(): Boolean

    Determine whether the deadline lies in the past at the point where this method is called.

    Determine whether the deadline lies in the past at the point where this method is called.

    Note that on some systems this operation is costly because it entails a system call. Check `System.nanoTime` for your platform.

29. #### 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

30. #### 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

31. #### 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

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

    Definition Classes
      AnyRef

33. #### val time: FiniteDuration

34. #### def timeLeft: FiniteDuration

    Calculate time difference between this duration and now; the result is negative if the deadline has passed.

    Calculate time difference between this duration and now; the result is negative if the deadline has passed.

    Note that on some systems this operation is costly because it entails a system call. Check `System.nanoTime` for your platform.

35. #### final def wait(): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws ()

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

    Definition Classes
      AnyRef
    Annotations
      @throws ()

37. #### final def wait(arg0: Long): Unit

    Definition Classes
      AnyRef
    Annotations
      @throws ()

38. #### def →[B](y: B): (Deadline, B)

    Implicit information
      This member is added by an implicit conversion from Deadline to ArrowAssoc[Deadline] performed by method any2ArrowAssoc in scala.Predef.
    Definition Classes
      ArrowAssoc

### Shadowed Implict Value Members

1. #### def +(other: String): String

   Implicit information
     This member is added by an implicit conversion from Deadline to StringAdd performed by method any2stringadd in scala.Predef.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (deadline: StringAdd).+(other)

   Definition Classes
     StringAdd

2. #### def <(that: Deadline): Boolean

   Returns true if `this` is less than `that`

   Returns true if `this` is less than `that`

   Implicit information
     This member is added by an implicit conversion from Deadline to math.Ordered[Deadline] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (deadline: math.Ordered[Deadline]).<(that)

   Definition Classes
     Ordered

3. #### def <=(that: Deadline): Boolean

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

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

   Implicit information
     This member is added by an implicit conversion from Deadline to math.Ordered[Deadline] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (deadline: math.Ordered[Deadline]).<=(that)

   Definition Classes
     Ordered

4. #### def >(that: Deadline): Boolean

   Returns true if `this` is greater than `that`.

   Returns true if `this` is greater than `that`.

   Implicit information
     This member is added by an implicit conversion from Deadline to math.Ordered[Deadline] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (deadline: math.Ordered[Deadline]).>(that)

   Definition Classes
     Ordered

5. #### def >=(that: Deadline): Boolean

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

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

   Implicit information
     This member is added by an implicit conversion from Deadline to math.Ordered[Deadline] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (deadline: math.Ordered[Deadline]).>=(that)

   Definition Classes
     Ordered

6. #### def compare(that: Deadline): 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`
   Implicit information
     This member is added by an implicit conversion from Deadline to math.Ordered[Deadline] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (deadline: math.Ordered[Deadline]).compare(that)

   Definition Classes
     Ordered

7. #### def compareTo(that: Deadline): Int

   Result of comparing `this` with operand `that`.

   Result of comparing `this` with operand `that`.

   Implicit information
     This member is added by an implicit conversion from Deadline to math.Ordered[Deadline] performed by method orderingToOrdered in scala.math.Ordered.
   Shadowing
     This implicitly inherited member is shadowed by one or more members in this class.
     To access this member you can use a type ascription:

         (deadline: math.Ordered[Deadline]).compareTo(that)

   Definition Classes
     Ordered → Comparable

8. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from Deadline to StringAdd performed by method any2stringadd in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (deadline: StringAdd).self

   Definition Classes
     StringAdd

9. #### val self: Any

   Implicit information
     This member is added by an implicit conversion from Deadline to StringFormat performed by method any2stringfmt in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (deadline: StringFormat).self

   Definition Classes
     StringFormat

### Deprecated Value Members

1. #### def x: Deadline

   Implicit information
     This member is added by an implicit conversion from Deadline to ArrowAssoc[Deadline] performed by method any2ArrowAssoc in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (deadline: ArrowAssoc[Deadline]).x

   Definition Classes
     ArrowAssoc
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `leftOfArrow`instead``

2. #### def x: Deadline

   Implicit information
     This member is added by an implicit conversion from Deadline to Ensuring[Deadline] performed by method any2Ensuring in scala.Predef.
   Shadowing
     This implicitly inherited member is ambiguous. One or more implicitly inherited members have similar signatures, so calling this member may produce an ambiguous implicit conversion compiler error.
     To access this member you can use a type ascription:

         (deadline: Ensuring[Deadline]).x

   Definition Classes
     Ensuring
   Annotations
     @deprecated
   Deprecated

     (Since version 2.10.0) Use `resultOfEnsuring`instead``

### Inherited from Serializable

### Inherited from java.io.Serializable

### Inherited from Product

### Inherited from Equals

### Inherited from math.Ordered[Deadline]

### Inherited from Comparable[Deadline]

### Inherited from AnyRef

### Inherited from Any

### Inherited by implicit conversion orderingToOrdered from Deadline to math.Ordered[Deadline]

### Inherited by implicit conversion any2stringadd from Deadline to StringAdd

### Inherited by implicit conversion any2stringfmt from Deadline to StringFormat

### Inherited by implicit conversion any2ArrowAssoc from Deadline to ArrowAssoc[Deadline]

### Inherited by implicit conversion any2Ensuring from Deadline to Ensuring[Deadline]

### Ungrouped