kotlinx-datetime/kotlinx.datetime/LocalDate

LocalDate

@Serializable(with = LocalDateIso8601Serializer::class)

actual class LocalDate(year: Int, monthNumber: Int, dayOfMonth: Int) : Comparable<LocalDate> (source)

@Serializable(with = LocalDateIso8601Serializer::class)

expect class LocalDate(year: Int, monthNumber: Int, dayOfMonth: Int) : Comparable<LocalDate> (source)

This class represents dates without a reference to a particular time zone. As such, these objects may denote different spans of time in different time zones: for someone in Berlin, 2020-08-30 started and ended at different moments from those for someone in Tokyo.

The arithmetic on LocalDate values is defined independently of the time zone (so 2020-08-30 plus one day is 2020-08-31 everywhere): see various LocalDate.plus and LocalDate.minus functions, as well as LocalDate.periodUntil and various other *until functions.

@Serializable(with = LocalDateIso8601Serializer::class)

actual class LocalDate(year: Int, monthNumber: Int, dayOfMonth: Int) : Comparable<LocalDate> (source)

@Serializable(with = LocalDateIso8601Serializer::class)

actual class LocalDate(val year: Int, val monthNumber: Int, val dayOfMonth: Int) : Comparable<LocalDate> (source)

Constructors

LocalDate

actual constructor(year: Int, monthNumber: Int, dayOfMonth: Int)

actual constructor(year: Int, month: Month, dayOfMonth: Int)

expect constructor(year: Int, monthNumber: Int, dayOfMonth: Int)

Constructs a LocalDate instance from the given date components.

expect constructor(year: Int, month: Month, dayOfMonth: Int)

Constructs a LocalDate instance from the given date components.

actual constructor(year: Int, monthNumber: Int, dayOfMonth: Int)

actual constructor(year: Int, month: Month, dayOfMonth: 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 LocalDate values.

actual object Formats

Properties

dayOfMonth

actual val dayOfMonth: Int

expect val dayOfMonth: Int

Returns the day-of-month component of the date.

actual val dayOfMonth: Int

dayOfWeek

actual val dayOfWeek: DayOfWeek

expect val dayOfWeek: DayOfWeek

Returns the day-of-week component of the date.

actual val dayOfWeek: DayOfWeek

dayOfYear

actual val dayOfYear: Int

expect val dayOfYear: Int

Returns the day-of-year component of the date.

actual val dayOfYear: Int

month

actual val month: Month

expect val month: Month

Returns the month (Month) component of the date.

actual val month: Month

monthNumber

actual val monthNumber: Int

expect val monthNumber: Int

Returns the number-of-month (1..12) component of the date.

actual val monthNumber: Int

year

actual val year: Int

expect val year: Int

Returns the year component of the date.

actual val year: Int

Functions

atStartOfDayIn

actual fun LocalDate.atStartOfDayIn(timeZone: TimeZone): Instant

expect fun LocalDate.atStartOfDayIn(timeZone: TimeZone): Instant

Returns an instant that corresponds to the start of this date in the specified timeZone.

actual fun LocalDate.atStartOfDayIn(timeZone: TimeZone): Instant

atTime

fun LocalDate.atTime(time: LocalTime): LocalDateTime

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

fun LocalDate.atTime(hour: Int, minute: Int, second: Int = 0, nanosecond: Int = 0): LocalDateTime

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

compareTo

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

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

Compares this date with the other date. Returns zero if this date represent the same day as the other (i.e. equal to other), a negative number if this date is earlier than the other, and a positive number if this date is later than the other.

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

daysUntil

actual fun LocalDate.daysUntil(other: LocalDate): Int

expect fun LocalDate.daysUntil(other: LocalDate): Int

Returns the number of whole days between two dates.

actual fun LocalDate.daysUntil(other: LocalDate): Int

equals

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

format

fun LocalDate.format(format: DateTimeFormat<LocalDate>): String

Formats this value using the given format. Equivalent to calling DateTimeFormat.format on format with this.

hashCode

open override fun hashCode(): Int

minus

actual fun LocalDate.minus(value: Int, unit: DateTimeUnit.DateBased): LocalDate

operator fun LocalDate.minus(period: DatePeriod): LocalDate

Returns a date that is the result of subtracting components of DatePeriod from this date. The components are subtracted in the order from the largest units to the smallest, i.e. from years to days.

operator fun LocalDate.minus(other: LocalDate): DatePeriod

Returns a DatePeriod representing the difference between other and this dates.

expect fun LocalDate.minus(value: Int, unit: DateTimeUnit.DateBased): LocalDate

fun LocalDate.minus(value: Long, unit: DateTimeUnit.DateBased): LocalDate

Returns a LocalDate that is the result of subtracting the value number of the specified unit from this date.

actual fun LocalDate.minus(value: Int, unit: DateTimeUnit.DateBased): LocalDate

monthsUntil

actual fun LocalDate.monthsUntil(other: LocalDate): Int

expect fun LocalDate.monthsUntil(other: LocalDate): Int

Returns the number of whole months between two dates.

actual fun LocalDate.monthsUntil(other: LocalDate): Int

periodUntil

actual fun LocalDate.periodUntil(other: LocalDate): DatePeriod

expect fun LocalDate.periodUntil(other: LocalDate): DatePeriod

Returns a DatePeriod representing the difference between this and other dates.

actual fun LocalDate.periodUntil(other: LocalDate): DatePeriod

plus

actual operator fun LocalDate.plus(period: DatePeriod): LocalDate

actual fun LocalDate.plus(value: Int, unit: DateTimeUnit.DateBased): LocalDate

actual fun LocalDate.plus(value: Long, unit: DateTimeUnit.DateBased): LocalDate

expect operator fun LocalDate.plus(period: DatePeriod): LocalDate

Returns a date that is the result of adding components of DatePeriod to this date. The components are added in the order from the largest units to the smallest, i.e. from years to days.