UtcOffset

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

The time shift between a local time and UTC.

Parameters

totalSeconds

the total number of seconds to offset by

Throws

io.islandtime.DateTimeException

if the offset is outside the supported range

Constructors

UtcOffset

common

fun UtcOffset(totalSeconds: IntSeconds)

the total number of seconds to offset by

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

fun isZero(): Boolean

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

toComponents

common

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

Breaks a UTC offset down into components.

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

Breaks a UTC offset down into components.

toString

common

open override fun toString(): String

Converts this offset to a string in ISO-8601 extended format.

Properties

totalSeconds

common

val totalSeconds: IntSeconds

The number of seconds relative to UTC.

Extensions

asTimeZone

common

fun UtcOffset.asTimeZone(): TimeZone

Converts this UtcOffset into a fixed-offset TimeZone.

toJavaZoneOffset

jvm

fun UtcOffset.toJavaZoneOffset(): ZoneOffset

Converts this UTC offset to an equivalent Java ZoneOffset.

toNSTimeZone

darwin

fun UtcOffset.toNSTimeZone(): <ERROR CLASS>

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