Hours

value class Hours(value: Long) : Comparable<Hours>

Constructors

Hours
Link copied to clipboard
common
fun Hours(value: Int)

Types

Companion
Link copied to clipboard
common
object Companion

Functions

compareTo
Link copied to clipboard
common
open operator override fun compareTo(other: Hours): Int
div
Link copied to clipboard
common
operator fun div(scalar: Int): Hours
operator fun div(scalar: Long): Hours

Returns this duration divided by a scalar value. @throws ArithmeticException if overflow occurs or the scalar is zero

minus
Link copied to clipboard
common
operator fun minus(days: Days): Hours
operator fun minus(hours: Hours): Hours
operator fun minus(microseconds: Microseconds): Microseconds
operator fun minus(milliseconds: Milliseconds): Milliseconds
operator fun minus(minutes: Minutes): Minutes
operator fun minus(nanoseconds: Nanoseconds): Nanoseconds
operator fun minus(seconds: Seconds): Seconds
plus
Link copied to clipboard
common
operator fun plus(days: Days): Hours
operator fun plus(hours: Hours): Hours
operator fun plus(microseconds: Microseconds): Microseconds
operator fun plus(milliseconds: Milliseconds): Milliseconds
operator fun plus(minutes: Minutes): Minutes
operator fun plus(nanoseconds: Nanoseconds): Nanoseconds
operator fun plus(seconds: Seconds): Seconds
rem
Link copied to clipboard
common
operator fun rem(scalar: Int): Hours
operator fun rem(scalar: Long): Hours

Returns the remainder of this duration divided by a scalar value.

times
Link copied to clipboard
common
operator fun times(scalar: Int): Hours
operator fun times(scalar: Long): Hours

Multiplies this duration by a scalar value. @throws ArithmeticException if overflow occurs

toComponents
Link copied to clipboard
common
inline fun <T> toComponents(action: (days: Days, hours: Hours) -> T): T
toComponentValues
Link copied to clipboard
common
inline fun <T> toComponentValues(action: (days: Long, hours: Int) -> T): T
toDouble
Link copied to clipboard
common
fun toDouble(): Double

Converts this duration to a Double value.

toInt
Link copied to clipboard
common
fun toInt(): Int

Converts this duration to an Int value. @throws ArithmeticException if overflow occurs

toKotlinDuration
Link copied to clipboard
common
fun toKotlinDuration(): Duration

Converts this duration to a kotlin.time.Duration.

toLong
Link copied to clipboard
common
fun toLong(): Long

Converts this duration to a Long value.

toString
Link copied to clipboard
common
open override fun toString(): String

Converts this duration to an ISO-8601 time interval representation.

unaryMinus
Link copied to clipboard
common
operator fun unaryMinus(): Hours

Negates this duration. @throws ArithmeticException if overflow occurs

Properties

absoluteValue
Link copied to clipboard
common
val absoluteValue: Hours

The absolute value of this duration. @throws ArithmeticException if overflow occurs

inMicroseconds
Link copied to clipboard
common
val inMicroseconds: Microseconds

Converts this duration to microseconds. @throws ArithmeticException if overflow occurs

inMilliseconds
Link copied to clipboard
common
val inMilliseconds: Milliseconds

Converts this duration to milliseconds. @throws ArithmeticException if overflow occurs

inMinutes
Link copied to clipboard
common
val inMinutes: Minutes

Converts this duration to minutes. @throws ArithmeticException if overflow occurs

inNanoseconds
Link copied to clipboard
common
val inNanoseconds: Nanoseconds

Converts this duration to nanoseconds. @throws ArithmeticException if overflow occurs

inSeconds
Link copied to clipboard
common
val inSeconds: Seconds

Converts this duration to seconds. @throws ArithmeticException if overflow occurs

inWholeDays
Link copied to clipboard
common
val inWholeDays: Days

Converts this duration to the number of whole days.

value
Link copied to clipboard
common
val value: Long

The underlying value.

Extensions

asDuration
Link copied to clipboard
common
fun Hours.asDuration(): Duration
asUtcOffset
Link copied to clipboard
common
fun Hours.asUtcOffset(): UtcOffset

Converts a duration of hours into a UtcOffset of the same length.

toJavaDuration
Link copied to clipboard
fun Hours.toJavaDuration(): Duration

Converts this duration to an equivalent Java Duration.

toNSTimeInterval
Link copied to clipboard
darwin
fun Hours.toNSTimeInterval(): <ERROR CLASS>

Converts this duration to an equivalent NSTimeInterval.