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
; this
does not take into account changes to the system clock (such as leap
seconds).
- Source
- Deadline.scala
- Alphabetic
- By Inheritance
- Deadline
- Serializable
- Product
- Equals
- Ordered
- Comparable
- AnyRef
- Any
- by orderingToOrdered
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Value Members
- def +(other: FiniteDuration): Deadline
Return a deadline advanced (i.e., moved into the future) by the given duration.
- def -(other: Deadline): FiniteDuration
Calculate time difference between this and the other deadline, where the result is directed (i.e., may be negative).
- def -(other: FiniteDuration): Deadline
Return a deadline moved backwards (i.e., towards the past) by the given duration.
- def <(that: Deadline): Boolean
Returns true if
this
is less thanthat
Returns true if
this
is less thanthat
- Definition Classes
- Ordered
- def <=(that: Deadline): Boolean
Returns true if
this
is less than or equal tothat
.Returns true if
this
is less than or equal tothat
.- Definition Classes
- Ordered
- def >(that: Deadline): Boolean
Returns true if
this
is greater thanthat
.Returns true if
this
is greater thanthat
.- Definition Classes
- Ordered
- def >=(that: Deadline): Boolean
Returns true if
this
is greater than or equal tothat
.Returns true if
this
is greater than or equal tothat
.- Definition Classes
- Ordered
- 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 operandthat
.Result of comparing
this
with operandthat
.- Definition Classes
- Ordered → Comparable
- 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. - 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. - def productElementNames: Iterator[String]
An iterator over the names of all the elements of this product.
An iterator over the names of all the elements of this product.
- Definition Classes
- Product
- val time: FiniteDuration
- 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.
Shadowed Implicit Value Members
- def <(that: Deadline): Boolean
Returns true if
this
is less thanthat
Returns true if
this
is less thanthat
- 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 tothat
.Returns true if
this
is less than or equal tothat
.- 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 thanthat
.Returns true if
this
is greater thanthat
.- 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 tothat
.Returns true if
this
is greater than or equal tothat
.- 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 operandthat
.Result of comparing
this
with operandthat
.Implement this method to determine how instances of A will be sorted.
Returns
x
where:x < 0
whenthis < that
x == 0
whenthis == that
x > 0
whenthis > 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 operandthat
.Result of comparing
this
with operandthat
.- 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
This is the documentation for the Scala standard library.
Package structure
The scala package contains core types like
Int
,Float
,Array
orOption
which are accessible in all Scala compilation units without explicit qualification or imports.Notable packages include:
scala.collection
and its sub-packages contain Scala's collections frameworkscala.collection.immutable
- Immutable, sequential data-structures such asVector
,List
,Range
,HashMap
orHashSet
scala.collection.mutable
- Mutable, sequential data-structures such asArrayBuffer
,StringBuilder
,HashMap
orHashSet
scala.collection.concurrent
- Mutable, concurrent data-structures such asTrieMap
scala.concurrent
- Primitives for concurrent programming such asFutures
andPromises
scala.io
- Input and output operationsscala.math
- Basic math functions and additional numeric types likeBigInt
andBigDecimal
scala.sys
- Interaction with other processes and the operating systemscala.util.matching
- Regular expressionsOther packages exist. See the complete list on the right.
Additional parts of the standard library are shipped as separate libraries. These include:
scala.reflect
- Scala's reflection API (scala-reflect.jar)scala.xml
- XML parsing, manipulation, and serialization (scala-xml.jar)scala.collection.parallel
- Parallel collections (scala-parallel-collections.jar)scala.util.parsing
- Parser combinators (scala-parser-combinators.jar)scala.swing
- A convenient wrapper around Java's GUI framework called Swing (scala-swing.jar)Automatic imports
Identifiers in the scala package and the
scala.Predef
object are always in scope by default.Some of these identifiers are type aliases provided as shortcuts to commonly used classes. For example,
List
is an alias forscala.collection.immutable.List
.Other aliases refer to classes provided by the underlying platform. For example, on the JVM,
String
is an alias forjava.lang.String
.