ZonedDateTime

equals

fun equals(other: Any?): Boolean

Checks if this date-time is equal to another date-time.

The comparison is based on the offset date-time and the zone. Only objects of type ZonedDateTime are compared, other types return false.

format

fun format(formatter: DateTimeFormatter!): String!

Formats this date-time using the specified formatter.

This date-time will be passed to the formatter to produce a string.

from

static fun from(temporal: TemporalAccessor!): ZonedDateTime!

Obtains an instance of ZonedDateTime from a temporal object.

This obtains a zoned date-time based on the specified temporal. A TemporalAccessor represents an arbitrary set of date and time information, which this factory converts to an instance of ZonedDateTime.

The conversion will first obtain a ZoneId from the temporal object, falling back to a ZoneOffset if necessary. It will then try to obtain an Instant, falling back to a LocalDateTime if necessary. The result will be either the combination of ZoneId or ZoneOffset with Instant or LocalDateTime. Implementations are permitted to perform optimizations such as accessing those fields that are equivalent to the relevant objects.

This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, ZonedDateTime::from.

get

fun get(field: TemporalField!): Int

Gets the value of the specified field from this date-time as an int.

This queries this date-time for the value of the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this date-time, except NANO_OF_DAY, MICRO_OF_DAY, EPOCH_DAY, PROLEPTIC_MONTH and INSTANT_SECONDS which are too large to fit in an int and throw an UnsupportedTemporalTypeException. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

getDayOfMonth

fun getDayOfMonth(): Int

Gets the day-of-month field.

This method returns the primitive int value for the day-of-month.

getDayOfWeek

fun getDayOfWeek(): DayOfWeek!

Gets the day-of-week field, which is an enum DayOfWeek.

This method returns the enum DayOfWeek for the day-of-week. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the int value.

Additional information can be obtained from the DayOfWeek. This includes textual names of the values.

getDayOfYear

fun getDayOfYear(): Int

Gets the day-of-year field.

This method returns the primitive int value for the day-of-year.

getHour

fun getHour(): Int

Gets the hour-of-day field.

getLong

fun getLong(field: TemporalField!): Long

Gets the value of the specified field from this date-time as a long.

This queries this date-time for the value of the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this date-time. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

getMinute

fun getMinute(): Int

Gets the minute-of-hour field.

getMonth

fun getMonth(): Month!

Gets the month-of-year field using the Month enum.

This method returns the enum Month for the month. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the int value.

getMonthValue

fun getMonthValue(): Int

Gets the month-of-year field from 1 to 12.

This method returns the month as an int from 1 to 12. Application code is frequently clearer if the enum Month is used by calling getMonth().

getNano

fun getNano(): Int

Gets the nano-of-second field.

getOffset

fun getOffset(): ZoneOffset!

Gets the zone offset, such as '+01:00'.

This is the offset of the local date-time from UTC/Greenwich.

getSecond

fun getSecond(): Int

Gets the second-of-minute field.

getYear

fun getYear(): Int

Gets the year field.

This method returns the primitive int value for the year.

The year returned by this method is proleptic as per get(YEAR). To obtain the year-of-era, use get(YEAR_OF_ERA).

getZone

fun getZone(): ZoneId!

Gets the time-zone, such as 'Europe/Paris'.

This returns the zone ID. This identifies the time-zone rules that determine when and how the offset from UTC/Greenwich changes.

The zone ID may be same as the offset. If this is true, then any future calculations, such as addition or subtraction, have no complex edge cases due to time-zone rules. See also withFixedOffsetZone().

hashCode

fun hashCode(): Int

A hash code for this date-time.

isSupported

fun isSupported(field: TemporalField!): Boolean

Checks if the specified field is supported.

This checks if this date-time can be queried for the specified field. If false, then calling the range, get and with(java.time.temporal.TemporalField,long) methods will throw an exception.

If the field is a ChronoField then the query is implemented here. The supported fields are:

• NANO_OF_SECOND
• NANO_OF_DAY
• MICRO_OF_SECOND
• MICRO_OF_DAY
• MILLI_OF_SECOND
• MILLI_OF_DAY
• SECOND_OF_MINUTE
• SECOND_OF_DAY
• MINUTE_OF_HOUR
• MINUTE_OF_DAY
• HOUR_OF_AMPM
• CLOCK_HOUR_OF_AMPM
• HOUR_OF_DAY
• CLOCK_HOUR_OF_DAY
• AMPM_OF_DAY
• DAY_OF_WEEK
• ALIGNED_DAY_OF_WEEK_IN_MONTH
• ALIGNED_DAY_OF_WEEK_IN_YEAR
• DAY_OF_MONTH
• DAY_OF_YEAR
• EPOCH_DAY
• ALIGNED_WEEK_OF_MONTH
• ALIGNED_WEEK_OF_YEAR
• MONTH_OF_YEAR
• PROLEPTIC_MONTH
• YEAR_OF_ERA
• YEAR
• ERA
• INSTANT_SECONDS
• OFFSET_SECONDS

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

isSupported

fun isSupported(unit: TemporalUnit!): Boolean

Checks if the specified unit is supported.

This checks if the specified unit can be added to, or subtracted from, this date-time. If false, then calling the plus(long,java.time.temporal.TemporalUnit) and minus methods will throw an exception.

If the unit is a ChronoUnit then the query is implemented here. The supported units are:

• NANOS
• MICROS
• MILLIS
• SECONDS
• MINUTES
• HOURS
• HALF_DAYS
• DAYS
• WEEKS
• MONTHS
• YEARS
• DECADES
• CENTURIES
• MILLENNIA
• ERAS

If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal) passing this as the argument. Whether the unit is supported is determined by the unit.

minus

fun minus(amountToSubtract: TemporalAmount!): ZonedDateTime!

Returns a copy of this date-time with the specified amount subtracted.

This returns a ZonedDateTime, based on this one, with the specified amount subtracted. The amount is typically Period or Duration but may be any other type implementing the TemporalAmount interface.

The calculation is delegated to the amount object by calling TemporalAmount#subtractFrom(Temporal). The amount implementation is free to implement the subtraction in any way it wishes, however it typically calls back to minus(long,java.time.temporal.TemporalUnit). Consult the documentation of the amount implementation to determine if it can be successfully subtracted.

This instance is immutable and unaffected by this method call.

minus

fun minus(
    amountToSubtract: Long, 
    unit: TemporalUnit!
): ZonedDateTime!

Returns a copy of this date-time with the specified amount subtracted.

This returns a ZonedDateTime, based on this one, with the amount in terms of the unit subtracted. If it is not possible to subtract the amount, because the unit is not supported or for some other reason, an exception is thrown.

The calculation for date and time units differ.

Date units operate on the local time-line. The period is first subtracted from the local date-time, then converted back to a zoned date-time using the zone ID. The conversion uses ofLocal(java.time.LocalDateTime,java.time.ZoneId,java.time.ZoneOffset) with the offset before the subtraction.

Time units operate on the instant time-line. The period is first subtracted from the local date-time, then converted back to a zoned date-time using the zone ID. The conversion uses ofInstant(java.time.LocalDateTime,java.time.ZoneOffset,java.time.ZoneId) with the offset before the subtraction.

This method is equivalent to plus(long,java.time.temporal.TemporalUnit) with the amount negated. See that method for a full description of how addition, and thus subtraction, works.

This instance is immutable and unaffected by this method call.

minusDays

fun minusDays(days: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of days subtracted.

This operates on the local time-line, subtracting days to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

minusHours

fun minusHours(hours: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of hours subtracted.

This operates on the instant time-line, such that subtracting one hour will always be a duration of one hour earlier. This may cause the local date-time to change by an amount other than one hour. Note that this is a different approach to that used by days, months and years, thus subtracting one day is not the same as adding 24 hours.

For example, consider a time-zone, such as 'Europe/Paris', where the Autumn DST cutover means that the local times 02:00 to 02:59 occur twice changing from offset +02:00 in summer to +01:00 in winter.

• Subtracting one hour from 03:30+01:00 will result in 02:30+01:00 (both in winter time)
• Subtracting one hour from 02:30+01:00 will result in 02:30+02:00 (moving from winter to summer time)
• Subtracting one hour from 02:30+02:00 will result in 01:30+02:00 (both in summer time)
• Subtracting three hours from 03:30+01:00 will result in 01:30+02:00 (moving from winter to summer time)

This instance is immutable and unaffected by this method call.

minusMinutes

fun minusMinutes(minutes: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of minutes subtracted.

This operates on the instant time-line, such that subtracting one minute will always be a duration of one minute earlier. This may cause the local date-time to change by an amount other than one minute. Note that this is a different approach to that used by days, months and years.

This instance is immutable and unaffected by this method call.

minusMonths

fun minusMonths(months: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of months subtracted.

This operates on the local time-line, subtracting months to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

minusNanos

fun minusNanos(nanos: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of nanoseconds subtracted.

This operates on the instant time-line, such that subtracting one nano will always be a duration of one nano earlier. This may cause the local date-time to change by an amount other than one nano. Note that this is a different approach to that used by days, months and years.

This instance is immutable and unaffected by this method call.

minusSeconds

fun minusSeconds(seconds: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of seconds subtracted.

This operates on the instant time-line, such that subtracting one second will always be a duration of one second earlier. This may cause the local date-time to change by an amount other than one second. Note that this is a different approach to that used by days, months and years.

This instance is immutable and unaffected by this method call.

minusWeeks

fun minusWeeks(weeks: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of weeks subtracted.

This operates on the local time-line, subtracting weeks to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

minusYears

fun minusYears(years: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of years subtracted.

This operates on the local time-line, subtracting years to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

now

static fun now(): ZonedDateTime!

Obtains the current date-time from the system clock in the default time-zone.

This will query the system clock in the default time-zone to obtain the current date-time. The zone and offset will be set based on the time-zone in the clock.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

now

static fun now(zone: ZoneId!): ZonedDateTime!

Obtains the current date-time from the system clock in the specified time-zone.

This will query the system clock to obtain the current date-time. Specifying the time-zone avoids dependence on the default time-zone. The offset will be calculated from the specified time-zone.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

now

static fun now(clock: Clock!): ZonedDateTime!

Obtains the current date-time from the specified clock.

This will query the specified clock to obtain the current date-time. The zone and offset will be set based on the time-zone in the clock.

Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using dependency injection.

of

static fun of(
    date: LocalDate!, 
    time: LocalTime!, 
    zone: ZoneId!
): ZonedDateTime!

Obtains an instance of ZonedDateTime from a local date and time.

This creates a zoned date-time matching the input local date and time as closely as possible. Time-zone rules, such as daylight savings, mean that not every local date-time is valid for the specified zone, thus the local date-time may be adjusted.

The local date time and first combined to form a local date-time. The local date-time is then resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the rules of the zone ID.

In most cases, there is only one valid offset for a local date-time. In the case of an overlap, when clocks are set back, there are two valid offsets. This method uses the earlier offset typically corresponding to "summer".

In the case of a gap, when clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to "summer".

of

static fun of(
    localDateTime: LocalDateTime!, 
    zone: ZoneId!
): ZonedDateTime!

Obtains an instance of ZonedDateTime from a local date-time.

This creates a zoned date-time matching the input local date-time as closely as possible. Time-zone rules, such as daylight savings, mean that not every local date-time is valid for the specified zone, thus the local date-time may be adjusted.

The local date-time is resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the rules of the zone ID.

In most cases, there is only one valid offset for a local date-time. In the case of an overlap, when clocks are set back, there are two valid offsets. This method uses the earlier offset typically corresponding to "summer".

In the case of a gap, when clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to "summer".

of

static fun of(
    year: Int, 
    month: Int, 
    dayOfMonth: Int, 
    hour: Int, 
    minute: Int, 
    second: Int, 
    nanoOfSecond: Int, 
    zone: ZoneId!
): ZonedDateTime!

Obtains an instance of ZonedDateTime from a year, month, day, hour, minute, second, nanosecond and time-zone.

This creates a zoned date-time matching the local date-time of the seven specified fields as closely as possible. Time-zone rules, such as daylight savings, mean that not every local date-time is valid for the specified zone, thus the local date-time may be adjusted.

The local date-time is resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the rules of the zone ID.

In most cases, there is only one valid offset for a local date-time. In the case of an overlap, when clocks are set back, there are two valid offsets. This method uses the earlier offset typically corresponding to "summer".

In the case of a gap, when clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to "summer".

This method exists primarily for writing test cases. Non test-code will typically use other methods to create an offset time. LocalDateTime has five additional convenience variants of the equivalent factory method taking fewer arguments. They are not provided here to reduce the footprint of the API.

ofInstant

static fun ofInstant(
    instant: Instant!, 
    zone: ZoneId!
): ZonedDateTime!

Obtains an instance of ZonedDateTime from an Instant.

This creates a zoned date-time with the same instant as that specified. Calling toInstant() will return an instant equal to the one used here.

Converting an instant to a zoned date-time is simple as there is only one valid offset for each instant.

ofInstant

static fun ofInstant(
    localDateTime: LocalDateTime!, 
    offset: ZoneOffset!, 
    zone: ZoneId!
): ZonedDateTime!

Obtains an instance of ZonedDateTime from the instant formed by combining the local date-time and offset.

This creates a zoned date-time by combining the LocalDateTime and ZoneOffset. This combination uniquely specifies an instant without ambiguity.

Converting an instant to a zoned date-time is simple as there is only one valid offset for each instant. If the valid offset is different to the offset specified, then the date-time and offset of the zoned date-time will differ from those specified.

If the ZoneId to be used is a ZoneOffset, this method is equivalent to of(java.time.LocalDateTime,java.time.ZoneId).

ofLocal

static fun ofLocal(
    localDateTime: LocalDateTime!, 
    zone: ZoneId!, 
    preferredOffset: ZoneOffset!
): ZonedDateTime!

Obtains an instance of ZonedDateTime from a local date-time using the preferred offset if possible.

The local date-time is resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the rules of the zone ID.

In most cases, there is only one valid offset for a local date-time. In the case of an overlap, where clocks are set back, there are two valid offsets. If the preferred offset is one of the valid offsets then it is used. Otherwise the earlier valid offset is used, typically corresponding to "summer".

In the case of a gap, where clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to "summer".

ofStrict

static fun ofStrict(
    localDateTime: LocalDateTime!, 
    offset: ZoneOffset!, 
    zone: ZoneId!
): ZonedDateTime!

Obtains an instance of ZonedDateTime strictly validating the combination of local date-time, offset and zone ID.

This creates a zoned date-time ensuring that the offset is valid for the local date-time according to the rules of the specified zone. If the offset is invalid, an exception is thrown.

parse

static fun parse(text: CharSequence!): ZonedDateTime!

Obtains an instance of ZonedDateTime from a text string such as 2007-12-03T10:15:30+01:00[Europe/Paris].

The string must represent a valid date-time and is parsed using java.time.format.DateTimeFormatter#ISO_ZONED_DATE_TIME.

parse

static fun parse(
    text: CharSequence!, 
    formatter: DateTimeFormatter!
): ZonedDateTime!

Obtains an instance of ZonedDateTime from a text string using a specific formatter.

The text is parsed using the formatter, returning a date-time.

plus

fun plus(amountToAdd: TemporalAmount!): ZonedDateTime!

Returns a copy of this date-time with the specified amount added.

This returns a ZonedDateTime, based on this one, with the specified amount added. The amount is typically Period or Duration but may be any other type implementing the TemporalAmount interface.

The calculation is delegated to the amount object by calling TemporalAmount#addTo(Temporal). The amount implementation is free to implement the addition in any way it wishes, however it typically calls back to plus(long,java.time.temporal.TemporalUnit). Consult the documentation of the amount implementation to determine if it can be successfully added.

This instance is immutable and unaffected by this method call.

plus

fun plus(
    amountToAdd: Long, 
    unit: TemporalUnit!
): ZonedDateTime!

Returns a copy of this date-time with the specified amount added.

This returns a ZonedDateTime, based on this one, with the amount in terms of the unit added. If it is not possible to add the amount, because the unit is not supported or for some other reason, an exception is thrown.

If the field is a ChronoUnit then the addition is implemented here. The zone is not part of the calculation and will be unchanged in the result. The calculation for date and time units differ.

Date units operate on the local time-line. The period is first added to the local date-time, then converted back to a zoned date-time using the zone ID. The conversion uses ofLocal(java.time.LocalDateTime,java.time.ZoneId,java.time.ZoneOffset) with the offset before the addition.

Time units operate on the instant time-line. The period is first added to the local date-time, then converted back to a zoned date-time using the zone ID. The conversion uses ofInstant(java.time.LocalDateTime,java.time.ZoneOffset,java.time.ZoneId) with the offset before the addition.

If the field is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.addTo(Temporal, long) passing this as the argument. In this case, the unit determines whether and how to perform the addition.

This instance is immutable and unaffected by this method call.

plusDays

fun plusDays(days: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of days added.

This operates on the local time-line, adding days to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

plusHours

fun plusHours(hours: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of hours added.

This operates on the instant time-line, such that adding one hour will always be a duration of one hour later. This may cause the local date-time to change by an amount other than one hour. Note that this is a different approach to that used by days, months and years, thus adding one day is not the same as adding 24 hours.

For example, consider a time-zone, such as 'Europe/Paris', where the Autumn DST cutover means that the local times 02:00 to 02:59 occur twice changing from offset +02:00 in summer to +01:00 in winter.

• Adding one hour to 01:30+02:00 will result in 02:30+02:00 (both in summer time)
• Adding one hour to 02:30+02:00 will result in 02:30+01:00 (moving from summer to winter time)
• Adding one hour to 02:30+01:00 will result in 03:30+01:00 (both in winter time)
• Adding three hours to 01:30+02:00 will result in 03:30+01:00 (moving from summer to winter time)

This instance is immutable and unaffected by this method call.

plusMinutes

fun plusMinutes(minutes: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of minutes added.

This operates on the instant time-line, such that adding one minute will always be a duration of one minute later. This may cause the local date-time to change by an amount other than one minute. Note that this is a different approach to that used by days, months and years.

This instance is immutable and unaffected by this method call.

plusMonths

fun plusMonths(months: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of months added.

This operates on the local time-line, adding months to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

plusNanos

fun plusNanos(nanos: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of nanoseconds added.

This operates on the instant time-line, such that adding one nano will always be a duration of one nano later. This may cause the local date-time to change by an amount other than one nano. Note that this is a different approach to that used by days, months and years.

This instance is immutable and unaffected by this method call.

plusSeconds

fun plusSeconds(seconds: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of seconds added.

This operates on the instant time-line, such that adding one second will always be a duration of one second later. This may cause the local date-time to change by an amount other than one second. Note that this is a different approach to that used by days, months and years.

This instance is immutable and unaffected by this method call.

plusWeeks

fun plusWeeks(weeks: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of weeks added.

This operates on the local time-line, adding weeks to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

plusYears

fun plusYears(years: Long): ZonedDateTime!

Returns a copy of this ZonedDateTime with the specified number of years added.

This operates on the local time-line, adding years to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

query

fun <R : Any!> query(query: TemporalQuery<R>!): R

Queries this date-time using the specified query.

This queries this date-time using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.

The result of this method is obtained by invoking the TemporalQuery#queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

range

fun range(field: TemporalField!): ValueRange!

Gets the range of valid values for the specified field.

The range object expresses the minimum and maximum valid values for a field. This date-time is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.

If the field is a ChronoField then the query is implemented here. The supported fields will return appropriate range instances. All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

toLocalDate

fun toLocalDate(): LocalDate!

Gets the LocalDate part of this date-time.

This returns a LocalDate with the same year, month and day as this date-time.

toLocalDateTime

fun toLocalDateTime(): LocalDateTime!

Gets the LocalDateTime part of this date-time.

This returns a LocalDateTime with the same year, month, day and time as this date-time.

toLocalTime

fun toLocalTime(): LocalTime!

Gets the LocalTime part of this date-time.

This returns a LocalTime with the same hour, minute, second and nanosecond as this date-time.

toOffsetDateTime

fun toOffsetDateTime(): OffsetDateTime!

Converts this date-time to an OffsetDateTime.

This creates an offset date-time using the local date-time and offset. The zone ID is ignored.

toString

fun toString(): String

Outputs this date-time as a String, such as 2007-12-03T10:15:30+01:00[Europe/Paris].

The format consists of the LocalDateTime followed by the ZoneOffset. If the ZoneId is not the same as the offset, then the ID is output. The output is compatible with ISO-8601 if the offset and ID are the same.

truncatedTo

fun truncatedTo(unit: TemporalUnit!): ZonedDateTime!

Returns a copy of this ZonedDateTime with the time truncated.

Truncation returns a copy of the original date-time with fields smaller than the specified unit set to zero. For example, truncating with the minutes unit will set the second-of-minute and nano-of-second field to zero.

The unit must have a duration that divides into the length of a standard day without remainder. This includes all supplied time units on ChronoUnit and DAYS. Other units throw an exception.

This operates on the local time-line, truncating the underlying local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

until

fun until(
    endExclusive: Temporal!, 
    unit: TemporalUnit!
): Long

Calculates the amount of time until another date-time in terms of the specified unit.

This calculates the amount of time between two ZonedDateTime objects in terms of a single TemporalUnit. The start and end points are this and the specified date-time. The result will be negative if the end is before the start. For example, the amount in days between two date-times can be calculated using startDateTime.until(endDateTime, DAYS).

The Temporal passed to this method is converted to a ZonedDateTime using #from(java.time.temporal.TemporalAccessor). If the time-zone differs between the two zoned date-times, the specified end date-time is normalized to have the same zone as this date-time.

The calculation returns a whole number, representing the number of complete units between the two date-times. For example, the amount in months between 2012-06-15T00:00Z and 2012-08-14T23:59Z will only be one month as it is one minute short of two months.

There are two equivalent ways of using this method. The first is to invoke this method. The second is to use TemporalUnit#between(Temporal, Temporal):

// these two lines are equivalent
    amount = start.until(end, MONTHS);
    amount = MONTHS.between(start, end);
  

The calculation is implemented in this method for ChronoUnit. The units NANOS, MICROS, MILLIS, SECONDS, MINUTES, HOURS and HALF_DAYS, DAYS, WEEKS, MONTHS, YEARS, DECADES, CENTURIES, MILLENNIA and ERAS are supported. Other ChronoUnit values will throw an exception.

The calculation for date and time units differ.

Date units operate on the local time-line, using the local date-time. For example, the period from noon on day 1 to noon the following day in days will always be counted as exactly one day, irrespective of whether there was a daylight savings change or not.

Time units operate on the instant time-line. The calculation effectively converts both zoned date-times to instants and then calculates the period between the instants. For example, the period from noon on day 1 to noon the following day in hours may be 23, 24 or 25 hours (or some other amount) depending on whether there was a daylight savings change or not.

If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.between(Temporal, Temporal) passing this as the first argument and the converted input temporal as the second argument.

This instance is immutable and unaffected by this method call.

with

fun with(adjuster: TemporalAdjuster!): ZonedDateTime!

Returns an adjusted copy of this date-time.

This returns a ZonedDateTime, based on this one, with the date-time adjusted. The adjustment takes place using the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will be made.

A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the date to the last day of the month. A selection of common adjustments is provided in TemporalAdjusters. These include finding the "last day of the month" and "next Wednesday". Key date-time classes also implement the TemporalAdjuster interface, such as Month and MonthDay. The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.

For example this code returns a date on the last day of July:

import static java.time.Month.*;
   import static java.time.temporal.TemporalAdjusters.*;
 
   result = zonedDateTime.with(JULY).with(lastDayOfMonth());
  

The classes LocalDate and LocalTime implement TemporalAdjuster, thus this method can be used to change the date, time or offset:

result = zonedDateTime.with(date);
   result = zonedDateTime.with(time);
  

ZoneOffset also implements TemporalAdjuster however using it as an argument typically has no effect. The offset of a ZonedDateTime is controlled primarily by the time-zone. As such, changing the offset does not generally make sense, because there is only one valid offset for the local date-time and zone. If the zoned date-time is in a daylight savings overlap, then the offset is used to switch between the two valid offsets. In all other cases, the offset is ignored.

The result of this method is obtained by invoking the TemporalAdjuster#adjustInto(Temporal) method on the specified adjuster passing this as the argument.

This instance is immutable and unaffected by this method call.

with

fun with(
    field: TemporalField!, 
    newValue: Long
): ZonedDateTime!

Returns a copy of this date-time with the specified field set to a new value.

This returns a ZonedDateTime, based on this one, with the value for the specified field changed. This can be used to change any supported field, such as the year, month or day-of-month. If it is not possible to set the value, because the field is not supported or for some other reason, an exception is thrown.

In some cases, changing the specified field can cause the resulting date-time to become invalid, such as changing the month from 31st January to February would make the day-of-month invalid. In cases like this, the field is responsible for resolving the date. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

If the field is a ChronoField then the adjustment is implemented here.

The INSTANT_SECONDS field will return a date-time with the specified instant. The zone and nano-of-second are unchanged. The result will have an offset derived from the new instant and original zone. If the new instant value is outside the valid range then a DateTimeException will be thrown.

The OFFSET_SECONDS field will typically be ignored. The offset of a ZonedDateTime is controlled primarily by the time-zone. As such, changing the offset does not generally make sense, because there is only one valid offset for the local date-time and zone. If the zoned date-time is in a daylight savings overlap, then the offset is used to switch between the two valid offsets. In all other cases, the offset is ignored. If the new offset value is outside the valid range then a DateTimeException will be thrown.

The other supported fields will behave as per the matching method on LocalDateTime. The zone is not part of the calculation and will be unchanged. When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

All other ChronoField instances will throw an UnsupportedTemporalTypeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.adjustInto(Temporal, long) passing this as the argument. In this case, the field determines whether and how to adjust the instant.

This instance is immutable and unaffected by this method call.

withDayOfMonth

fun withDayOfMonth(dayOfMonth: Int): ZonedDateTime!

Returns a copy of this ZonedDateTime with the day-of-month altered.

This operates on the local time-line, changing the day-of-month of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

withDayOfYear

fun withDayOfYear(dayOfYear: Int): ZonedDateTime!

Returns a copy of this ZonedDateTime with the day-of-year altered.

This operates on the local time-line, changing the day-of-year of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

withEarlierOffsetAtOverlap

fun withEarlierOffsetAtOverlap(): ZonedDateTime!

Returns a copy of this date-time changing the zone offset to the earlier of the two valid offsets at a local time-line overlap.

This method only has any effect when the local time-line overlaps, such as at an autumn daylight savings cutover. In this scenario, there are two valid offsets for the local date-time. Calling this method will return a zoned date-time with the earlier of the two selected.

If this method is called when it is not an overlap, this is returned.

This instance is immutable and unaffected by this method call.

withFixedOffsetZone

fun withFixedOffsetZone(): ZonedDateTime!

Returns a copy of this date-time with the zone ID set to the offset.

This returns a zoned date-time where the zone ID is the same as getOffset(). The local date-time, offset and instant of the result will be the same as in this date-time.

Setting the date-time to a fixed single offset means that any future calculations, such as addition or subtraction, have no complex edge cases due to time-zone rules. This might also be useful when sending a zoned date-time across a network, as most protocols, such as ISO-8601, only handle offsets, and not region-based zone IDs.

This is equivalent to ZonedDateTime.of(zdt.toLocalDateTime(), zdt.getOffset()).

withHour

fun withHour(hour: Int): ZonedDateTime!

Returns a copy of this ZonedDateTime with the hour-of-day altered.

This operates on the local time-line, changing the time of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

withLaterOffsetAtOverlap

fun withLaterOffsetAtOverlap(): ZonedDateTime!

Returns a copy of this date-time changing the zone offset to the later of the two valid offsets at a local time-line overlap.

This method only has any effect when the local time-line overlaps, such as at an autumn daylight savings cutover. In this scenario, there are two valid offsets for the local date-time. Calling this method will return a zoned date-time with the later of the two selected.

If this method is called when it is not an overlap, this is returned.

This instance is immutable and unaffected by this method call.

withMinute

fun withMinute(minute: Int): ZonedDateTime!

Returns a copy of this ZonedDateTime with the minute-of-hour altered.

This operates on the local time-line, changing the time of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

withMonth

fun withMonth(month: Int): ZonedDateTime!

Returns a copy of this ZonedDateTime with the month-of-year altered.

This operates on the local time-line, changing the month of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

withNano

fun withNano(nanoOfSecond: Int): ZonedDateTime!

Returns a copy of this ZonedDateTime with the nano-of-second altered.

This operates on the local time-line, changing the time of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

withSecond

fun withSecond(second: Int): ZonedDateTime!

Returns a copy of this ZonedDateTime with the second-of-minute altered.

This operates on the local time-line, changing the time of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

withYear

fun withYear(year: Int): ZonedDateTime!

Returns a copy of this ZonedDateTime with the year altered.

This operates on the local time-line, changing the year of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

This instance is immutable and unaffected by this method call.

withZoneSameInstant

fun withZoneSameInstant(zone: ZoneId!): ZonedDateTime!

Returns a copy of this date-time with a different time-zone, retaining the instant.

This method changes the time-zone and retains the instant. This normally results in a change to the local date-time.

This method is based on retaining the same instant, thus gaps and overlaps in the local time-line have no effect on the result.

To change the offset while keeping the local time, use withZoneSameLocal(java.time.ZoneId).

withZoneSameLocal

fun withZoneSameLocal(zone: ZoneId!): ZonedDateTime!

Returns a copy of this date-time with a different time-zone, retaining the local date-time if possible.

This method changes the time-zone and retains the local date-time. The local date-time is only changed if it is invalid for the new zone, determined using the same approach as ofLocal(java.time.LocalDateTime,java.time.ZoneId,java.time.ZoneOffset).

To change the zone and adjust the local date-time, use withZoneSameInstant(java.time.ZoneId).

This instance is immutable and unaffected by this method call.