Class FiniteDuration.FiniteDuration

final class FiniteDuration(val length: Long, val unit: TimeUnit) extends Duration

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.

Supertypes	class Duration trait Ordered[Duration] trait Comparable[Duration] trait Serializable class Object trait Matchable class Any

Concrete methods

Source

def *(factor: Double): Duration

Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.

$ovf

Source

def *(factor: Long): FiniteDuration

Return the product of this duration and the given integer factor.

Throws	IllegalArgumentException if the result would overflow the range of FiniteDuration

Source

def +(other: Duration): Duration

Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.

$ovf

Source

def +(other: FiniteDuration): FiniteDuration

Source

def -(other: Duration): Duration

Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.

$ovf

Source

def -(other: FiniteDuration): FiniteDuration

Source

def /(divisor: Double): Duration

Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.

$ovf

Source

def /(divisor: Duration): Double

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.

Source

def /(divisor: Long): FiniteDuration

Return the quotient of this duration and the given integer factor.

Throws	java.lang.ArithmeticException if the factor is 0

Source

def compare(other: Duration): Int

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

Source

def div(divisor: Long): FiniteDuration

Return the quotient of this duration and the given integer factor.

Throws	java.lang.ArithmeticException if the factor is 0

Source

override def equals(other: Any): Boolean

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 x of type Any, x.equals(x) should return true. - It is symmetric: for any instances x and y of type Any, x.equals(y) should return true if and only if y.equals(x) returns true. - It is transitive: for any instances x, y, and z of type Any if x.equals(y) returns true and y.equals(z) returns true, then x.equals(z) should return true.

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.
Returns	true if the receiver object is equivalent to the argument; false otherwise.
Definition Classes	Any

Source

def fromNow: Deadline

Construct a Deadline from this duration by adding it to the current instant Deadline.now.

Source

override def hashCode: Int

Calculate 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.

Returns	the hash code value for this object.
Definition Classes	Any

Source

final def isFinite: Boolean

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.

Source

def max(other: FiniteDuration): FiniteDuration

Source

def min(other: FiniteDuration): FiniteDuration

Source

def minus(other: FiniteDuration): FiniteDuration

Source

def mul(factor: Long): FiniteDuration

Return the product of this duration and the given integer factor.

Throws	IllegalArgumentException if the result would overflow the range of FiniteDuration

Source

def plus(other: FiniteDuration): FiniteDuration

Source

final override def toCoarsest: FiniteDuration

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)

Definition Classes	Duration

Source

def toDays: Long

Return the length of this duration measured in whole days, rounding towards zero.

$exc

Source

def toHours: Long

Return the length of this duration measured in whole hours, rounding towards zero.

$exc

Source

def toMicros: Long

Return the length of this duration measured in whole microseconds, rounding towards zero.

$exc

Source

def toMillis: Long

Return the length of this duration measured in whole milliseconds, rounding towards zero.

$exc

Source

def toMinutes: Long

Return the length of this duration measured in whole minutes, rounding towards zero.

$exc

Source

def toNanos: Long

Return the length of this duration measured in whole nanoseconds, rounding towards zero.

$exc

Source

def toSeconds: Long

Return the length of this duration measured in whole seconds, rounding towards zero.

$exc

Source

override def toString: String

Returns a string representation of the object.

The default representation is platform dependent.

Returns	a string representation of the object.
Definition Classes	Any

Source

def toUnit(u: TimeUnit): Double

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

Source

def unary_-: Duration

Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.

Inherited methods

Source

def <(that: Duration): Boolean

Returns true if this is less than that

Inherited from	Ordered

Source

def <=(that: Duration): Boolean

Returns true if this is less than or equal to that.

Inherited from	Ordered

Source

def >(that: Duration): Boolean

Returns true if this is greater than that.

Inherited from	Ordered

Source

def >=(that: Duration): Boolean

Returns true if this is greater than or equal to that.

Inherited from	Ordered

Source

def compareTo(that: Duration): Int

Result of comparing this with operand that.

Inherited from	Ordered

Source

def div(other: Duration): Double

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.

Inherited from	Duration

Source

def div(divisor: Double): Duration

Return this duration divided by the scalar factor. When involving non-finite factors the semantics match those of Double.

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

Source

def gt(other: Duration): Boolean

Inherited from	Duration

Source

def gteq(other: Duration): Boolean

Inherited from	Duration

Source

def lt(other: Duration): Boolean

Inherited from	Duration

Source

def lteq(other: Duration): Boolean

Inherited from	Duration

Source

def max(other: Duration): Duration

Return the larger of this and that duration as determined by the natural ordering.

Inherited from	Duration

Source

def min(other: Duration): Duration

Return the smaller of this and that duration as determined by the natural ordering.

Inherited from	Duration

Source

def minus(other: Duration): Duration

Return the difference of that duration and this. When involving non-finite summands the semantics match those of Double.

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

Source

def mul(factor: Double): Duration

Return this duration multiplied by the scalar factor. When involving non-finite factors the semantics match those of Double.

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

Source

def neg(): Duration

Negate this duration. The only two values which are mapped to themselves are Duration.Zero and Duration.Undefined.

Inherited from	Duration

Source

def plus(other: Duration): Duration

Return the sum of that duration and this. When involving non-finite summands the semantics match those of Double.

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

Source

val length: Long

Obtain the length of this Duration measured in the unit obtained by the unit method.

$exc

Source

val unit: TimeUnit

Obtain the time unit in which the length of this duration is measured.

$exc