ZonedDateTime

class ZonedDateTime : TimePoint<ZonedDateTime>

A date and time of day in a particular region.

ZonedDateTime takes time zone rules into account when performing calendrical calculations.

Types

Companion

common

object Companion

Functions

adjustedTo

common

fun adjustedTo(newTimeZone: TimeZone): ZonedDateTime

Changes the time zone of a ZonedDateTime, adjusting the date, time, and offset such that the instant represented by it remains the same.

compareTo

common

open operator fun compareTo(other: TimePoint<*>): Int

Compares this time point with another time point.

copy

common

fun copy(dateTime: DateTime = this.dateTime, offset: UtcOffset = this.offset, zone: TimeZone = this.zone): ZonedDateTime

Returns a copy of this date-time with the values of any individual components replaced by the new values specified.

fun copy(date: Date = this.date, time: Time = this.time, offset: UtcOffset = this.offset, zone: TimeZone = this.zone): ZonedDateTime

Returns a copy of this date-time with the values of any individual components replaced by the new values specified.

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, offset: UtcOffset = this.offset, zone: TimeZone = this.zone): ZonedDateTime

Returns a copy of this date-time with the values of any individual components replaced by the new values specified.

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, offset: UtcOffset = this.offset, zone: TimeZone = this.zone): ZonedDateTime

Returns a copy of this date-time with the values of any individual components replaced by the new values specified.

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, offset: UtcOffset = this.offset, zone: TimeZone = this.zone): ZonedDateTime

Returns a copy of this date-time with the values of any individual components replaced by the new values specified.

equals

common

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

hashCode

common

open override fun hashCode(): Int

isSameInstantAs

common

open fun isSameInstantAs(other: TimePoint<*>): Boolean

Checks if this time point represents the same instant as other.

minus

common

operator fun minus(duration: Duration): ZonedDateTime

operator fun minus(days: IntDays): ZonedDateTime

open operator override fun minus(hours: IntHours): ZonedDateTime

open operator override fun minus(microseconds: IntMicroseconds): ZonedDateTime

open operator override fun minus(milliseconds: IntMilliseconds): ZonedDateTime

open operator override fun minus(minutes: IntMinutes): ZonedDateTime

operator fun minus(months: IntMonths): ZonedDateTime

open operator override fun minus(nanoseconds: IntNanoseconds): ZonedDateTime

open operator override fun minus(seconds: IntSeconds): ZonedDateTime

operator fun minus(weeks: IntWeeks): ZonedDateTime

operator fun minus(years: IntYears): ZonedDateTime

operator fun minus(days: LongDays): ZonedDateTime

open operator override fun minus(hours: LongHours): ZonedDateTime

open operator override fun minus(microseconds: LongMicroseconds): ZonedDateTime

open operator override fun minus(milliseconds: LongMilliseconds): ZonedDateTime

open operator override fun minus(minutes: LongMinutes): ZonedDateTime

operator fun minus(months: LongMonths): ZonedDateTime

open operator override fun minus(nanoseconds: LongNanoseconds): ZonedDateTime

open operator override fun minus(seconds: LongSeconds): ZonedDateTime

operator fun minus(weeks: LongWeeks): ZonedDateTime

operator fun minus(years: LongYears): ZonedDateTime

operator fun minus(period: Period): ZonedDateTime

Returns this date-time with period subtracted from it.

plus

common

operator fun plus(duration: Duration): ZonedDateTime

operator fun plus(days: IntDays): ZonedDateTime

open operator override fun plus(hours: IntHours): ZonedDateTime

open operator override fun plus(microseconds: IntMicroseconds): ZonedDateTime

open operator override fun plus(milliseconds: IntMilliseconds): ZonedDateTime

open operator override fun plus(minutes: IntMinutes): ZonedDateTime

operator fun plus(months: IntMonths): ZonedDateTime

open operator override fun plus(nanoseconds: IntNanoseconds): ZonedDateTime

open operator override fun plus(seconds: IntSeconds): ZonedDateTime

operator fun plus(weeks: IntWeeks): ZonedDateTime

operator fun plus(years: IntYears): ZonedDateTime

operator fun plus(days: LongDays): ZonedDateTime

open operator override fun plus(hours: LongHours): ZonedDateTime

open operator override fun plus(microseconds: LongMicroseconds): ZonedDateTime

open operator override fun plus(milliseconds: LongMilliseconds): ZonedDateTime

open operator override fun plus(minutes: LongMinutes): ZonedDateTime

operator fun plus(months: LongMonths): ZonedDateTime

open operator override fun plus(nanoseconds: LongNanoseconds): ZonedDateTime

open operator override fun plus(seconds: LongSeconds): ZonedDateTime

operator fun plus(weeks: LongWeeks): ZonedDateTime

operator fun plus(years: LongYears): ZonedDateTime

operator fun plus(period: Period): ZonedDateTime

Returns this date-time with period added to it.

rangeTo

common

operator fun rangeTo(other: ZonedDateTime): ZonedDateTimeInterval

toString

common

open override fun toString(): String

Converts this date-time to a string in ISO-8601 extended format.

withEarlierOffsetAtOverlap

common

fun withEarlierOffsetAtOverlap(): ZonedDateTime

If the local date-time falls during an overlap caused by a daylight savings transition, a ZonedDateTime with the same local date and time will be returned, but using the earlier of the two valid offsets.

withFixedOffsetZone

common

fun withFixedOffsetZone(): ZonedDateTime

If this date-time uses a region-based time zone, a copy with a fixed offset will be returned.

withLaterOffsetAtOverlap

common

fun withLaterOffsetAtOverlap(): ZonedDateTime

If the local date-time falls during an overlap caused by a daylight savings transition, a ZonedDateTime with the same local date and time will be returned, but using the later of the two valid offsets.

Properties

additionalNanosecondsSinceUnixEpoch

common

open override val additionalNanosecondsSinceUnixEpoch: IntNanoseconds

The number of additional nanoseconds on top of secondsSinceUnixEpoch.

date

common

The local date.

dateTime

common

val dateTime: DateTime

The local date and time of day.

dayOfMonth

common

val dayOfMonth: Int

The day of the month.

dayOfWeek

common

val dayOfWeek: DayOfWeek

The day of the week.

dayOfYear

common

val dayOfYear: Int

The day of the year.

hour

common

The hour of the day.

millisecondOfUnixEpoch

common

open val millisecondOfUnixEpoch: Long

The millisecond of the Unix epoch.

millisecondsSinceUnixEpoch

common

open override val millisecondsSinceUnixEpoch: LongMilliseconds

The number of milliseconds since the Unix epoch of 1970-01-01T00:00Z.

minute

common

val minute: Int

The minute of the hour.

month

common

val month: Month

The month of the year.

monthNumber

common

val monthNumber: Int

The ISO month number, from 1-12.

nanosecond

common

open override val nanosecond: Int

The nanosecond of the second.

offset

common

val offset: UtcOffset

The offset from UTC.

second

common

val second: Int

The second of the minute.

secondOfUnixEpoch

common

open val secondOfUnixEpoch: Long

The second of the Unix epoch.

secondsSinceUnixEpoch

common

open override val secondsSinceUnixEpoch: LongSeconds

The number of seconds since the Unix epoch of 1970-01-01T00:00Z.

time

common

The local time of day.

year

common

The year.

zone

common

val zone: TimeZone

The time zone.

Extensions

endOfMonth

common

val ZonedDateTime.endOfMonth: ZonedDateTime

The date-time at the last representable instant of the month that this date-time falls in.

endOfWeek

common

val ZonedDateTime.endOfWeek: ZonedDateTime

The date-time at the last representable instant of the ISO week that this date-time falls in.

fun ZonedDateTime.endOfWeek(settings: WeekSettings): ZonedDateTime

The date-time at the last representable instant of the week that this date-time falls in.

fun ZonedDateTime.endOfWeek(locale: Locale): ZonedDateTime

The date-time at the last representable instant of the week that this date-time falls in.

endOfYear

common

val ZonedDateTime.endOfYear: ZonedDateTime

The date-time at the last representable instant of the year that this date-time falls in.

isInLeapDay

common

val ZonedDateTime.isInLeapDay: Boolean

Checks if this date-time falls within February 29.

isInLeapYear

common

val ZonedDateTime.isInLeapYear: Boolean

Checks if this date-time falls within a leap year.

lengthOfMonth

common

val ZonedDateTime.lengthOfMonth: IntDays

The length of this date-time's month in days.

lengthOfWeekBasedYear

common

val ZonedDateTime.lengthOfWeekBasedYear: IntWeeks

The length of the ISO week-based year that this date-time falls in, either 52 or 53 weeks.

lengthOfYear

common

val ZonedDateTime.lengthOfYear: IntDays

The length of this date-time's year in days.

next

common

fun ZonedDateTime.next(dayOfWeek: DayOfWeek): ZonedDateTime

The next date-time after this one that falls on dayOfWeek.

nextOrSame

common

fun ZonedDateTime.nextOrSame(dayOfWeek: DayOfWeek): ZonedDateTime

The next date-time that falls on dayOfWeek, or this date-time if it falls on the same day.

previous

common

fun ZonedDateTime.previous(dayOfWeek: DayOfWeek): ZonedDateTime

The last date-time before this one that falls on dayOfWeek.

previousOrSame

common

fun ZonedDateTime.previousOrSame(dayOfWeek: DayOfWeek): ZonedDateTime

The previous date-time that falls on dayOfWeek, or this date-time if it falls on the same day.

roundedDownTo

common

fun ZonedDateTime.roundedDownTo(unit: TimeUnit): ZonedDateTime

Returns this date-time, rounded down to match the precision of a given unit.

roundedDownToNearest

common

fun ZonedDateTime.roundedDownToNearest(increment: IntHours): ZonedDateTime

Returns this date-time, rounded down to the nearest hour that satisfies the increment.

fun ZonedDateTime.roundedDownToNearest(increment: IntMinutes): ZonedDateTime

Returns this date-time, rounded down to the nearest minute that satisfies the increment.

fun ZonedDateTime.roundedDownToNearest(increment: IntSeconds): ZonedDateTime

Returns this date-time, rounded down to the nearest second that satisfies the increment.

fun ZonedDateTime.roundedDownToNearest(increment: IntMilliseconds): ZonedDateTime

Returns this date-time, rounded down to the nearest millisecond that satisfies the increment.

fun ZonedDateTime.roundedDownToNearest(increment: IntMicroseconds): ZonedDateTime

Returns this date-time, rounded down to the nearest microsecond that satisfies the increment.

fun ZonedDateTime.roundedDownToNearest(increment: IntNanoseconds): ZonedDateTime

Returns this date-time, rounded down to the nearest nanosecond that satisfies the increment.

roundedTo

common

fun ZonedDateTime.roundedTo(unit: TimeUnit): ZonedDateTime

Returns this date-time, rounded to match the precision of a given unit.

roundedToNearest

common

fun ZonedDateTime.roundedToNearest(increment: IntHours): ZonedDateTime

Returns this date-time, rounded to the nearest hour that satisfies the increment.

fun ZonedDateTime.roundedToNearest(increment: IntMinutes): ZonedDateTime

Returns this date-time, rounded to the nearest minute that satisfies the increment.

fun ZonedDateTime.roundedToNearest(increment: IntSeconds): ZonedDateTime

Returns this date-time, rounded to the nearest second that satisfies the increment.

fun ZonedDateTime.roundedToNearest(increment: IntMilliseconds): ZonedDateTime

Returns this date-time, rounded to the nearest millisecond that satisfies the increment.

fun ZonedDateTime.roundedToNearest(increment: IntMicroseconds): ZonedDateTime

Returns this date-time, rounded to the nearest microsecond that satisfies the increment.

fun ZonedDateTime.roundedToNearest(increment: IntNanoseconds): ZonedDateTime

Returns this date-time, rounded to the nearest nanosecond that satisfies the increment.

roundedUpTo

common

fun ZonedDateTime.roundedUpTo(unit: TimeUnit): ZonedDateTime

Returns this date-time, rounded up to match the precision of a given unit.

roundedUpToNearest

common

fun ZonedDateTime.roundedUpToNearest(increment: IntHours): ZonedDateTime

Returns this date-time, rounded up to the nearest hour that satisfies the increment.

fun ZonedDateTime.roundedUpToNearest(increment: IntMinutes): ZonedDateTime

Returns this date-time, rounded up to the nearest minute that satisfies the increment.

fun ZonedDateTime.roundedUpToNearest(increment: IntSeconds): ZonedDateTime

Returns this date-time, rounded up to the nearest second that satisfies the increment.

fun ZonedDateTime.roundedUpToNearest(increment: IntMilliseconds): ZonedDateTime

Returns this date-time, rounded up to the nearest millisecond that satisfies the increment.

fun ZonedDateTime.roundedUpToNearest(increment: IntMicroseconds): ZonedDateTime

Returns this date-time, rounded up to the nearest microsecond that satisfies the increment.

fun ZonedDateTime.roundedUpToNearest(increment: IntNanoseconds): ZonedDateTime

Returns this date-time, rounded up to the nearest nanosecond that satisfies the increment.

startOfMonth

common

val ZonedDateTime.startOfMonth: ZonedDateTime

The date-time at the first instant of the month that this date-time falls in.

startOfWeek

common

val ZonedDateTime.startOfWeek: ZonedDateTime

The date-time at the first instant of the ISO week that this date-time falls in.

fun ZonedDateTime.startOfWeek(settings: WeekSettings): ZonedDateTime

The date-time at the first instant of the week that this date-time falls in.

fun ZonedDateTime.startOfWeek(locale: Locale): ZonedDateTime

The date-time at the first instant of the week that this date-time falls in.

startOfYear

common

val ZonedDateTime.startOfYear: ZonedDateTime

The date-time at the first instant of the year that this date-time falls in.

toInstant

common

fun ZonedDateTime.toInstant(): Instant

Converts this date-time to an Instant representing the same time point.

toJavaZonedDateTime

jvm

fun ZonedDateTime.toJavaZonedDateTime(): ZonedDateTime

Converts this date-time to an equivalent Java ZonedDateTime.

toNSDateComponents

darwin

fun ZonedDateTime.toNSDateComponents(includeCalendar: Boolean = false): <ERROR CLASS>

Converts this date-time to an equivalent NSDateComponents object.

toOffsetDateTime

common

fun ZonedDateTime.toOffsetDateTime(): OffsetDateTime

Returns the combined date, time, and UTC offset.

toOffsetTime

common

fun ZonedDateTime.toOffsetTime(): OffsetTime

Returns the combined time and UTC offset.

toYear

common

fun ZonedDateTime.toYear(): Year

Returns this date-time with the precision reduced to the year.

toYearMonth

common

fun ZonedDateTime.toYearMonth(): YearMonth

Returns this date-time with the precision reduced to the month.

truncatedTo

common

fun ZonedDateTime.truncatedTo(unit: TimeUnit): ZonedDateTime

Returns this date-time, rounded down to match the precision of a given unit.

until

common

infix fun ZonedDateTime.until(to: ZonedDateTime): ZonedDateTimeInterval

Creates a ZonedDateTimeInterval from this date-time up to, but not including to.

week

common

val ZonedDateTime.week: ZonedDateTimeInterval

The interval defining the ISO week that this date-time falls within.

fun ZonedDateTime.week(settings: WeekSettings): ZonedDateTimeInterval

The interval defining the week that this date-time falls within.

fun ZonedDateTime.week(locale: Locale): ZonedDateTimeInterval

The interval defining the week that this date-time falls within.

weekBasedYear

common

val ZonedDateTime.weekBasedYear: Int

The week-based year used in the ISO week date system.

fun ZonedDateTime.weekBasedYear(settings: WeekSettings): Int

The week-based year, calculated using the week definition in settings.

fun ZonedDateTime.weekBasedYear(locale: Locale): Int

The week-based year, calculated using the week definition associated with the provided locale.

weekOfMonth

common

val ZonedDateTime.weekOfMonth: Int

The week of the month, from 0-6, calculated using the ISO week definition.

fun ZonedDateTime.weekOfMonth(settings: WeekSettings): Int

The week of the month, from 0-6, calculated using the week definition in settings.

fun ZonedDateTime.weekOfMonth(locale: Locale): Int

The week of the month, from 0-6, calculated using the default week definition associated with the provided locale.

weekOfWeekBasedYear

common

val ZonedDateTime.weekOfWeekBasedYear: Int

The week number used in the ISO week date system.

fun ZonedDateTime.weekOfWeekBasedYear(settings: WeekSettings): Int

The week number of the week-based year, calculated using the week definition in settings.

fun ZonedDateTime.weekOfWeekBasedYear(locale: Locale): Int

The week number of the week-based year, calculated using the week definition associated with the provided locale.

weekOfYear

common

val ZonedDateTime.weekOfYear: Int

The week of the year, calculated using the ISO week definition.

fun ZonedDateTime.weekOfYear(settings: WeekSettings): Int

The week of the year, calculated using the week definition in settings.

fun ZonedDateTime.weekOfYear(locale: Locale): Int

The week of the year, calculated using the week definition associated with the provided locale.