Длительность

Требования к платформе и версии: JVM (1.3), JS (1.3), Native (1.3)

@ExperimentalTime inline class Duration : 
    Comparable<Duration>

Представляет количество времени между двумя моментами времени.

Отрицательная длительность возможна в ситуации, когда второй момент времени предшествует первому. Значение бесконечной длительности Duration.INFINITE может использоваться для представления бесконечных таймаутов.

Для создания длительности используйте функцию-расширение toDuration или свойства-расширения hours, minutes, seconds и так далее, доступные для числовых типов Int, Long и Double.

Для получения значения этой длительности, выраженной в определённых единицах измерения длительности, используйте функции toInt, toLong и toDouble, или свойства inHours, inMinutes, inSeconds, inNanoseconds и так далее.

Свойства

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

absoluteValue

Возвращает абсолютное значение этого значения. Возвращаемое значение всегда неотрицательное.

val absoluteValue: Duration

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

inDays

Значение этой длительности, выраженное как число Double дней.

val inDays: Double

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

inHours

Значение этой длительности, выраженное как число Double часов.

val inHours: Double

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

inMicroseconds

Значение этой длительности, выраженное как число Double микросекунд.

val inMicroseconds: Double

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

inMilliseconds

Значение этой длительности, выраженное как число Double миллисекунд.

val inMilliseconds: Double

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

inMinutes

Значение этой длительности, выраженное как число Double минут.

val inMinutes: Double

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

inNanoseconds

Значение этой длительности, выраженное как число Double наносекунд.

val inNanoseconds: Double

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

inSeconds

Значение этой длительности, выраженное как число Double секунд.

val inSeconds: Double

Функции

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

compareTo

fun compareTo(other: Duration): Int

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

div

Возвращает продолжительность, значение которой равно значению этой продолжительности, делённому на заданное число scale.

operator fun div(scale: Int): Duration

operator fun div(scale: Double): Duration

Возвращает число, которое является отношением значений этой и other продолжительностей.

operator fun div(other: Duration): Double

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

isFinite

Возвращает true, если значение продолжительности конечно.

fun isFinite(): Boolean

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

isInfinite

Возвращает true, если значение продолжительности бесконечно.

fun isInfinite(): Boolean

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

isNegative

Возвращает true, если значение продолжительности меньше нуля.

fun isNegative(): Boolean

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

isPositive

Возвращает true, если значение продолжительности больше нуля.

fun isPositive(): Boolean

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

minus

Возвращает продолжительность, значение которой равно разнице между этой и other продолжительностями.

operator fun minus(other: Duration): Duration

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

plus

Возвращает продолжительность, значение которой равно сумме этой и other продолжительностей.

operator fun plus(other: Duration): Duration

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

times

Возвращает продолжительность, значение которой равно значению этой продолжительности, умноженному на заданное число scale.

operator fun times(scale: Int): Duration

operator fun times(scale: Double): Duration

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toComponents

Разделяет эту продолжительность на дни, часы, минуты, секунды и наносекунды и выполняет заданное действие с этими компонентами. Результат действия возвращается в качестве результата этой функции.

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

Разделяет эту продолжительность на часы, минуты, секунды и наносекунды и выполняет заданное действие с этими компонентами. Результат действия возвращается в качестве результата этой функции.

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

Разделяет эту продолжительность на минуты, секунды и наносекунды и выполняет заданное действие с этими компонентами. Результат действия возвращается в качестве результата этой функции.

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

Разделяет эту продолжительность на секунды и наносекунды и выполняет заданное действие с этими компонентами. Результат действия возвращается в качестве результата этой функции.

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

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toDouble

Возвращает значение этой продолжительности, выраженное как число Double в указанной единице измерения.

fun toDouble(unit: DurationUnit): Double

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toInt

Возвращает значение этой продолжительности, выраженное как число Int в указанной единице измерения.

fun toInt(unit: DurationUnit): Int

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toIsoString

Возвращает строковое представление этой продолжительности в формате ISO-8601.

fun toIsoString(): String

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toLong

Возвращает значение этой продолжительности, выраженное как число Long в указанной единице измерения.

fun toLong(unit: DurationUnit): Long

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toLongMilliseconds

Возвращает значение этого интервала времени, выраженное как целое число миллисекунд.

fun toLongMilliseconds(): Long

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toLongNanoseconds

Возвращает значение этого интервала времени, выраженное как целое число наносекунд.

fun toLongNanoseconds(): Long

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

toString

Возвращает строковое представление значения этого интервала времени, выраженное в единицах измерения, которые дают самое компактное и читаемое числовое значение.

fun toString(): String

Возвращает строковое представление значения этого интервала времени, выраженного в заданных единицах и отформатированного с указанным количеством десятичных знаков после запятой.

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

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

unaryMinus

Возвращает отрицательное значение этого значения.

operator fun unaryMinus(): Duration

Свойства объекта-компаньона

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

INFINITE

Интервал времени, значение которого равно положительной бесконечности. Полезно для представления таймаутов, которые никогда не должны истекать.

val INFINITE: Duration

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

ZERO

Интервал времени, равный ровно 0 секундам.

val ZERO: Duration

Функции объекта-компаньона

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

convert

Преобразует заданный интервал времени значение, выраженное в указанных единицах измерения, в указанные единицы измерения.

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

Расширяющие функции

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

coerceAtLeast

Обеспечивает, что это значение не меньше указанного минимального значения.

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

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

coerceAtMost

Обеспечивает, что это значение не больше указанного максимального значения.

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

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

coerceIn

Обеспечивает, что это значение находится в заданном диапазоне minimumValue..maximumValue.

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

Обеспечивает, что это значение находится в заданном диапазоне.

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

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

Требования к платформе и версии: JVM (1.0), JS (1.0), Native (1.0)

rangeTo

Создаёт диапазон от этого значения Comparable до указанного значения that.

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

Требования к платформе и версии: JVM (1.3), JRE8 (1.3)

toJavaDuration

Преобразует значение kotlin.time.Duration в значение java.time.Duration.

fun Duration.toJavaDuration(): Duration

© 2010–2020 JetBrains s.r.o. and Kotlin Programming Language contributors
Licensed under the Apache License, Version 2.0.
https://kotlinlang.org/api/latest/jvm/stdlib/kotlin.time/-duration/index.html