This class represents a finite duration. Its addition and subtraction operators are overloaded to retain this guarantee statically. The range of this class is limited to +-(2^63-1)ns, which is roughly 292 years.
Attributes
- Companion
- object
- Graph
-
- Supertypes
-
class Durationtrait Comparable[Duration]trait Serializableclass Objecttrait Matchableclass AnyShow all
Members list
Value members
Concrete methods
Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.
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.
Return the product of this duration and the given integer factor.
Return the product of this duration and the given integer factor.
Attributes
- Throws
-
IllegalArgumentException
if the result would overflow the range of FiniteDuration
Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.
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.
Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.
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.
Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.
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.
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 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
Return the quotient of this duration and the given integer factor.
Return the quotient of this duration and the given integer factor.
Attributes
- Throws
-
java.lang.ArithmeticException
if the factor is 0
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
Return the quotient of this duration and the given integer factor.
Return the quotient of this duration and the given integer factor.
Attributes
- Throws
-
java.lang.ArithmeticException
if the factor is 0
Compares the receiver object (this) with the argument object (that) for equivalence.
Compares the receiver object (this) with the argument object (that) for equivalence.
Any implementation of this method should be an equivalence relation:
- It is reflexive: for any instance
xof typeAny,x.equals(x)should returntrue. - It is symmetric: for any instances
xandyof typeAny,x.equals(y)should returntrueif and only ify.equals(x)returnstrue. - It is transitive: for any instances
x,y, andzof typeAnyifx.equals(y)returnstrueandy.equals(z)returnstrue, thenx.equals(z)should returntrue.
If you override this method, you should verify that your implementation remains an equivalence relation. Additionally, when overriding this method it is usually necessary to override hashCode to ensure that objects which are "equal" (o1.equals(o2) returns true) hash to the same scala.Int. (o1.hashCode.equals(o2.hashCode)).
Value parameters
- that
-
the object to compare against this object for equality.
Attributes
- Returns
-
trueif the receiver object is equivalent to the argument;falseotherwise. - Definition Classes
-
Any
Calculates a hash code value for the object.
Calculates a hash code value for the object.
The default hashing algorithm is platform dependent.
Note that it is allowed for two objects to have identical hash codes (o1.hashCode.equals(o2.hashCode)) yet not be equal (o1.equals(o2) returns false). A degenerate implementation could always return 0. However, it is required that if two objects are equal (o1.equals(o2) returns true) that they have identical hash codes (o1.hashCode.equals(o2.hashCode)). Therefore, when overriding this method, be sure to verify that the behavior is consistent with the equals method.
Attributes
- Returns
-
the hash code value for this object.
- Definition Classes
-
Any
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
Return the product of this duration and the given integer factor.
Return the product of this duration and the given integer factor.
Attributes
- Throws
-
IllegalArgumentException
if the result would overflow the range of FiniteDuration
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
- Definition Classes
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
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
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
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
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
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
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
Returns a string representation of the object.
Returns a string representation of the object.
The default representation is platform dependent.
Attributes
- Returns
-
a string representation of the object.
- Definition Classes
-
Any
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
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
Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.
Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.
Attributes
Inherited methods
Returns true if this is less than that
Returns true if this is less than or equal to that.
Returns true if this is greater than that.
Returns true if this is greater than or equal to that.
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 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
- Inherited from:
- Duration
Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.
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. - Inherited from:
- Duration
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
- Inherited from:
- Duration
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
- Inherited from:
- Duration
Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.
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. - Inherited from:
- Duration
Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.
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. - Inherited from:
- Duration
Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.
Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.
Attributes
- Inherited from:
- Duration
Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.
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. - Inherited from:
- Duration
Concrete fields
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
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