Time

class Time(hour: Int, minute: Int, second: Int, nanosecond: Int) : Comparable<Time>

A time of day in an ambiguous region.

Parameters

hour

the hour of day

minute

the minute of the hour

second

the second of the minute

nanosecond

the nanosecond of the second

Throws

io.islandtime.DateTimeException

if the time is invalid

Constructors

Time

common

fun Time(hour: Int, minute: Int, second: Int = 0, nanosecond: Int = 0)

Creates a Time from its individual components.

Types

Companion

common

object Companion

Functions

compareTo

common

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

component1

common

operator fun component1(): Int

component2

common

operator fun component2(): Int

component3

common

operator fun component3(): Int

component4

common

operator fun component4(): Int

copy

common

fun copy(hour: Int = this.hour, minute: Int = this.minute, second: Int = this.second, nanosecond: Int = this.nanosecond): Time

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

equals

common

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

hashCode

common

open override fun hashCode(): Int

minus

common

operator fun minus(duration: Duration): Time

operator fun minus(hours: IntHours): Time

operator fun minus(microseconds: IntMicroseconds): Time

operator fun minus(milliseconds: IntMilliseconds): Time

operator fun minus(minutes: IntMinutes): Time

operator fun minus(nanoseconds: IntNanoseconds): Time

operator fun minus(seconds: IntSeconds): Time

operator fun minus(hours: LongHours): Time

operator fun minus(microseconds: LongMicroseconds): Time

operator fun minus(milliseconds: LongMilliseconds): Time

operator fun minus(minutes: LongMinutes): Time

operator fun minus(nanoseconds: LongNanoseconds): Time

operator fun minus(seconds: LongSeconds): Time

plus

common

operator fun plus(duration: Duration): Time

operator fun plus(hours: IntHours): Time

operator fun plus(microseconds: IntMicroseconds): Time

operator fun plus(milliseconds: IntMilliseconds): Time

operator fun plus(minutes: IntMinutes): Time

operator fun plus(nanoseconds: IntNanoseconds): Time

operator fun plus(seconds: IntSeconds): Time

operator fun plus(hours: LongHours): Time

operator fun plus(microseconds: LongMicroseconds): Time

operator fun plus(milliseconds: LongMilliseconds): Time

operator fun plus(minutes: LongMinutes): Time

operator fun plus(nanoseconds: LongNanoseconds): Time

operator fun plus(seconds: LongSeconds): Time

toString

common

open override fun toString(): String

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

Properties

hour

common

val hour: Int

The hour of the day.

minute

common

val minute: Int

The minute of the hour.

nanosecond

common

val nanosecond: Int = 0

The nanosecond of the second.

nanosecondOfDay

common

val nanosecondOfDay: Long

The nanosecond of the day.

nanosecondsSinceStartOfDay

common

val nanosecondsSinceStartOfDay: LongNanoseconds

The number of nanoseconds since the start of the day.

second

common

val second: Int = 0

The second of the minute.

secondOfDay

common

val secondOfDay: Int

The second of the day.

secondsSinceStartOfDay

common

val secondsSinceStartOfDay: IntSeconds

The number of seconds since the start of the day.

Extensions

common

infix fun Time.at(offset: UtcOffset): OffsetTime

Combines a local time with a UTC offset to create an OffsetTime.

roundedDownTo

common

fun Time.roundedDownTo(unit: TimeUnit): Time

Returns this time, rounded down to match the precision of a given unit.

roundedDownToNearest

common

fun Time.roundedDownToNearest(increment: IntHours): Time

Returns this time, rounded down to the nearest hour that satisfies the increment.

fun Time.roundedDownToNearest(increment: IntMinutes): Time

Returns this time, rounded down to the nearest minute that satisfies the increment.

fun Time.roundedDownToNearest(increment: IntSeconds): Time

Returns this time, rounded down to the nearest second that satisfies the increment.

fun Time.roundedDownToNearest(increment: IntMilliseconds): Time

Returns this time, rounded down to the nearest millisecond that satisfies the increment.

fun Time.roundedDownToNearest(increment: IntMicroseconds): Time

Returns this time, rounded down to the nearest microsecond that satisfies the increment.

fun Time.roundedDownToNearest(increment: IntNanoseconds): Time

Returns this time, rounded down to the nearest nanosecond that satisfies the increment.

roundedTo

common

fun Time.roundedTo(unit: TimeUnit): Time

Returns this time, rounded to match the precision of a given unit.

roundedToNearest

common

fun Time.roundedToNearest(increment: IntHours): Time

Returns this time, rounded to the nearest hour that satisfies the increment.

fun Time.roundedToNearest(increment: IntMinutes): Time

Returns this time, rounded to the nearest minute that satisfies the increment.

fun Time.roundedToNearest(increment: IntSeconds): Time

Returns this time, rounded to the nearest second that satisfies the increment.

fun Time.roundedToNearest(increment: IntMilliseconds): Time

Returns this time, rounded to the nearest millisecond that satisfies the increment.

fun Time.roundedToNearest(increment: IntMicroseconds): Time

Returns this time, rounded to the nearest microsecond that satisfies the increment.

fun Time.roundedToNearest(increment: IntNanoseconds): Time

Returns this time, rounded to the nearest nanosecond that satisfies the increment.

roundedUpTo

common

fun Time.roundedUpTo(unit: TimeUnit): Time

Returns this time, rounded up to match the precision of a given unit.

roundedUpToNearest

common

fun Time.roundedUpToNearest(increment: IntHours): Time

Returns this time, rounded up to the nearest hour that satisfies the increment.

fun Time.roundedUpToNearest(increment: IntMinutes): Time

Returns this time, rounded up to the nearest minute that satisfies the increment.

fun Time.roundedUpToNearest(increment: IntSeconds): Time

Returns this time, rounded up to the nearest second that satisfies the increment.

fun Time.roundedUpToNearest(increment: IntMilliseconds): Time

Returns this time, rounded up to the nearest millisecond that satisfies the increment.

fun Time.roundedUpToNearest(increment: IntMicroseconds): Time

Returns this time, rounded up to the nearest microsecond that satisfies the increment.

fun Time.roundedUpToNearest(increment: IntNanoseconds): Time

Returns this time, rounded up to the nearest nanosecond that satisfies the increment.

toJavaLocalTime

jvm

fun Time.toJavaLocalTime(): LocalTime

Converts this time to an equivalent Java LocalTime.

toNSDateComponents

darwin

fun Time.toNSDateComponents(includeCalendar: Boolean = false): <ERROR CLASS>

Converts this time to an equivalent NSDateComponents object.

truncatedTo

common

fun Time.truncatedTo(unit: TimeUnit): Time

Returns this time, rounded down to match the precision of a given unit.