core / io.islandtime / Time

Time

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) class Time : Comparable<Time>

A time of day in an ambiguous region.

Constructors

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

<init>

Creates a Time from its individual components.

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

Properties

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

hour

The hour of the day.

val hour: Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

minute

The minute of the hour.

val minute: Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

nanosecond

The nanosecond of the second.

val nanosecond: Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

nanosecondOfDay

The nanosecond of the day.

val nanosecondOfDay: Long
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

nanosecondsSinceStartOfDay

The number of nanoseconds since the start of the day.

val nanosecondsSinceStartOfDay: LongNanoseconds
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

second

The second of the minute.

val second: Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

secondOfDay

The second of the day.

val secondOfDay: Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

secondsSinceStartOfDay

The number of seconds since the start of the day.

val secondsSinceStartOfDay: IntSeconds

Functions

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

compareTo

fun compareTo(other: Time): Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

component1

operator fun component1(): Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

component2

operator fun component2(): Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

component3

operator fun component3(): Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

component4

operator fun component4(): Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

copy

Returns a copy of this time with the values of any individual components replaced by the new values specified.

fun copy(hour: Int = this.hour, minute: Int = this.minute, second: Int = this.second, nanosecond: Int = this.nanosecond): Time
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

equals

fun equals(other: Any?): Boolean
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

hashCode

fun hashCode(): Int
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

minus

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

plus

operator fun plus(duration: Duration): Time
operator fun plus(hours: LongHours): Time
operator fun plus(hours: IntHours): Time
operator fun plus(minutes: LongMinutes): Time
operator fun plus(minutes: IntMinutes): Time
operator fun plus(seconds: LongSeconds): Time
operator fun plus(seconds: IntSeconds): Time
operator fun plus(milliseconds: LongMilliseconds): Time
operator fun plus(milliseconds: IntMilliseconds): Time
operator fun plus(microseconds: LongMicroseconds): Time
operator fun plus(microseconds: IntMicroseconds): Time
operator fun plus(nanoseconds: LongNanoseconds): Time
operator fun plus(nanoseconds: IntNanoseconds): Time

toString

Converts this time to a string in ISO-8601 extended format. For example, 17:31:45.923452091 or 02:30.

(iosArm64, iosX64, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86) fun toString(): <ERROR CLASS>
(jvm) fun toString(): String

Companion Object Properties

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

MAX

val MAX: Time
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

MIDNIGHT

val MIDNIGHT: Time
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

MIN

val MIN: Time
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

NOON

val NOON: Time

Companion Object Functions

(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

fromNanosecondOfDay

Creates a Time from the nanosecond of the day.

fun fromNanosecondOfDay(nanosecondOfDay: Long): Time
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

fromNanosecondsSinceStartOfDay

Creates the Time at a number of nanoseconds since the start of the day.

fun fromNanosecondsSinceStartOfDay(nanoseconds: LongNanoseconds): Time
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

fromSecondOfDay

Creates a Time from the second of the day and optionally, the number of nanoseconds within that second.

fun fromSecondOfDay(secondOfDay: Int, nanosecond: Int = 0): Time
(iosArm64, iosX64, jvm, macosX64, tvosArm64, tvosX64, watchosArm64, watchosX86)

fromSecondsSinceStartOfDay

Creates the Time at a number of seconds since the start of the day and optionally, a number of additional nanoseconds.

fun fromSecondsSinceStartOfDay(seconds: IntSeconds, nanosecondAdjustment: IntNanoseconds = 0.nanoseconds): Time

Extension Functions

(jvm)

toJavaLocalTime

Convert to an equivalent Java LocalTime.

fun Time.toJavaLocalTime(): LocalTime