Duration

Returns the absolute value of this value. The returned value is always non-negative.

val absoluteValue: Duration

The value of this duration expressed as a Double number of days.

val inDays: Double

The value of this duration expressed as a Double number of hours.

val inHours: Double

The value of this duration expressed as a Double number of microseconds.

val inMicroseconds: Double

The value of this duration expressed as a Double number of milliseconds.

val inMilliseconds: Double

The value of this duration expressed as a Double number of minutes.

val inMinutes: Double

The value of this duration expressed as a Double number of nanoseconds.

val inNanoseconds: Double

The value of this duration expressed as a Double number of seconds.

val inSeconds: Double

Returns a duration whose value is this duration value divided by the given scale number.

operator fun div(scale: Int): Duration

operator fun div(scale: Double): Duration

Returns a number that is the ratio of this and other duration values.

operator fun div(other: Duration): Double

Returns true, if the duration value is finite.

fun isFinite(): Boolean

Returns true, if the duration value is infinite.

fun isInfinite(): Boolean

Returns true, if the duration value is less than zero.

fun isNegative(): Boolean

Returns true, if the duration value is greater than zero.

fun isPositive(): Boolean

Returns a duration whose value is the difference between this and other duration values.

operator fun minus(other: Duration): Duration

Returns a duration whose value is the sum of this and other duration values.

operator fun plus(other: Duration): Duration

Returns a duration whose value is this duration value multiplied by the given scale number.

operator fun times(scale: Int): Duration

operator fun times(scale: Double): Duration

Splits this duration into days, hours, minutes, seconds, and nanoseconds and executes the given action with these components. The result of action is returned as the result of this function.

fun <T> toComponents(
    action: (days: Int, hours: Int, minutes: Int, seconds: Int, nanoseconds: Int) -> T
): T

Splits this duration into hours, minutes, seconds, and nanoseconds and executes the given action with these components. The result of action is returned as the result of this function.

fun <T> toComponents(
    action: (hours: Int, minutes: Int, seconds: Int, nanoseconds: Int) -> T
): T

Splits this duration into minutes, seconds, and nanoseconds and executes the given action with these components. The result of action is returned as the result of this function.

fun <T> toComponents(
    action: (minutes: Int, seconds: Int, nanoseconds: Int) -> T
): T

Splits this duration into seconds, and nanoseconds and executes the given action with these components. The result of action is returned as the result of this function.

fun <T> toComponents(
    action: (seconds: Long, nanoseconds: Int) -> T
): T

Returns the value of this duration expressed as a Double number of the specified unit.

fun toDouble(unit: DurationUnit): Double

Returns the value of this duration expressed as an Int number of the specified unit.

fun toInt(unit: DurationUnit): Int

Returns an ISO-8601 based string representation of this duration.

fun toIsoString(): String

Returns the value of this duration expressed as a Long number of the specified unit.

fun toLong(unit: DurationUnit): Long

Returns the value of this duration expressed as a Long number of milliseconds.

fun toLongMilliseconds(): Long

Returns the value of this duration expressed as a Long number of nanoseconds.

fun toLongNanoseconds(): Long

Returns a string representation of this duration value expressed in the unit which yields the most compact and readable number value.

fun toString(): String

Returns a string representation of this duration value expressed in the given unit and formatted with the specified decimals number of digits after decimal point.

fun toString(unit: DurationUnit, decimals: Int = 0): String

Returns the negative of this value.

operator fun unaryMinus(): Duration

The duration whose value is positive infinity. It is useful for representing timeouts that should never expire.

val INFINITE: Duration

The duration equal to exactly 0 seconds.

val ZERO: Duration

Converts the given time duration value expressed in the specified sourceUnit into the specified targetUnit.

fun convert(
    value: Double, 
    sourceUnit: DurationUnit, 
    targetUnit: DurationUnit
): Double

Ensures that this value is not less than the specified minimumValue.

fun <T : Comparable<T>> T.coerceAtLeast(minimumValue: T): T

Ensures that this value is not greater than the specified maximumValue.

fun <T : Comparable<T>> T.coerceAtMost(maximumValue: T): T

Ensures that this value lies in the specified range minimumValue..maximumValue.

fun <T : Comparable<T>> T.coerceIn(
    minimumValue: T?, 
    maximumValue: T?
): T

Ensures that this value lies in the specified range.

fun <T : Comparable<T>> T.coerceIn(
    range: ClosedFloatingPointRange<T>
): T

fun <T : Comparable<T>> T.coerceIn(range: ClosedRange<T>): T

Creates a range from this Comparable value to the specified that value.

operator fun <T : Comparable<T>> T.rangeTo(
    that: T
): ClosedRange<T>

Converts kotlin.time.Duration value to java.time.Duration value.

fun Duration.toJavaDuration(): Duration