Scala 3/API/scala.concurrent.duration/FiniteDuration

FiniteDuration

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

This class represents a finite 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.

Companion
object
class Duration
class Object
trait Matchable
class Any

Value members

Concrete methods

def *(factor: Double): Duration
def *(factor: Long): FiniteDuration

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

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

Throws
IllegalArgumentException

if the result would overflow the range of FiniteDuration

def +(other: Duration): Duration
def -(other: Duration): Duration
def -(other: FiniteDuration): FiniteDuration
def /(divisor: Double): Duration
def /(divisor: Duration): Double
def /(divisor: Long): FiniteDuration

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

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

Throws
java.lang.ArithmeticException

if the factor is 0

def compare(other: Duration): Int
def div(divisor: Long): FiniteDuration

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

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

Throws
java.lang.ArithmeticException

if the factor is 0

override def equals(other: Any): Boolean
Definition Classes
Any
def fromNow: Deadline

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

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

override def hashCode: Int
Definition Classes
Any
final def isFinite: Boolean
def mul(factor: Long): FiniteDuration

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

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

Throws
IllegalArgumentException

if the result would overflow the range of FiniteDuration

final override def toCoarsest: FiniteDuration
Definition Classes
def toDays: Long
override def toString: String
Definition Classes
Any
def unary_-: Duration

Inherited methods

def <(that: Duration): Boolean

Returns true if this is less than that

Returns true if this is less than that

Inherited from
Ordered
def <=(that: Duration): Boolean

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

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

Inherited from
Ordered
def >(that: Duration): Boolean

Returns true if this is greater than that.

Returns true if this is greater than that.

Inherited from
Ordered
def >=(that: Duration): Boolean

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

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

Inherited from
Ordered
def compareTo(that: Duration): Int

Result of comparing this with operand that.

Result of comparing this with operand that.

Inherited from
Ordered
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.

Inherited from
Duration
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.

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
def gt(other: Duration): Boolean
Inherited from
Duration
def gteq(other: Duration): Boolean
Inherited from
Duration
def lt(other: Duration): Boolean
Inherited from
Duration
def lteq(other: Duration): Boolean
Inherited from
Duration
def max(other: Duration): 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.

Inherited from
Duration
def min(other: Duration): 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.

Inherited from
Duration
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.

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

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
def neg(): Duration

Negate this duration.

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

Inherited from
Duration
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.

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

val length: Long