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.
Attributes
- Companion
- object
- Source
- Duration.scala
- Graph
-
- Supertypes
- Known subtypes
-
class Infiniteclass FiniteDuration
Members list
Value members
Abstract methods
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.
Attributes
- Throws
-
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. - Source
- Duration.scala
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.
Attributes
- Throws
-
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. - Source
- Duration.scala
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.
Attributes
- Throws
-
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. - Source
- Duration.scala
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.
Attributes
- Throws
-
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. - Source
- Duration.scala
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.
Attributes
- Source
- Duration.scala
This method returns whether this duration is finite, which is not the same as !isInfinite for Double because this method also returns false for Duration.Undefined.
This method returns whether this duration is finite, which is not the same as !isInfinite for Double because this method also returns false for Duration.Undefined.
Attributes
- Source
- Duration.scala
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.
Attributes
- Throws
-
IllegalArgumentException when invoked on a non-finite duration
- Source
- Duration.scala
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)
Attributes
- Source
- Duration.scala
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.
Attributes
- Throws
-
IllegalArgumentException when invoked on a non-finite duration
- Source
- Duration.scala
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.
Attributes
- Throws
-
IllegalArgumentException when invoked on a non-finite duration
- Source
- Duration.scala
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.
Attributes
- Throws
-
IllegalArgumentException when invoked on a non-finite duration
- Source
- Duration.scala
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.
Attributes
- Throws
-
IllegalArgumentException when invoked on a non-finite duration
- Source
- Duration.scala
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.
Attributes
- Throws
-
IllegalArgumentException when invoked on a non-finite duration
- Source
- Duration.scala
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.
Attributes
- Throws
-
IllegalArgumentException when invoked on a non-finite duration
- Source
- Duration.scala
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.
Attributes
- Throws
-
IllegalArgumentException when invoked on a non-finite duration
- Source
- Duration.scala
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
Attributes
- Source
- Duration.scala
Negate this duration.
Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.
Attributes
- Source
- Duration.scala
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.
Attributes
- Throws
-
IllegalArgumentException when invoked on a non-finite duration
- Source
- Duration.scala
Concrete methods
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.
Attributes
- Throws
-
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. - Source
- Duration.scala
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.
Attributes
- Source
- Duration.scala
Attributes
- Source
- Duration.scala
Attributes
- Source
- Duration.scala
Attributes
- Source
- Duration.scala
Attributes
- Source
- Duration.scala
Return the larger of this and that duration as determined by the natural ordering.
Return the larger of this and that duration as determined by the natural ordering.
Attributes
- Source
- Duration.scala
Return the smaller of this and that duration as determined by the natural ordering.
Return the smaller of this and that duration as determined by the natural ordering.
Attributes
- Source
- Duration.scala
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.
Attributes
- Throws
-
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. - Source
- Duration.scala
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.
Attributes
- Throws
-
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. - Source
- Duration.scala
Negate this duration.
Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.
Attributes
- Source
- Duration.scala
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.
Attributes
- Throws
-
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. - Source
- Duration.scala
Swaps the elements of this Tuple.
Swaps the elements of this Tuple.
Attributes
- 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.
- Source
- Tuple2.scala
Inherited methods
Return a new tuple by prepending the element to this tuple. This operation is O(this.size)
Return a new tuple by prepending the element to this tuple. This operation is O(this.size)
Attributes
- Inherited from:
- Tuple
- Source
- Tuple.scala
Return a new tuple by concatenating this tuple with that tuple. This operation is O(this.size + that.size)
Return a new tuple by concatenating this tuple with that tuple. This operation is O(this.size + that.size)
Attributes
- Inherited from:
- Tuple
- Source
- Tuple.scala
Return a copy of this tuple with an element appended
Return a copy of this tuple with an element appended
Attributes
- Inherited from:
- Tuple
- Source
- Tuple.scala
Returns true if this is less than that
Returns true if this is less than or equal to that.
Returns true if this is less than or equal to that.
Attributes
- Inherited from:
- Ordered
- Source
- Ordered.scala
Returns true if this is greater than that.
Returns true if this is greater than or equal to that.
Returns true if this is greater than or equal to that.
Attributes
- Inherited from:
- Ordered
- Source
- Ordered.scala
Get the i-th element of this tuple. Equivalent to productElement but with a precise return type.
Get the i-th element of this tuple. Equivalent to productElement but with a precise return type.
Attributes
- Inherited from:
- NonEmptyTuple
- Source
- Tuple.scala
Result of comparing this with operand that.
Given a tuple (a1, ..., am), returns the tuple (an+1, ..., am) consisting all its elements except the first n ones.
Given a tuple (a1, ..., am), returns the tuple (an+1, ..., am) consisting all its elements except the first n ones.
Attributes
- Inherited from:
- Tuple
- Source
- Tuple.scala
Get the head of this tuple
Get the initial part of the tuple without its last element
Get the initial part of the tuple without its last element
Attributes
- Inherited from:
- NonEmptyTuple
- Source
- Tuple.scala
Get the last of this tuple
Called on a tuple (a1, ..., an), returns a new tuple (f(a1), ..., f(an)). The result is typed as (F[A1], ..., F[An]) if the tuple type is fully known. If the tuple is of the form a1 *: ... *: Tuple (that is, the tail is not known to be the cons type.
Called on a tuple (a1, ..., an), returns a new tuple (f(a1), ..., f(an)). The result is typed as (F[A1], ..., F[An]) if the tuple type is fully known. If the tuple is of the form a1 *: ... *: Tuple (that is, the tail is not known to be the cons type.
Attributes
- Inherited from:
- Tuple
- Source
- Tuple.scala
An iterator over the names of all the elements of this product.
An iterator over the names of all the elements of this product.
Attributes
- Inherited from:
- Product
- Source
- Product.scala
An iterator over all the elements of this product.
An iterator over all the elements of this product.
Attributes
- Returns
-
in the default implementation, an
Iterator[Any] - Inherited from:
- Product
- Source
- Product.scala
Given a tuple (a1, ..., am), returns the reversed tuple (am, ..., a1) consisting all its elements.
Given a tuple (a1, ..., am), returns the reversed tuple (am, ..., a1) consisting all its elements.
Attributes
- Inherited from:
- Tuple
- Source
- Tuple.scala
Return the size (or arity) of the tuple
Given a tuple (a1, ..., am), returns a pair of the tuple (a1, ..., an) consisting of the first n elements, and the tuple (an+1, ..., am) consisting of the remaining elements.
Given a tuple (a1, ..., am), returns a pair of the tuple (a1, ..., an) consisting of the first n elements, and the tuple (an+1, ..., am) consisting of the remaining elements.
Attributes
- Inherited from:
- Tuple
- Source
- Tuple.scala
Get the tail of this tuple. This operation is O(this.size)
Get the tail of this tuple. This operation is O(this.size)
Attributes
- Inherited from:
- NonEmptyTuple
- Source
- Tuple.scala
Given a tuple (a1, ..., am), returns the tuple (a1, ..., an) consisting of its first n elements.
Given a tuple (a1, ..., am), returns the tuple (a1, ..., an) consisting of its first n elements.
Attributes
- Inherited from:
- Tuple
- Source
- Tuple.scala
Create a copy of this tuple as an Array
Create a copy of this tuple as an IArray
Create a copy of this tuple as a List
Given two tuples, (a1, ..., an) and (a1, ..., an), returns a tuple ((a1, b1), ..., (an, bn)). If the two tuples have different sizes, the extra elements of the larger tuple will be disregarded. The result is typed as ((A1, B1), ..., (An, Bn)) if at least one of the tuple types has a EmptyTuple tail. Otherwise the result type is (A1, B1) *: ... *: (Ai, Bi) *: Tuple
Given two tuples, (a1, ..., an) and (a1, ..., an), returns a tuple ((a1, b1), ..., (an, bn)). If the two tuples have different sizes, the extra elements of the larger tuple will be disregarded. The result is typed as ((A1, B1), ..., (An, Bn)) if at least one of the tuple types has a EmptyTuple tail. Otherwise the result type is (A1, B1) *: ... *: (Ai, Bi) *: Tuple
Attributes
- Inherited from:
- Tuple
- Source
- Tuple.scala
Inherited and Abstract methods
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 < 0whenthis < that -
x == 0whenthis == that -
x > 0whenthis > that
Attributes
- Inherited from:
- Ordered
- Source
- Ordered.scala