sealed abstract class Duration extends Serializable with Ordered[Duration]
Utility for working with java.util.concurrent.TimeUnit durations.
This class is not meant as a general purpose representation of time, it is
optimized for the needs of scala.concurrent
.
Basic Usage
Examples:
import scala.concurrent.duration._ val duration = Duration(100, MILLISECONDS) val duration = Duration(100, "millis") duration.toNanos duration < 1.second duration <= Duration.Inf
Invoking inexpressible conversions (like calling toSeconds
on an infinite duration) will throw an IllegalArgumentException.
Implicits are also provided for Int, Long and Double. Example usage:
import scala.concurrent.duration._ val duration = 100.millis
The DSL provided by the implicit conversions always allows construction of finite durations, even for infinite Double inputs; use Duration.Inf instead.
Extractors, parsing and arithmetic are also included:
val d = Duration("1.2 µs") val Duration(length, unit) = 5 millis val d2 = d * 2.5 val d3 = d2 + 1.millisecond
Handling of Time Units
Calculations performed on finite durations always retain the more precise unit of either operand, no matter whether a coarser unit would be able to exactly express the same duration. This means that Duration can be used as a lossless container for a (length, unit) pair if it is constructed using the corresponding methods and no arithmetic is performed on it; adding/subtracting durations should in that case be done with care.
Correspondence to Double Semantics
The semantics of arithmetic operations on Duration are two-fold:
- exact addition/subtraction with nanosecond resolution for finite durations, independent of the summands' magnitude
- isomorphic to
java.lang.Double
when it comes to infinite or undefined values
The conversion between Duration and Double is done using Duration.toUnit (with unit NANOSECONDS) and Duration.fromNanos(Double)
Ordering
The default ordering is consistent with the ordering of Double numbers, which means that Undefined is considered greater than all other durations, including Duration.Inf.
- Source
- Duration.scala
- Alphabetic
- By Inheritance
- Duration
- Ordered
- Comparable
- Serializable
- AnyRef
- Any
- by orderingToOrdered
- by durationToPair
- by any2stringadd
- by StringFormat
- by Ensuring
- by ArrowAssoc
- Hide All
- Show All
- Public
- All
Abstract Value Members
- abstract 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.
- 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.
- abstract 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.
- 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.
- abstract 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.
- 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.
- abstract 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.
- abstract 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.
- 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.
- abstract def compare(that: Duration): 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
- Definition Classes
- Ordered
- abstract def isFinite: Boolean
This method returns whether this duration is finite, which is not the same as
!isInfinite
for Double because this method also returnsfalse
for Duration.Undefined. - abstract def 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.- Exceptions thrown
IllegalArgumentException
when invoked on a non-finite duration
- abstract def toCoarsest: Duration
Return duration which is equal to this duration but with a coarsest Unit, or self in case it is already the coarsest Unit
Return duration which is equal to this duration but with a coarsest Unit, or self in case it is already the coarsest Unit
Examples:
Duration(60, MINUTES).toCoarsest // Duration(1, HOURS) Duration(1000, MILLISECONDS).toCoarsest // Duration(1, SECONDS) Duration(48, HOURS).toCoarsest // Duration(2, DAYS) Duration(5, SECONDS).toCoarsest // Duration(5, SECONDS)
- abstract 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.
- Exceptions thrown
IllegalArgumentException
when invoked on a non-finite duration
- abstract 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.
- Exceptions thrown
IllegalArgumentException
when invoked on a non-finite duration
- abstract 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.
- Exceptions thrown
IllegalArgumentException
when invoked on a non-finite duration
- abstract 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.
- Exceptions thrown
IllegalArgumentException
when invoked on a non-finite duration
- abstract 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.
- Exceptions thrown
IllegalArgumentException
when invoked on a non-finite duration
- abstract 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.
- Exceptions thrown
IllegalArgumentException
when invoked on a non-finite duration
- abstract 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.
- Exceptions thrown
IllegalArgumentException
when invoked on a non-finite duration
- abstract def toUnit(unit: 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
- abstract def unary_-: Duration
Negate this duration.
Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.
- abstract def 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.
- Exceptions thrown
IllegalArgumentException
when invoked on a non-finite duration
Concrete Value Members
- def <(that: Duration): Boolean
Returns true if
this
is less thanthat
Returns true if
this
is less thanthat
- Definition Classes
- Ordered
- def <=(that: Duration): 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: Duration): Boolean
Returns true if
this
is greater thanthat
.Returns true if
this
is greater thanthat
.- Definition Classes
- Ordered
- def >=(that: Duration): 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 compareTo(that: Duration): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
.- Definition Classes
- Ordered → Comparable
- 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.
- 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.
- 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.
- def gt(other: Duration): Boolean
- def gteq(other: Duration): Boolean
- def lt(other: Duration): Boolean
- def lteq(other: Duration): Boolean
- def max(other: Duration): Duration
Return the larger of this and that duration as determined by the natural ordering.
- def min(other: Duration): Duration
Return the smaller of this and that duration as determined by the natural ordering.
- 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.
- 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.
- 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.
- 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.
- def neg(): Duration
Negate this duration.
Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.
- 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.
- 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.
- def productArity: Int
The arity of this product.
- def productElement(n: Int): Any
Returns the n-th projection of this product if 0 <= n < productArity, otherwise throws an
IndexOutOfBoundsException
.Returns the n-th projection of this product if 0 <= n < productArity, otherwise throws an
IndexOutOfBoundsException
.- n
number of the projection to be returned
- returns
same as
._(n+1)
, for exampleproductElement(0)
is the same as._1
.
- Implicit
- This member is added by an implicit conversion from Duration to(Long, TimeUnit) performed by method durationToPair in scala.concurrent.duration.
- Definition Classes
- Product2 → Product
- Annotations
- @throws(classOf[IndexOutOfBoundsException])
- Exceptions thrown
IndexOutOfBoundsException
if then
is out of range(n < 0 || n >= 2).
- 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.
- Implicit
- This member is added by an implicit conversion from Duration to(Long, TimeUnit) performed by method durationToPair in scala.concurrent.duration.
- Definition Classes
- Product
- def swap: (TimeUnit, Long)
Swaps the elements of this
Tuple
.Swaps the elements of this
Tuple
.- returns
a new Tuple where the first element is the second element of this Tuple and the second element is the first element of this Tuple.
- Implicit
- This member is added by an implicit conversion from Duration to(Long, TimeUnit) performed by method durationToPair in scala.concurrent.duration.
- Definition Classes
- Tuple2
Shadowed Implicit Value Members
- def <(that: Duration): 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 Duration tomath.Ordered[Duration] 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:(duration: math.Ordered[Duration]).<(that)
- Definition Classes
- Ordered
- def <=(that: Duration): 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 Duration tomath.Ordered[Duration] 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:(duration: math.Ordered[Duration]).<=(that)
- Definition Classes
- Ordered
- def >(that: Duration): 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 Duration tomath.Ordered[Duration] 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:(duration: math.Ordered[Duration]).>(that)
- Definition Classes
- Ordered
- def >=(that: Duration): 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 Duration tomath.Ordered[Duration] 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:(duration: math.Ordered[Duration]).>=(that)
- Definition Classes
- Ordered
- def compare(that: Duration): 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 Duration tomath.Ordered[Duration] 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:(duration: math.Ordered[Duration]).compare(that)
- Definition Classes
- Ordered
- def compareTo(that: Duration): Int
Result of comparing
this
with operandthat
.Result of comparing
this
with operandthat
.- Implicit
- This member is added by an implicit conversion from Duration tomath.Ordered[Duration] 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:(duration: math.Ordered[Duration]).compareTo(that)
- Definition Classes
- Ordered → Comparable
- 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.
- Implicit
- This member is added by an implicit conversion from Duration to(Long, TimeUnit) performed by method durationToPair in scala.concurrent.duration.
- 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:(duration: (Long, TimeUnit)).toString()
- Definition Classes
- Tuple2 → AnyRef → Any
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
.