ChronoZonedDateTime

compareTo

open fun compareTo(other: ChronoZonedDateTime<*>!): Int

Compares this date-time to another date-time, including the chronology.

The comparison is based first on the instant, then on the local date-time, then on the zone ID, then on the chronology. It is "consistent with equals", as defined by Comparable.

If all the date-time objects being compared are in the same chronology, then the additional chronology stage is not required.

This default implementation performs the comparison defined above.

format

open 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.

The default implementation must behave as follows:

return formatter.format(this);
  

from

open static fun from(temporal: TemporalAccessor!): ChronoZonedDateTime<*>!

Obtains an instance of ChronoZonedDateTime from a temporal object.

This creates 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 ChronoZonedDateTime.

The conversion extracts and combines the chronology, date, time and zone from the temporal object. The behavior is equivalent to using Chronology.zonedDateTime(TemporalAccessor) with the extracted chronology. 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, ChronoZonedDateTime::from.

get

open fun get(field: TemporalField!): Int

getChronology

open fun getChronology(): Chronology!

Gets the chronology of this date-time.

The Chronology represents the calendar system in use. The era and other fields in ChronoField are defined by the chronology.

getLong

open fun getLong(field: TemporalField!): Long

getOffset

abstract fun getOffset(): ZoneOffset!

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

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

getZone

abstract fun getZone(): ZoneId!

Gets the zone ID, such as 'Europe/Paris'.

This returns the stored time-zone id used to determine the time-zone rules.

isAfter

open fun isAfter(other: ChronoZonedDateTime<*>!): Boolean

Checks if the instant of this date-time is after that of the specified date-time.

This method differs from the comparison in compareTo in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().isAfter(dateTime2.toInstant());.

This default implementation performs the comparison based on the epoch-second and nano-of-second.

isBefore

open fun isBefore(other: ChronoZonedDateTime<*>!): Boolean

Checks if the instant of this date-time is before that of the specified date-time.

This method differs from the comparison in compareTo in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().isBefore(dateTime2.toInstant());.

This default implementation performs the comparison based on the epoch-second and nano-of-second.

isEqual

open fun isEqual(other: ChronoZonedDateTime<*>!): Boolean

Checks if the instant of this date-time is equal to that of the specified date-time.

This method differs from the comparison in compareTo and equals in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().equals(dateTime2.toInstant());.

This default implementation performs the comparison based on the epoch-second and nano-of-second.

isSupported

abstract fun isSupported(field: TemporalField!): Boolean

Checks if the specified field is supported.

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

The set of supported fields is defined by the chronology and normally includes all ChronoField fields.

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

open 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.

The set of supported units is defined by the chronology and normally includes all ChronoUnit units except FOREVER.

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

open fun minus(amount: TemporalAmount!): ChronoZonedDateTime<D>!

Returns an object of the same type as this object with an amount subtracted.

This adjusts this temporal, subtracting according to the rules of the specified amount. The amount is typically a java.time.Period but may be any other type implementing the TemporalAmount interface, such as java.time.Duration.

Some example code indicating how and why this method is used:

date = date.minus(period);               // subtract a Period instance
   date = date.minus(duration);             // subtract a Duration instance
   date = date.minus(workingDays(6));       // example user-written workingDays method
  

Note that calling plus followed by minus is not guaranteed to return the same date-time.

minus

open fun minus(
    amountToSubtract: Long, 
    unit: TemporalUnit!
): ChronoZonedDateTime<D>!

Returns an object of the same type as this object with the specified period subtracted.

This method returns a new object based on this one with the specified period subtracted. For example, on a LocalDate, this could be used to subtract a number of years, months or days. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st March, then subtracting one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

plus

open fun plus(amount: TemporalAmount!): ChronoZonedDateTime<D>!

Returns an object of the same type as this object with an amount added.

This adjusts this temporal, adding according to the rules of the specified amount. The amount is typically a java.time.Period but may be any other type implementing the TemporalAmount interface, such as java.time.Duration.

Some example code indicating how and why this method is used:

date = date.plus(period);                // add a Period instance
   date = date.plus(duration);              // add a Duration instance
   date = date.plus(workingDays(6));        // example user-written workingDays method
  

Note that calling plus followed by minus is not guaranteed to return the same date-time.

plus

abstract fun plus(
    amountToAdd: Long, 
    unit: TemporalUnit!
): ChronoZonedDateTime<D>!

Returns an object of the same type as this object with the specified period added.

This method returns a new object based on this one with the specified period added. For example, on a LocalDate, this could be used to add a number of years, months or days. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then adding one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

query

open 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

open fun range(field: TemporalField!): ValueRange!

timeLineOrder

open static fun timeLineOrder(): Comparator<ChronoZonedDateTime<*>!>!

Gets a comparator that compares ChronoZonedDateTime in time-line order ignoring the chronology.

This comparator differs from the comparison in compareTo in that it only compares the underlying instant and not the chronology. This allows dates in different calendar systems to be compared based on the position of the date-time on the instant time-line. The underlying comparison is equivalent to comparing the epoch-second and nano-of-second.

toEpochSecond

open fun toEpochSecond(): Long

Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z.

This uses the local date-time and offset to calculate the epoch-second value, which is the number of elapsed seconds from 1970-01-01T00:00:00Z. Instants on the time-line after the epoch are positive, earlier are negative.

toInstant

open fun toInstant(): Instant!

Converts this date-time to an Instant.

This returns an Instant representing the same point on the time-line as this date-time. The calculation combines the local date-time and offset.

toLocalDate

open fun toLocalDate(): D

Gets the local date part of this date-time.

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

toLocalDateTime

abstract fun toLocalDateTime(): ChronoLocalDateTime<D>!

Gets the local date-time part of this date-time.

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

toLocalTime

open fun toLocalTime(): LocalTime!

Gets the local time part of this date-time.

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

with

open fun with(adjuster: TemporalAdjuster!): ChronoZonedDateTime<D>!

Returns an adjusted object of the same type as this object with the adjustment made.

This adjusts this date-time according to the rules of the specified adjuster. 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". The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.

Some example code indicating how and why this method is used:

date = date.with(Month.JULY);        // most key classes implement TemporalAdjuster
   date = date.with(lastDayOfMonth());  // static import from Adjusters
   date = date.with(next(WEDNESDAY));   // static import from Adjusters and DayOfWeek
  

with

abstract fun with(
    field: TemporalField!, 
    newValue: Long
): ChronoZonedDateTime<D>!

Returns an object of the same type as this object with the specified field altered.

This returns a new object based on this one with the value for the specified field changed. For example, on a LocalDate, this could be used to set the year, month or day-of-month. The returned object will have the same observable type as this object.

In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then changing the month to February would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

withEarlierOffsetAtOverlap

abstract fun withEarlierOffsetAtOverlap(): ChronoZonedDateTime<D>!

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.

withLaterOffsetAtOverlap

abstract fun withLaterOffsetAtOverlap(): ChronoZonedDateTime<D>!

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.

withZoneSameInstant

abstract fun withZoneSameInstant(zone: ZoneId!): ChronoZonedDateTime<D>!

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

abstract fun withZoneSameLocal(zone: ZoneId!): ChronoZonedDateTime<D>!

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.

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.