kotlinx-datetime/kotlinx.datetime/LocalTime

LocalTime

@Serializable(with = LocalTimeIso8601Serializer::class)

actual class LocalTime(hour: Int, minute: Int, second: Int, nanosecond: Int) : Comparable<LocalTime> (source)

@Serializable(with = LocalTimeIso8601Serializer::class)

expect class LocalTime(hour: Int, minute: Int, second: Int = 0, nanosecond: Int = 0) : Comparable<LocalTime> (source)

This class represents time-of-day without a referencing a specific date. To reconstruct a full LocalDateTime, representing civil date and time, LocalTime needs to be combined with LocalDate via LocalDate.atTime or LocalTime.atDate.

Also, LocalTime does not reference a particular time zone. Therefore, even on the same date, LocalTime denotes different moments of time. For example, 18:43 happens at different moments in Berlin and in Tokyo.

The arithmetic on LocalTime values is not provided, since without accounting for the time zone transitions it may give misleading results.

@Serializable(with = LocalTimeIso8601Serializer::class)

actual class LocalTime(hour: Int, minute: Int, second: Int, nanosecond: Int) : Comparable<LocalTime> (source)

@Serializable(with = LocalTimeIso8601Serializer::class)

actual class LocalTime(val hour: Int, val minute: Int, val second: Int, val nanosecond: Int) : Comparable<LocalTime> (source)

Constructors

LocalTime

actual constructor(hour: Int, minute: Int, second: Int, nanosecond: Int)

expect constructor(hour: Int, minute: Int, second: Int = 0, nanosecond: Int = 0)

Constructs a LocalTime instance from the given time components.

actual constructor(hour: Int, minute: Int, second: Int, nanosecond: Int)

Types

Companion

actual object Companion

expect object Companion

actual object Companion

Formats

actual object Formats

expect object Formats

A collection of predefined formats for parsing and formatting LocalDateTime values.

actual object Formats

Properties

hour

actual val hour: Int

expect val hour: Int

Returns the hour-of-day time component of this time value.

actual val hour: Int

minute

actual val minute: Int

expect val minute: Int

Returns the minute-of-hour time component of this time value.

actual val minute: Int

nanosecond

actual val nanosecond: Int

expect val nanosecond: Int

Returns the nanosecond-of-second time component of this time value.

actual val nanosecond: Int

second

actual val second: Int

expect val second: Int

Returns the second-of-minute time component of this time value.

actual val second: Int

Functions

atDate

fun LocalTime.atDate(date: LocalDate): LocalDateTime

Combines this time's components with the specified LocalDate components into a LocalDateTime value.

fun LocalTime.atDate(year: Int, monthNumber: Int, dayOfMonth: Int = 0): LocalDateTime

fun LocalTime.atDate(year: Int, month: Month, dayOfMonth: Int = 0): LocalDateTime

Combines this time's components with the specified date components into a LocalDateTime value.

compareTo

actual open operator override fun compareTo(other: LocalTime): Int

expect open operator override fun compareTo(other: LocalTime): Int

Compares this time value with the other time value. Returns zero if this value is equal to the other, a negative number if this value occurs earlier in the course of a typical day than the other, and a positive number if this value occurs later in the course of a typical day than the other.

actual open operator override fun compareTo(other: LocalTime): Int