base/com.splendo.kaluga.base.utils/KalugaDate

KalugaDate

abstract class KalugaDate : Comparable<KalugaDate>

Class describing a point in time Dates are localized according to a KalugaLocale and relative to a given KalugaTimeZone

Inheritors

DefaultKalugaDate

Constructors

KalugaDate

constructor()

Properties

date

abstract val date: KalugaDateHolder

Reference to the underlying KalugaDateHolder

day

abstract var day: Int

The day of the current month

dayOfYear

abstract var dayOfYear: Int

The day of the current year

daysInMonth

abstract val daysInMonth: Int

The number of days in the current month

durationSinceEpoch

abstract var durationSinceEpoch: Duration

The Duration passed since epoch time (January 1st 1970 00:00:00:00 GMT)

era

abstract var era: Int

The number of the era, e.g., AD or BC in the Julian calendar

firstWeekDay

abstract var firstWeekDay: Int

The first day of the week. E.g. Sunday in the US, Monday in France. Starts at 1.

hour

abstract var hour: Int

The hour of the current day

isLastMonth

val KalugaDate.isLastMonth: Boolean

True if this KalugaDate is last month

isLastYear

val KalugaDate.isLastYear: Boolean

True if this KalugaDate is last year

isNextMonth

val KalugaDate.isNextMonth: Boolean

True if this KalugaDate is next month

isNextYear

val KalugaDate.isNextYear: Boolean

True if this KalugaDate is next year

isThisMonth

val KalugaDate.isThisMonth: Boolean

True if this KalugaDate is this month

isThisYear

val KalugaDate.isThisYear: Boolean

True if this KalugaDate is this year

isToday

val KalugaDate.isToday: Boolean

True if this KalugaDate is today

isTomorrow

val KalugaDate.isTomorrow: Boolean

True if this KalugaDate is tomorrow

isYesterday

val KalugaDate.isYesterday: Boolean

True if this KalugaDate is yesterday

millisecond

abstract var millisecond: Int

The millisecond of the current second

millisecondSinceEpoch

var millisecondSinceEpoch: Long

The number of milliseconds passed since epoch time (January 1st 1970 00:00:00:00 GMT)

minute

abstract var minute: Int

The minute of the current hour

month

abstract var month: Int

The month of the year. Starts at 1

second

abstract var second: Int

The second of the current minute

timeZone

abstract var timeZone: KalugaTimeZone

The KalugaTimeZone in which the Date is set

weekDay

abstract var weekDay: Int

The day of the week. Starts at 1

weekOfMonth

abstract var weekOfMonth: Int

The week number within the current month

weekOfYear

abstract var weekOfYear: Int

The week number within the current year.

year

abstract var year: Int

The year

Functions

compareTo

abstract operator fun compareTo(other: KalugaDate): Int

copy

abstract fun copy(): KalugaDate

Creates a copy of a KalugaDate

equals

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

Returns whether this Date is in the same timeZone and has the same time based on durationSinceEpoch

hashCode

abstract override fun hashCode(): Int

isInSameYear

fun KalugaDate.isInSameYear(date: KalugaDate): Boolean

Checks whether a KalugaDate is in the same year as a given Date.

isOnSameDay

fun KalugaDate.isOnSameDay(date: KalugaDate): Boolean

Checks whether a KalugaDate is on the same day as a given Date.

isOnSameMonth

fun KalugaDate.isOnSameMonth(date: KalugaDate): Boolean

Checks whether a KalugaDate is on the same month as a given Date.

minus

infix operator fun KalugaDate.minus(other: KalugaDate): Duration

Gets the Duration between two KalugaDate

infix operator fun KalugaDate.minus(duration: Duration): KalugaDate

Gets a KalugaDate that is duration before this date.

plus

infix operator fun KalugaDate.plus(duration: Duration): KalugaDate

Gets a KalugaDate that is duration after this date.

toEndOfDay

fun KalugaDate.toEndOfDay(): KalugaDate

Gets a KalugaDate equal to 23:59:59:999 on the same day as this Date

toStartOfDay

fun KalugaDate.toStartOfDay(): KalugaDate

Gets a KalugaDate equal to midnight on the same day as this Date

toString

open override fun toString(): String