core / io.islandtime / DateTime

DateTime

(iosArm64, iosX64, jvm, macosX64) class DateTime : Comparable<DateTime>

A date and time of day in an arbitrary region.

Constructors

(iosArm64, iosX64, jvm, macosX64)

<init>

Create a DateTime.

<init>(year: Int, month: Month, day: Int, hour: Int, minute: Int, second: Int = 0, nanosecond: Int = 0)
<init>(year: Int, monthNumber: Int, day: Int, hour: Int, minute: Int, second: Int = 0, nanosecond: Int = 0)

Create a DateTime by combining a Date and Time.

<init>(date: Date, time: Time)

Properties

(iosArm64, iosX64, jvm, macosX64)

date

The date.

val date: Date
(iosArm64, iosX64, jvm, macosX64)

dayOfMonth

The day of the month.

val dayOfMonth: Int
(iosArm64, iosX64, jvm, macosX64)

dayOfWeek

The day of the week.

val dayOfWeek: DayOfWeek
(iosArm64, iosX64, jvm, macosX64)

dayOfYear

The day of the year -- also known as the ordinal date in ISO-8601.

val dayOfYear: Int
(iosArm64, iosX64, jvm, macosX64)

hour

The hour of the day.

val hour: Int
(iosArm64, iosX64, jvm, macosX64)

isInLeapYear

Check if this date falls within a leap year.

val isInLeapYear: Boolean
(iosArm64, iosX64, jvm, macosX64)

isLeapDay

Check if this is a leap day.

val isLeapDay: Boolean
(iosArm64, iosX64, jvm, macosX64)

lengthOfMonth

The length of the date's month in days.

val lengthOfMonth: IntDays
(iosArm64, iosX64, jvm, macosX64)

lengthOfYear

The length of the date's year in days.

val lengthOfYear: IntDays
(iosArm64, iosX64, jvm, macosX64)

minute

The minute of the hour.

val minute: Int
(iosArm64, iosX64, jvm, macosX64)

month

The month of the year.

val month: Month
(iosArm64, iosX64, jvm, macosX64)

monthNumber

The ISO month number, from 1-12.

val monthNumber: Int
(iosArm64, iosX64, jvm, macosX64)

nanoOfSecondsSinceUnixEpoch

Get the number of additional nanoseconds that should be applied on top of the number of seconds since the Unix Epoch returned by secondsSinceUnixEpochAt.

val nanoOfSecondsSinceUnixEpoch: IntNanoseconds
(iosArm64, iosX64, jvm, macosX64)

nanosecond

The nanosecond of the second.

val nanosecond: Int
(iosArm64, iosX64, jvm, macosX64)

second

The second of the minute.

val second: Int
(iosArm64, iosX64, jvm, macosX64)

time

The time of day.

val time: Time
(iosArm64, iosX64, jvm, macosX64)

unixEpochNanoOfSecond

Get the nanosecond of the second of the Unix Epoch.

val unixEpochNanoOfSecond: Int
(iosArm64, iosX64, jvm, macosX64)

year

The year.

val year: Int
(iosArm64, iosX64, jvm, macosX64)

yearMonth

The combined year and month.

val yearMonth: YearMonth

Functions

(iosArm64, iosX64, jvm, macosX64)

compareTo

fun compareTo(other: DateTime): Int
(iosArm64, iosX64, jvm, macosX64)

component1

operator fun component1(): Date
(iosArm64, iosX64, jvm, macosX64)

component2

operator fun component2(): Time
(iosArm64, iosX64, jvm, macosX64)

copy

Return a copy of this DateTime, replacing individual components with new values as desired.

fun copy(date: Date = this.date, time: Time = this.time): DateTime
fun copy(year: Int = this.year, dayOfYear: Int = this.dayOfYear, hour: Int = this.hour, minute: Int = this.minute, second: Int = this.second, nanosecond: Int = this.nanosecond): DateTime
fun copy(year: Int = this.year, month: Month = this.month, dayOfMonth: Int = this.dayOfMonth, hour: Int = this.hour, minute: Int = this.minute, second: Int = this.second, nanosecond: Int = this.nanosecond): DateTime
fun copy(year: Int = this.year, monthNumber: Int, dayOfMonth: Int = this.dayOfMonth, hour: Int = this.hour, minute: Int = this.minute, second: Int = this.second, nanosecond: Int = this.nanosecond): DateTime
(iosArm64, iosX64, jvm, macosX64)

equals

fun equals(other: Any?): Boolean
(iosArm64, iosX64, jvm, macosX64)

hashCode

fun hashCode(): Int
(iosArm64, iosX64, jvm, macosX64)

instantAt

fun instantAt(offset: UtcOffset): Instant
(iosArm64, iosX64, jvm, macosX64)

millisecondsSinceUnixEpochAt

Get the number of milliseconds relative to the Unix epoch of 1970-01-01T00:00Z.

fun millisecondsSinceUnixEpochAt(offset: UtcOffset): LongMilliseconds
(iosArm64, iosX64, jvm, macosX64)

minus

Return a DateTime with period subtracted from it.

operator fun minus(period: Period): DateTimeoperator fun minus(duration: Duration): DateTime
operator fun minus(years: IntYears): DateTime
operator fun minus(years: LongYears): DateTime
operator fun minus(months: IntMonths): DateTime
operator fun minus(months: LongMonths): DateTime
operator fun minus(weeks: IntWeeks): DateTime
operator fun minus(weeks: LongWeeks): DateTime
operator fun minus(days: IntDays): DateTime
operator fun minus(days: LongDays): DateTime
operator fun minus(hours: IntHours): DateTime
operator fun minus(hours: LongHours): DateTime
operator fun minus(minutes: IntMinutes): DateTime
operator fun minus(minutes: LongMinutes): DateTime
operator fun minus(seconds: IntSeconds): DateTime
operator fun minus(seconds: LongSeconds): DateTime
operator fun minus(milliseconds: IntMilliseconds): DateTime
operator fun minus(milliseconds: LongMilliseconds): DateTime
operator fun minus(microseconds: IntMicroseconds): DateTime
operator fun minus(microseconds: LongMicroseconds): DateTime
operator fun minus(nanoseconds: IntNanoseconds): DateTime
operator fun minus(nanoseconds: LongNanoseconds): DateTime
(iosArm64, iosX64, jvm, macosX64)

plus

Return a DateTime with period added to it.

operator fun plus(period: Period): DateTimeoperator fun plus(duration: Duration): DateTime
operator fun plus(years: IntYears): DateTime
operator fun plus(years: LongYears): DateTime
operator fun plus(months: IntMonths): DateTime
operator fun plus(months: LongMonths): DateTime
operator fun plus(weeks: IntWeeks): DateTime
operator fun plus(weeks: LongWeeks): DateTime
operator fun plus(days: IntDays): DateTime
operator fun plus(days: LongDays): DateTime
operator fun plus(hours: IntHours): DateTime
operator fun plus(hours: LongHours): DateTime
operator fun plus(minutes: IntMinutes): DateTime
operator fun plus(minutes: LongMinutes): DateTime
operator fun plus(seconds: IntSeconds): DateTime
operator fun plus(seconds: LongSeconds): DateTime
operator fun plus(milliseconds: IntMilliseconds): DateTime
operator fun plus(milliseconds: LongMilliseconds): DateTime
operator fun plus(microseconds: IntMicroseconds): DateTime
operator fun plus(microseconds: LongMicroseconds): DateTime
operator fun plus(nanoseconds: IntNanoseconds): DateTime
operator fun plus(nanoseconds: LongNanoseconds): DateTime
(iosArm64, iosX64, jvm, macosX64)

rangeTo

operator fun rangeTo(other: DateTime): DateTimeInterval
(iosArm64, iosX64, jvm, macosX64)

secondsSinceUnixEpochAt

Get the number of seconds relative to the Unix epoch of 1970-01-01T00:00Z.

fun secondsSinceUnixEpochAt(offset: UtcOffset): LongSeconds

toString

(iosArm64, iosX64, macosX64) fun toString(): <ERROR CLASS>
(jvm) fun toString(): String
(iosArm64, iosX64, jvm, macosX64)

unixEpochMillisecondAt

fun unixEpochMillisecondAt(offset: UtcOffset): Long
(iosArm64, iosX64, jvm, macosX64)

unixEpochSecondAt

Get the second of the Unix Epoch.

fun unixEpochSecondAt(offset: UtcOffset): Long

Companion Object Properties

(iosArm64, iosX64, jvm, macosX64)

MAX

val MAX: DateTime
(iosArm64, iosX64, jvm, macosX64)

MIN

val MIN: DateTime

Companion Object Functions

(iosArm64, iosX64, jvm, macosX64)

fromMillisecondsSinceUnixEpoch

fun fromMillisecondsSinceUnixEpoch(milliseconds: LongMilliseconds, offset: UtcOffset): DateTime
(iosArm64, iosX64, jvm, macosX64)

fromSecondsSinceUnixEpoch

Create the DateTime that falls a given number of seconds relative to the Unix epoch, plus some number of additional nanoseconds

fun fromSecondsSinceUnixEpoch(seconds: LongSeconds, nanosecondAdjustment: IntNanoseconds = 0.nanoseconds, offset: UtcOffset): DateTime
(iosArm64, iosX64, jvm, macosX64)

fromUnixEpochMillisecond

fun fromUnixEpochMillisecond(millisecond: Long, offset: UtcOffset): DateTime
(iosArm64, iosX64, jvm, macosX64)

fromUnixEpochSecond

fun fromUnixEpochSecond(second: Long, nanosecondAdjustment: Int = 0, offset: UtcOffset): DateTime

Extension Functions

(jvm)

toJavaLocalDateTime

fun DateTime.toJavaLocalDateTime(): LocalDateTime