Spec-Zone.ru › Kotlin 2

Duration

kotlin-stdlib/kotlin.time/Duration

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

@JvmInline
value 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 и другие.

Типы

Companion

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

object Companion

Свойства

absoluteValue

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

val absoluteValue: Duration

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

inWholeDays

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

val inWholeDays: Long

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

inWholeHours

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

val inWholeHours: Long

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

inWholeMicroseconds

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

val inWholeMicroseconds: Long

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

inWholeMilliseconds

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

val inWholeMilliseconds: Long

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

inWholeMinutes

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

val inWholeMinutes: Long

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

inWholeNanoseconds

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

val inWholeNanoseconds: Long

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

inWholeSeconds

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

val inWholeSeconds: Long

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

Функции

compareTo

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

open operator override fun compareTo(other: Duration): Int

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

compareTo

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

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

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

div

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

operator fun div(scale: Double): Duration
operator fun div(scale: Int): Duration

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

operator fun div(other: Duration): Double

Возвращает число, равное отношению значений этой и other длительности.

isFinite

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

fun isFinite(): Boolean

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

isInfinite

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

fun isInfinite(): Boolean

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

isNegative

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

fun isNegative(): Boolean

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

isPositive

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

fun isPositive(): Boolean

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

minus

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

operator fun minus(other: Duration): Duration

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

plus

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

operator fun plus(other: Duration): Duration

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

times

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

operator fun times(scale: Double): Duration
operator fun times(scale: Int): Duration

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

toComponents

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

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

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

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

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

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

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

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

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

toDouble

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

fun toDouble(unit: DurationUnit): Double

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

toInt

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

fun toInt(unit: DurationUnit): Int

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

toIsoString

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

fun toIsoString(): String

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

toJavaDuration

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

inline fun Duration.toJavaDuration(): Duration

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

toLong

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

fun toLong(unit: DurationUnit): Long

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

toString

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

open override fun toString(): String

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

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

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

unaryMinus

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

operator fun unaryMinus(): Duration

Возвращает значение, противоположное этому значению.

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

Spec-Zone.ru

Настройки Оффлайн Что нового Помощь О нас
Spec-Zone .ru
спецификации, руководства, описания, API