Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.
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.
Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.
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.
Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.
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.
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.
Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.
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.
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
Obtain the length of this Duration measured in the unit obtained by the unit method.
IllegalArgumentException when invoked on a non-finite duration
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)
Return the length of this duration measured in whole days, rounding towards zero.
IllegalArgumentException when invoked on a non-finite duration
Return the length of this duration measured in whole hours, rounding towards zero.
IllegalArgumentException when invoked on a non-finite duration
Return the length of this duration measured in whole microseconds, rounding towards zero.
IllegalArgumentException when invoked on a non-finite duration
Return the length of this duration measured in whole milliseconds, rounding towards zero.
IllegalArgumentException when invoked on a non-finite duration
Return the length of this duration measured in whole minutes, rounding towards zero.
IllegalArgumentException when invoked on a non-finite duration
Return the length of this duration measured in whole nanoseconds, rounding towards zero.
IllegalArgumentException when invoked on a non-finite duration
Return the length of this duration measured in whole seconds, rounding towards zero.
IllegalArgumentException when invoked on a non-finite duration
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
Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.
Obtain the time unit in which the length of this duration is measured.
IllegalArgumentException when invoked on a non-finite duration
Test two objects for inequality.
true if !(this == that), false otherwise.
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.
a hash value consistent with ==
Returns true if this is less than that
Returns true if this is less than or equal to that.
The expression x == that is equivalent to if (x eq null) that eq null else x.equals(that).
true if the receiver object is equivalent to the argument; false otherwise.
Returns true if this is greater than that.
Returns true if this is greater than or equal to that.
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.
the receiver object.
ClassCastException if the receiver object is not an instance of the erasure of type T0.
Create a copy of the receiver object.
The default implementation of the clone method is platform dependent.
a copy of the receiver object.
Result of comparing this with operand that.
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.
Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.
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.
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:
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).
true if the argument is a reference to the receiver object; false otherwise.
The equality method for reference types. Default implementation delegates to eq.
See also equals in scala.Any.
true if the receiver object is equivalent to the argument; false otherwise.
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.
Returns string formatted according to given format string. Format strings are as for String.format (@see java.lang.String.format).
Returns the runtime class representation of the object.
a class object corresponding to the runtime type of the receiver.
The hashCode method for reference types. See hashCode in scala.Any.
the hash code value for this object.
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.
true if the receiver object is an instance of erasure of type T0; false otherwise.
Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.
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.
Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.
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.
Equivalent to !(this eq that).
true if the argument is not a reference to the receiver object; false otherwise.
Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.
Wakes up a single thread that is waiting on the receiver object's monitor.
not specified by SLS as a member of AnyRef
Wakes up all threads that are waiting on the receiver object's monitor.
not specified by SLS as a member of AnyRef
Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.
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.
The arity of this product.
2
Returns the n-th projection of this product if 0 <= n < productArity, otherwise throws an IndexOutOfBoundsException.
number of the projection to be returned
same as ._(n+1), for example productElement(0) is the same as ._1.
IndexOutOfBoundsException if the n is out of range(n < 0 || n >= 2).
An iterator over the names of all the elements of this product.
Swaps the elements of this Tuple.
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.
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.
a String representation of the object.
(duration: any2stringadd[Duration]).+(other)
Returns true if this is less than that
(duration: math.Ordered[Duration]).<(that)
Returns true if this is less than or equal to that.
(duration: math.Ordered[Duration]).<=(that)
Returns true if this is greater than that.
(duration: math.Ordered[Duration]).>(that)
Returns true if this is greater than or equal to that.
(duration: math.Ordered[Duration]).>=(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
(duration: math.Ordered[Duration]).compare(that)
Result of comparing this with operand that.
(duration: math.Ordered[Duration]).compareTo(that)
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.
a String representation of the object.
(duration: (Long, TimeUnit)).toString()
© 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/Duration.html
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:
Invoking inexpressible conversions (like calling
toSecondson an infinite duration) will throw an IllegalArgumentException.Implicits are also provided for Int, Long and Double. Example usage:
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.millisecondHandling 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:
java.lang.Doublewhen it comes to infinite or undefined valuesThe 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.