* Most applications should declare method signatures, fields and variables * as {@link ZonedDateTime}, not this interface. *
* A {@code ChronoZonedDateTime} is the abstract representation of an offset date-time * where the {@code Chronology chronology}, or calendar system, is pluggable. * The date-time is defined in terms of fields expressed by {@link TemporalField}, * where most common implementations are defined in {@link ChronoField}. * The chronology defines how the calendar system operates and the meaning of * the standard fields. * *
* Ensure that the discussion in {@code ChronoLocalDate} has been read and understood * before using this interface. * *
* This comparator differs from the comparison in {@link #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.
*
* @see #isAfter
* @see #isBefore
* @see #isEqual
*/
static Comparator
* This creates a zoned date-time based on the specified temporal.
* A {@code TemporalAccessor} represents an arbitrary set of date and time information,
* which this factory converts to an instance of {@code ChronoZonedDateTime}.
*
* The conversion extracts and combines the chronology, date, time and zone
* from the temporal object. The behavior is equivalent to using
* {@link 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 {@link TemporalQuery}
* allowing it to be used as a query via method reference, {@code ChronoZonedDateTime::from}.
*
* @param temporal the temporal objec t to convert, not null
* @return the date-time, not null
* @throws DateTimeException if unable to convert to a {@code ChronoZonedDateTime}
* @see Chronology#zonedDateTime(TemporalAccessor)
*/
static ChronoZonedDateTime from(TemporalAccessor temporal) {
if (temporal instanceof ChronoZonedDateTime) {
return (ChronoZonedDateTime) temporal;
}
Chronology chrono = temporal.query(TemporalQuery.chronology());
if (chrono == null) {
throw new DateTimeException("Unable to obtain ChronoZonedDateTime from TemporalAccessor: " + temporal.getClass());
}
return chrono.zonedDateTime(temporal);
}
//-----------------------------------------------------------------------
@Override
default ValueRange range(TemporalField field) {
if (field instanceof ChronoField) {
if (field == INSTANT_SECONDS || field == OFFSET_SECONDS) {
return field.range();
}
return toLocalDateTime().range(field);
}
return field.rangeRefinedBy(this);
}
@Override
default int get(TemporalField field) {
if (field instanceof ChronoField) {
switch ((ChronoField) field) {
case INSTANT_SECONDS:
throw new UnsupportedTemporalTypeException("Invalid field 'InstantSeconds' for get() method, use getLong() instead");
case OFFSET_SECONDS:
return getOffset().getTotalSeconds();
}
return toLocalDateTime().get(field);
}
return Temporal.super.get(field);
}
@Override
default long getLong(TemporalField field) {
if (field instanceof ChronoField) {
switch ((ChronoField) field) {
case INSTANT_SECONDS: return toEpochSecond();
case OFFSET_SECONDS: return getOffset().getTotalSeconds();
}
return toLocalDateTime().getLong(field);
}
return field.getFrom(this);
}
/**
* 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.
*
* @return the date part of this date-time, not null
*/
default D toLocalDate() {
return toLocalDateTime().toLocalDate();
}
/**
* 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.
*
* @return the time part of this date-time, not null
*/
default LocalTime toLocalTime() {
return toLocalDateTime().toLocalTime();
}
/**
* 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.
*
* @return the local date-time part of this date-time, not null
*/
ChronoLocalDateTime
* This is the offset of the local date-time from UTC/Greenwich.
*
* @return the zone offset, not null
*/
ZoneOffset getOffset();
/**
* Gets the zone ID, such as 'Europe/Paris'.
*
* This returns the stored time-zone id used to determine the time-zone rules.
*
* @return the zone ID, not null
*/
ZoneId getZone();
//-----------------------------------------------------------------------
/**
* 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, {@code this}
* is returned.
*
* This instance is immutable and unaffected by this method call.
*
* @return a {@code ZoneChronoDateTime} based on this date-time with the earlier offset, not null
* @throws DateTimeException if no rules can be found for the zone
* @throws DateTimeException if no rules are valid for this date-time
*/
ChronoZonedDateTime
* 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, {@code this}
* is returned.
*
* This instance is immutable and unaffected by this method call.
*
* @return a {@code ChronoZonedDateTime} based on this date-time with the later offset, not null
* @throws DateTimeException if no rules can be found for the zone
* @throws DateTimeException if no rules are valid for this date-time
*/
ChronoZonedDateTime
* 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 {@link #withZoneSameInstant(ZoneId)}.
*
* This instance is immutable and unaffected by this method call.
*
* @param zone the time-zone to change to, not null
* @return a {@code ChronoZonedDateTime} based on this date-time with the requested zone, not null
*/
ChronoZonedDateTime
* 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 {@link #withZoneSameLocal(ZoneId)}.
*
* @param zone the time-zone to change to, not null
* @return a {@code ChronoZonedDateTime} based on this date-time with the requested zone, not null
* @throws DateTimeException if the result exceeds the supported date range
*/
ChronoZonedDateTime
* This queries this date-time using the specified query strategy object.
* The {@code 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
* {@link java.time.temporal.TemporalQuery#queryFrom(TemporalAccessor)} method on the
* specified query passing {@code this} as the argument.
*
* @param
* This date-time will be passed to the formatter to produce a string.
*
* The default implementation must behave as follows:
*
* This returns an {@code Instant} representing the same point on the
* time-line as this date-time. The calculation combines the
* {@linkplain #toLocalDateTime() local date-time} and
* {@linkplain #getOffset() offset}.
*
* @return an {@code Instant} representing the same instant, not null
*/
default Instant toInstant() {
return Instant.ofEpochSecond(toEpochSecond(), toLocalTime().getNano());
}
/**
* Converts this date-time to the number of seconds from the epoch
* of 1970-01-01T00:00:00Z.
*
* This uses the {@linkplain #toLocalDateTime() local date-time} and
* {@linkplain #getOffset() 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.
*
* @return the number of seconds from the epoch of 1970-01-01T00:00:00Z
*/
default long toEpochSecond() {
long epochDay = toLocalDate().toEpochDay();
long secs = epochDay * 86400 + toLocalTime().toSecondOfDay();
secs -= getOffset().getTotalSeconds();
return secs;
}
//-----------------------------------------------------------------------
/**
* 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 {@link 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.
*
* @param other the other date-time to compare to, not null
* @return the comparator value, negative if less, positive if greater
*/
@Override
default int compareTo(ChronoZonedDateTime other) {
int cmp = Long.compare(toEpochSecond(), other.toEpochSecond());
if (cmp == 0) {
cmp = toLocalTime().getNano() - other.toLocalTime().getNano();
if (cmp == 0) {
cmp = toLocalDateTime().compareTo(other.toLocalDateTime());
if (cmp == 0) {
cmp = getZone().getId().compareTo(other.getZone().getId());
if (cmp == 0) {
cmp = toLocalDate().getChronology().compareTo(other.toLocalDate().getChronology());
}
}
}
}
return cmp;
}
/**
* Checks if the instant of this date-time is before that of the specified date-time.
*
* This method differs from the comparison in {@link #compareTo} in that it
* only compares the instant of the date-time. This is equivalent to using
* {@code dateTime1.toInstant().isBefore(dateTime2.toInstant());}.
*
* This default implementation performs the comparison based on the epoch-second
* and nano-of-second.
*
* @param other the other date-time to compare to, not null
* @return true if this point is before the specified date-time
*/
default boolean isBefore(ChronoZonedDateTime other) {
long thisEpochSec = toEpochSecond();
long otherEpochSec = other.toEpochSecond();
return thisEpochSec < otherEpochSec ||
(thisEpochSec == otherEpochSec && toLocalTime().getNano() < other.toLocalTime().getNano());
}
/**
* Checks if the instant of this date-time is after that of the specified date-time.
*
* This method differs from the comparison in {@link #compareTo} in that it
* only compares the instant of the date-time. This is equivalent to using
* {@code dateTime1.toInstant().isAfter(dateTime2.toInstant());}.
*
* This default implementation performs the comparison based on the epoch-second
* and nano-of-second.
*
* @param other the other date-time to compare to, not null
* @return true if this is after the specified date-time
*/
default boolean isAfter(ChronoZonedDateTime other) {
long thisEpochSec = toEpochSecond();
long otherEpochSec = other.toEpochSecond();
return thisEpochSec > otherEpochSec ||
(thisEpochSec == otherEpochSec && toLocalTime().getNano() > other.toLocalTime().getNano());
}
/**
* Checks if the instant of this date-time is equal to that of the specified date-time.
*
* This method differs from the comparison in {@link #compareTo} and {@link #equals}
* in that it only compares the instant of the date-time. This is equivalent to using
* {@code dateTime1.toInstant().equals(dateTime2.toInstant());}.
*
* This default implementation performs the comparison based on the epoch-second
* and nano-of-second.
*
* @param other the other date-time to compare to, not null
* @return true if the instant equals the instant of the specified date-time
*/
default boolean isEqual(ChronoZonedDateTime other) {
return toEpochSecond() == other.toEpochSecond() &&
toLocalTime().getNano() == other.toLocalTime().getNano();
}
//-----------------------------------------------------------------------
/**
* Checks if this date-time is equal to another date-time.
*
* The comparison is based on the offset date-time and the zone.
* To compare for the same instant on the time-line, use {@link #compareTo}.
* Only objects of type {@code ChronoZonedDateTime} are compared, other types return false.
*
* @param obj the object to check, null returns false
* @return true if this is equal to the other date-time
*/
@Override
boolean equals(Object obj);
/**
* A hash code for this date-time.
*
* @return a suitable hash code
*/
@Override
int hashCode();
//-----------------------------------------------------------------------
/**
* Outputs this date-time as a {@code String}.
*
* The output will include the full zoned date-time.
*
* @return a string representation of this date-time, not null
*/
@Override
String toString();
}
* return formatter.format(this);
*
*
* @param formatter the formatter to use, not null
* @return the formatted date-time string, not null
* @throws DateTimeException if an error occurs during printing
*/
default String format(DateTimeFormatter formatter) {
Objects.requireNonNull(formatter, "formatter");
return formatter.format(this);
}
//-----------------------------------------------------------------------
/**
* Converts this date-time to an {@code Instant}.
*