Duration

data class Duration : Quantity<Duration, Duration.Unit>

A quantity describing a duration. (For example, 10 seconds.)

Types

Link copied to clipboard
object Companion
Link copied to clipboard
enum Unit : Enum<Duration.Unit>

The unit of a duration's value.

Functions

Link copied to clipboard
open override fun abs(): Duration

Returns a new instance with the value from this as absolute value.

Link copied to clipboard
open operator override fun compareTo(other: Duration): Int
Link copied to clipboard
open operator override fun div(divisor: Double): Duration
open operator override fun div(divisor: Int): Duration

Returns a new instance with the value from this divided by divisor.

Link copied to clipboard
fun inMilliseconds(): Double

Expresses the duration's value in milliseconds.

Link copied to clipboard
fun inSeconds(): Double

Expresses the duration's value in seconds.

Link copied to clipboard
fun inWholeMilliseconds(): Long

Expresses the duration's value in milliseconds rounded down.

Link copied to clipboard
fun inWholeSeconds(): Long

Expresses the duration's value in seconds rounded down.

Link copied to clipboard
open operator override fun minus(other: Duration): Duration

Returns a new instance that has other's value subtracted from this.

Link copied to clipboard
open operator override fun plus(other: Duration): Duration

Returns a new instance with a value equal to the sum of values from this and other.

Link copied to clipboard
open operator override fun times(factor: Double): Duration
open operator override fun times(factor: Int): Duration

Returns a new instance with the value from this multiplied by factor.

Link copied to clipboard
open override fun toDouble(unit: Duration.Unit): Double

Expresses the value of this under the given unit as a Double.

Link copied to clipboard
open override fun toLong(unit: Duration.Unit): Long

Expresses the value of this under the given unit as a Long.

Link copied to clipboard
open override fun toString(unit: Duration.Unit, decimals: Int, suffixMode: Quantity.SuffixMode, decimalsMode: Quantity.DecimalsMode): String

Returns a string representation for the value from this with the given unit. Depending on decimalsMode, it will show either exactly or at most decimals amount of decimals after the separator. The unit will be suffixed depending on suffixMode.

Link copied to clipboard
open operator override fun unaryMinus(): Duration

Returns a new instance with the value from this as negative.

Inherited functions

Link copied to clipboard
abstract fun describeContents(): Int
Link copied to clipboard
abstract fun writeToParcel(p0: Parcel, p1: Int)