core / io.islandtime / OffsetTime

OffsetTime

(iosArm64, iosX64, jvm, macosX64) class OffsetTime

A time of day with an offset from UTC.

Constructors

(iosArm64, iosX64, jvm, macosX64)

<init>

Create an OffsetTime.

<init>(hour: Int, minute: Int, second: Int = 0, nanosecond: Int = 0, offset: UtcOffset)

A time of day with an offset from UTC.

<init>(time: Time, offset: UtcOffset)

Properties

(iosArm64, iosX64, jvm, macosX64)

hour

The hour of the day.

val hour: Int
(iosArm64, iosX64, jvm, macosX64)

minute

The minute of the hour.

val minute: Int
(iosArm64, iosX64, jvm, macosX64)

nanosecond

The nanosecond of the second.

val nanosecond: Int
(iosArm64, iosX64, jvm, macosX64)

nanosecondsSinceStartOfUtcDay

The number of nanoseconds since the start of the day, but normalized to a UTC offset of zero, allowing OffsetTime objects with different offsets to be compared.

val nanosecondsSinceStartOfUtcDay: LongNanoseconds
(iosArm64, iosX64, jvm, macosX64)

offset

The offset from UTC.

val offset: UtcOffset
(iosArm64, iosX64, jvm, macosX64)

second

The second of the minute.

val second: Int
(iosArm64, iosX64, jvm, macosX64)

time

The time of day.

val time: Time

Functions

(iosArm64, iosX64, jvm, macosX64)

adjustedTo

Return an OffsetTime with the offset changed to newOffset, adjusting the time component such that the instant remains the same.

fun adjustedTo(newOffset: UtcOffset): OffsetTime
(iosArm64, iosX64, jvm, macosX64)

compareTo

Compare to another OffsetTime based on timeline order, ignoring offset differences.

operator fun compareTo(other: OffsetTime): Int
(iosArm64, iosX64, jvm, macosX64)

copy

Return a copy of this OffsetTime, replacing individual components with new values as desired.

fun copy(time: Time = this.time, offset: UtcOffset = this.offset): OffsetTime
fun copy(hour: Int = this.hour, minute: Int = this.minute, second: Int = this.second, nanosecond: Int = this.nanosecond, offset: UtcOffset = this.offset): OffsetTime
(iosArm64, iosX64, jvm, macosX64)

equals

fun equals(other: Any?): Boolean
(iosArm64, iosX64, jvm, macosX64)

hashCode

fun hashCode(): Int
(iosArm64, iosX64, jvm, macosX64)

minus

operator fun minus(duration: Duration): OffsetTime
operator fun minus(hours: LongHours): OffsetTime
operator fun minus(hours: IntHours): OffsetTime
operator fun minus(minutes: LongMinutes): OffsetTime
operator fun minus(minutes: IntMinutes): OffsetTime
operator fun minus(seconds: LongSeconds): OffsetTime
operator fun minus(seconds: IntSeconds): OffsetTime
operator fun minus(milliseconds: LongMilliseconds): OffsetTime
operator fun minus(milliseconds: IntMilliseconds): OffsetTime
operator fun minus(microseconds: LongMicroseconds): OffsetTime
operator fun minus(microseconds: IntMicroseconds): OffsetTime
operator fun minus(nanoseconds: LongNanoseconds): OffsetTime
operator fun minus(nanoseconds: IntNanoseconds): OffsetTime
(iosArm64, iosX64, jvm, macosX64)

plus

operator fun plus(duration: Duration): OffsetTime
operator fun plus(hours: LongHours): OffsetTime
operator fun plus(hours: IntHours): OffsetTime
operator fun plus(minutes: LongMinutes): OffsetTime
operator fun plus(minutes: IntMinutes): OffsetTime
operator fun plus(seconds: LongSeconds): OffsetTime
operator fun plus(seconds: IntSeconds): OffsetTime
operator fun plus(milliseconds: LongMilliseconds): OffsetTime
operator fun plus(milliseconds: IntMilliseconds): OffsetTime
operator fun plus(microseconds: LongMicroseconds): OffsetTime
operator fun plus(microseconds: IntMicroseconds): OffsetTime
operator fun plus(nanoseconds: LongNanoseconds): OffsetTime
operator fun plus(nanoseconds: IntNanoseconds): OffsetTime
(iosArm64, iosX64, jvm, macosX64)

toString

fun toString(): String

Companion Object Properties

DEFAULT_SORT_ORDER

Compare by UTC equivalent instant, then time. Using this Comparator guarantees a deterministic order when sorting.

(iosArm64, iosX64, macosX64) val DEFAULT_SORT_ORDER: <ERROR CLASS>
(jvm) val DEFAULT_SORT_ORDER: Comparator<OffsetTime>
(iosArm64, iosX64, jvm, macosX64)

MAX

The largest allowed OffsetTime -- 23:59:59.999999999-18:00.

val MAX: OffsetTime
(iosArm64, iosX64, jvm, macosX64)

MIN

The smallest allowed OffsetTime -- 00:00+18:00.

val MIN: OffsetTime

TIMELINE_ORDER

Compare by timeline order only, ignoring any offset differences.

(iosArm64, iosX64, macosX64) val TIMELINE_ORDER: <ERROR CLASS>
(jvm) val TIMELINE_ORDER: Comparator<OffsetTime>

Extension Functions

(jvm)

toJavaOffsetTime

fun OffsetTime.toJavaOffsetTime(): OffsetTime