UtcOffset

The time shift between a local time and UTC.

To ensure that the offset is within the valid supported range, you must explicitly call validate or validated.

inline class UtcOffset(totalSeconds: IntSeconds) : Comparable<UtcOffset>

Parameters

totalSeconds

the total number of seconds to offset by

Constructors

UtcOffset

common

the total number of seconds to offset by

fun UtcOffset(totalSeconds: IntSeconds)

Types

Companion

common

object Companion

Functions

compareTo

common

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

equals

common

open operator override fun equals(other: Any?): Boolean

hashCode

common

open override fun hashCode(): Int

isZero

common

Checks if this is the UTC offset of +00:00.

fun isZero(): Boolean

toComponents

common

Breaks a UTC offset down into components. The sign will indicate whether the offset is positive or negative while each component will be positive.

inline fun <T> toComponents(action: (Int, IntHours, IntMinutes, IntSeconds) -> T): T

Breaks a UTC offset down into components. If the offset is negative, each component will be negative.

inline fun <T> toComponents(action: (IntHours, IntMinutes, IntSeconds) -> T): T

toString

common

Converts this offset to a string in ISO-8601 extended format. For example, -04:00 or Z.

open override fun toString(): String

validate

common

Checks if the offset is valid and throws an exception if it isn't.

fun validate()

validated

common

Ensures that the offset is valid, throwing an exception if it isn't.

fun validated(): UtcOffset

Properties

isValid

common

Checks if this offset is within the supported range.

val isValid: Boolean

totalSeconds

common

the total number of seconds to offset by

val totalSeconds: IntSeconds

Extensions

asTimeZone

common

Converts this UtcOffset into a fixed-offset TimeZone.

fun UtcOffset.asTimeZone(): TimeZone

toJavaZoneOffset

jvm

Converts this UTC offset to an equivalent Java ZoneOffset.

fun UtcOffset.toJavaZoneOffset(): ZoneOffset

toNSTimeZone

darwin

Converts this offset into an equivalent NSTimeZone with a fixed UTC offset.

Note that NSTimeZonewill round the totalSeconds value to the nearest minute.

fun UtcOffset.toNSTimeZone(): <ERROR CLASS>

UtcOffset

See also

Parameters

Constructors

Types

Functions

Properties

Extensions