Skip to content

//core/io.islandtime.measures/Hours

Hours

common

@JvmInline

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

Constructors

Hours

common

constructor(value: Int)

constructor(value: Long)

Types

Name Summary
Companion

common


object Companion

Properties

Name Summary
absoluteValue

common


val absoluteValue: Hours

The absolute value of this duration.
inMicroseconds

common


val inMicroseconds: Microseconds

Converts this duration to microseconds.
inMilliseconds

common


val inMilliseconds: Milliseconds

Converts this duration to milliseconds.
inMinutes

common


val inMinutes: Minutes

Converts this duration to minutes.
inNanoseconds

common


val inNanoseconds: Nanoseconds

Converts this duration to nanoseconds.
inSeconds

common


val inSeconds: Seconds

Converts this duration to seconds.
inWholeDays

common


val inWholeDays: Days

Converts this duration to the number of whole days.
value

common


val value: Long

The underlying value.

Functions

Name Summary
asDuration

common


fun Hours.asDuration(): Duration
asUtcOffset

common


fun Hours.asUtcOffset(): UtcOffset

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

common


open operator override fun compareTo(other: Hours): Int
div

common


operator fun div(scalar: Int): Hours

operator fun div(scalar: Long): Hours

Returns this duration divided by a scalar value.
minus

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

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

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

common


operator fun times(scalar: Int): Hours

operator fun times(scalar: Long): Hours

Multiplies this duration by a scalar value.
toComponents

common


inline fun <T> toComponents(action: (days: Days, hours: Hours) -> T): T
toComponentValues

common


inline fun <T> toComponentValues(action: (days: Long, hours: Int) -> T): T
toDouble

common


fun toDouble(): Double

Converts this duration to a Double value.
toInt

common


fun toInt(): Int

Converts this duration to an Int value.
toJavaDuration

jvm


fun Hours.toJavaDuration(): Duration

Converts this duration to an equivalent Java Duration.
toKotlinDuration

common


fun toKotlinDuration(): Duration

Converts this duration to a kotlin.time.Duration.
toLong

common


fun toLong(): Long

Converts this duration to a Long value.
toNSTimeInterval

darwin


fun Hours.toNSTimeInterval(): <Error class: unknown class>

Converts this duration to an equivalent NSTimeInterval.
toString

common


open override fun toString(): String

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

common


operator fun unaryMinus(): Hours

Negates this duration.