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 StringAdd
  3. by StringFormat
  4. by Ensuring
  5. by ArrowAssoc
  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

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

    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 ArrowAssoc 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

    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

    Definition Classes
    Any
  15. def clone(): AnyRef

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  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
    DeadlineOrdered
  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 Ensuring 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 Ensuring 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 Ensuring 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 Ensuring in scala.Predef.
    Definition Classes
    Ensuring
  22. final def eq(arg0: AnyRef): Boolean

    Definition Classes
    AnyRef
  23. def finalize(): Unit

    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  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[Deadline] performed by method StringFormat in scala.Predef.
    Definition Classes
    StringFormat
    Annotations
    @inline()
  25. final def getClass(): Class[_]

    Definition Classes
    AnyRef → Any
  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

    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

    Definition Classes
    AnyRef
  30. final def notify(): Unit

    Definition Classes
    AnyRef
  31. final def notifyAll(): Unit

    Definition Classes
    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 ArrowAssoc in scala.Predef.
    Definition Classes
    ArrowAssoc

Shadowed Implicit Value Members

  1. def +(other: String): String

    Implicit information
    This member is added by an implicit conversion from Deadline to StringAdd[Deadline] performed by method StringAdd 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[Deadline]).+(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

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 StringAdd from Deadline to StringAdd[Deadline]

Inherited by implicit conversion StringFormat from Deadline to StringFormat[Deadline]

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

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

Ungrouped