Class scala.concurrent.duration.Deadline
Companion object Deadline
case class Deadline extends Ordered[Deadline] with Product with Serializable
Value Members
final def !=(arg0: Any): Boolean
Test two objects for inequality.
- returns
true
if !(this == that), false otherwise.
- Definition Classes
- AnyRef → Any
final def ##(): Int
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
def +(other: FiniteDuration): Deadline
def -(other: Deadline): FiniteDuration
def -(other: FiniteDuration): Deadline
def ->[B](y: B): (Deadline, B)
- Implicit
- This member is added by an implicit conversion from Deadline toArrowAssoc[Deadline] performed by method ArrowAssoc in scala.Predef.
- Definition Classes
- ArrowAssoc
- Annotations
- @inline()
def <(that: Deadline): Boolean
Returns true if this
is less than that
- Definition Classes
- Ordered
def <=(that: Deadline): Boolean
Returns true if this
is less than or equal to that
.
- Definition Classes
- Ordered
final def ==(arg0: Any): Boolean
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
- AnyRef → Any
def >(that: Deadline): Boolean
Returns true if this
is greater than that
.
- Definition Classes
- Ordered
def >=(that: Deadline): Boolean
Returns true if this
is greater than or equal to that
.
- Definition Classes
- Ordered
final def asInstanceOf[T0]: 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 typeT0
.
def clone(): AnyRef
Create a copy of the receiver object.
The default implementation of the clone
method is platform dependent.
- returns
a copy of the receiver object.
def compare(other: Deadline): Int
The natural ordering for deadline is determined by the natural order of the underlying (finite) duration.
def compareTo(that: Deadline): Int
Result of comparing this
with operand that
.
- Definition Classes
- Ordered → Comparable
def ensuring(cond: (Deadline) => Boolean, msg: => Any): Deadline
- Implicit
- This member is added by an implicit conversion from Deadline toEnsuring[Deadline] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: (Deadline) => Boolean): Deadline
- Implicit
- This member is added by an implicit conversion from Deadline toEnsuring[Deadline] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean, msg: => Any): Deadline
- Implicit
- This member is added by an implicit conversion from Deadline toEnsuring[Deadline] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
def ensuring(cond: Boolean): Deadline
- Implicit
- This member is added by an implicit conversion from Deadline toEnsuring[Deadline] performed by method Ensuring in scala.Predef.
- Definition Classes
- Ensuring
final def eq(arg0: AnyRef): Boolean
Tests whether the argument (that
) 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
def finalize(): Unit
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.
def formatted(fmtstr: String): String
Returns string formatted according to given format
string. Format strings are as for String.format
(@see java.lang.String.format).
- Implicit
- This member is added by an implicit conversion from Deadline toStringFormat[Deadline] performed by method StringFormat in scala.Predef.
- Definition Classes
- StringFormat
- Annotations
- @inline()
final def getClass(): Class[_ <: AnyRef]
Returns the runtime class representation of the object.
- returns
a class object corresponding to the runtime type of the receiver.
def hasTimeLeft(): Boolean
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.
final def isInstanceOf[T0]: Boolean
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 typeT0
;false
otherwise.
- Definition Classes
- Any
def isOverdue(): Boolean
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.
final def ne(arg0: AnyRef): Boolean
Equivalent to !(this eq that)
.
- returns
true
if the argument is not a reference to the receiver object;false
otherwise.
- Definition Classes
- AnyRef
final def notify(): Unit
Wakes up a single thread that is waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
final def notifyAll(): Unit
Wakes up all threads that are waiting on the receiver object's monitor.
- Definition Classes
- AnyRef
- Annotations
- @native()
- Note
not specified by SLS as a member of AnyRef
def productElementNames: Iterator[String]
An iterator over the names of all the elements of this product.
- Definition Classes
- Product
final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
val time: FiniteDuration
def timeLeft: FiniteDuration
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.
final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
final def wait(arg0: Long): Unit
Shadowed Implicit Value Members
def +(other: String): String
- Implicit
- This member is added by an implicit conversion from Deadline toany2stringadd[Deadline] 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: any2stringadd[Deadline]).+(other)
- Definition Classes
- any2stringadd
def <(that: Deadline): Boolean
Returns true if this
is less than that
- Implicit
- This member is added by an implicit conversion from Deadline tomath.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
def <=(that: Deadline): Boolean
Returns true if this
is less than or equal to that
.
- Implicit
- This member is added by an implicit conversion from Deadline tomath.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
def >(that: Deadline): Boolean
Returns true if this
is greater than that
.
- Implicit
- This member is added by an implicit conversion from Deadline tomath.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
def >=(that: Deadline): Boolean
Returns true if this
is greater than or equal to that
.
- Implicit
- This member is added by an implicit conversion from Deadline tomath.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
def compare(that: Deadline): Int
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
- This member is added by an implicit conversion from Deadline tomath.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
def compareTo(that: Deadline): Int
Result of comparing this
with operand that
.
- Implicit
- This member is added by an implicit conversion from Deadline tomath.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
© 2002-2019 EPFL, with contributions from Lightbend.
Licensed under the Apache License, Version 2.0.
https://www.scala-lang.org/api/2.13.0/scala/concurrent/duration/Deadline.html
This class stores a deadline, as obtained via
Deadline.now
or the duration DSL:Its main purpose is to manage repeated attempts to achieve something (like awaiting a condition) by offering the methods
hasTimeLeft
andtimeLeft
. All durations are measured according toSystem.nanoTime
; this does not take into account changes to the system clock (such as leap seconds).