Продолжительность

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

inline class Duration : Comparable<Duration>

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

Отрицательная продолжительность возможна в ситуации, когда второй момент времени предшествует первому.

Тип может хранить значения продолжительности до ±146 лет с наносекундной точностью и до ±146 миллионов лет с миллисекундной точностью. Если операция, возвращающая продолжительность, предоставленная в kotlin.time, генерирует значение продолжительности, которое не укладывается в указанный диапазон, возвращаемое Duration является бесконечным.

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

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

Для получения значения этой продолжительности, выраженной в определенных единицах измерения времени, используйте функции toInt, toLong, и toDouble или свойства inWholeHours, inWholeMinutes, inWholeSeconds, inWholeNanoseconds и т.д.

Свойства

Требования к платформе и версии: 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)

inWholeDays

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

val inWholeDays: Long

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

inWholeHours

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

val inWholeHours: Long

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

inWholeMicroseconds

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

val inWholeMicroseconds: Long

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

inWholeMilliseconds

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

val inWholeMilliseconds: Long

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

inWholeMinutes

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

val inWholeMinutes: Long

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

inWholeNanoseconds

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

val inWholeNanoseconds: Long

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

inWholeSeconds

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

val inWholeSeconds: Long

Функции

Требования к платформе и версии: 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

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

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

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

operator fun minus(other: Duration): Duration

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

plus

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

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: Long, hours: Int, minutes: Int, seconds: Int, nanoseconds: Int) -> T
): T

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

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

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

fun <T> toComponents(
    action: (minutes: Long, 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

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

fun toLongMilliseconds(): Long

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

toLongNanoseconds

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

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)

дни

Возвращает Duration, равный числу дней, заданному этим значением Int.

val Int.days: <ERROR CLASS>

Возвращает Duration, равный числу дней, заданному этим значением Long.

val Long.days: <ERROR CLASS>

Возвращает Duration, равный числу дней, заданному этим значением Double.

val Double.days: <ERROR CLASS>

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

часы

Возвращает Duration, равный числу часов, заданному этим значением Int.

val Int.hours: <ERROR CLASS>

Возвращает Duration, равный числу часов, заданному этим значением Long.

val Long.hours: <ERROR CLASS>

Возвращает Duration, равный числу часов, заданному этим значением Double.

val Double.hours: <ERROR CLASS>

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

БЕСКОНЕЧНО

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

val INFINITE: Duration

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

микросекунды

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

val Int.microseconds: <ERROR CLASS>

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

val Long.microseconds: <ERROR CLASS>

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

val Double.microseconds: <ERROR CLASS>

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

миллисекунды

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

val Int.milliseconds: <ERROR CLASS>

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

val Long.milliseconds: <ERROR CLASS>

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

val Double.milliseconds: <ERROR CLASS>

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

минуты

Возвращает Duration, равный числу минут, заданному этим значением Int.

val Int.minutes: <ERROR CLASS>

Возвращает Duration, равный числу минут, заданному этим значением Long.

val Long.minutes: <ERROR CLASS>

Возвращает Duration, равный числу минут, заданному этим значением Double.

val Double.minutes: <ERROR CLASS>

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

наносекунды

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

val Int.nanoseconds: <ERROR CLASS>

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

val Long.nanoseconds: <ERROR CLASS>

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

val Double.nanoseconds: <ERROR CLASS>

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

секунды

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

val Int.seconds: <ERROR CLASS>

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

val Long.seconds: <ERROR CLASS>

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

val Double.seconds: <ERROR CLASS>

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

НОЛЬ

Длительность, равная ровно 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.5), JS (1.5), Native (1.5)

days

Возвращает Duration, представляющий указанное количество значение дней.

fun days(value: Int): Duration

fun days(value: Long): Duration

fun days(value: Double): Duration

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

hours

Возвращает Duration, представляющий указанное количество значение часов.

fun hours(value: Int): Duration

fun hours(value: Long): Duration

fun hours(value: Double): Duration

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

microseconds

Возвращает Duration, представляющий указанное количество значение микросекунд.

fun microseconds(value: Int): Duration

fun microseconds(value: Long): Duration

fun microseconds(value: Double): Duration

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

milliseconds

Возвращает Duration, представляющий указанное количество значение миллисекунд.

fun milliseconds(value: Int): Duration

fun milliseconds(value: Long): Duration

fun milliseconds(value: Double): Duration

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

minutes

Возвращает Duration, представляющий указанное количество значение минут.

fun minutes(value: Int): Duration

fun minutes(value: Long): Duration

fun minutes(value: Double): Duration

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

nanoseconds

Возвращает Duration, представляющий указанное количество значение наносекунд.

fun nanoseconds(value: Int): Duration

fun nanoseconds(value: Long): Duration

fun nanoseconds(value: Double): Duration

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

parse

Парсит строку, представляющую длительность, и возвращает значение Duration.

fun parse(value: String): Duration

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

parseIsoString

Парсит строку, представляющую длительность в ограниченном формате ISO-8601 и возвращает значение Duration. Композиционный формат — это расширенный вариант формата ISO-8601 длительности, который поддерживает отрицательные длительности и отрицательные значения отдельных компонентов.

fun parseIsoString(value: String): Duration

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

parseIsoStringOrNull

Парсит строку, представляющую длительность в ограниченном формате ISO-8601, и возвращает значение Duration или null , если строка не представляет длительность в формате, допустимом для parseIsoString.

fun parseIsoStringOrNull(value: String): Duration?

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

parseOrNull

Парсит строку, представляющую длительность, и возвращает значение Duration, или null , если строка не представляет длительность в поддерживаемом формате.

fun parseOrNull(value: String): Duration?

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

seconds

Возвращает Duration, представляющий указанное количество значение секунд.

fun seconds(value: Int): Duration

fun seconds(value: Long): Duration

fun seconds(value: Double): Duration

Функции расширения

Требования к платформе и версии: 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

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

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.6), JS (1.6), Native (1.6)

compareTo

Сравнивает этот объект с указанным объектом для определения порядка. Возвращает ноль, если этот объект равен указанному другому объекту, отрицательное число, если он меньше другого, или положительное число, если он больше другого.

infix fun <T> Comparable<T>.compareTo(other: T): Int

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

rangeTo

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

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

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

rangeUntil

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

operator fun <T : Comparable<T>> T.rangeUntil(
    that: T
): OpenEndRange<T>

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

toJavaDuration

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

fun Duration.toJavaDuration(): Duration

© 2010–2023 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/