Date

@JvmInline

value class Date(val encoded: Int) : Comparable<Date> , Serializable

Represents a triple of year, month and day.

It is packed in a value class wrapping an Int to prevent allocations.

Constructors

Date

constructor(encoded: Int)

Types

Companion

object Companion

Properties

dateTimeDayStart

val dateTimeDayStart: DateTime

A DateTime instance representing this date and time from the beginning of the day.

day

val day: Int

The day part.

dayOfWeek

val dayOfWeek: DayOfWeek

The dayOfWeek part.

dayOfWeekInt

val dayOfWeekInt: Int

The dayOfWeek part as Int.

dayOfYear

val dayOfYear: Int

The dayOfYear part.

encoded

val encoded: Int

month

val month: Month

The month part.

month1

val month1: Int

The month part as Int where Month.January is 1.

year

val year: Int

The year part as Int.

yearYear

val yearYear: Year

The year part as Year.

Functions

compareTo

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

format

fun format(format: DateFormat): String

fun format(format: String): String

Converts this date to String using format for representing it.

inThisWeek

fun Date.inThisWeek(dayOfWeek: DayOfWeekWithLocale): Date

fun Date.inThisWeek(dayOfWeek: DayOfWeek, locale: KlockLocale = KlockLocale.default): Date

minus

operator fun Date.minus(time: DateTimeSpan): Date

operator fun Date.minus(time: MonthSpan): Date

operator fun Date.minus(time: Time): DateTime

operator fun Date.minus(time: TimeSpan): Date

plus

operator fun Date.plus(time: DateTimeSpan): Date

operator fun Date.plus(time: MonthSpan): Date

operator fun Date.plus(time: Time): DateTime

operator fun Date.plus(time: TimeSpan): Date

toDateTime

fun Date.toDateTime(): DateTime

toString

open override fun toString(): String

Converts this date to String formatting it like "2020-01-01", "2020-12-31" or "-2020-12-31" if the year is negative