* 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 interface must be implemented with care to ensure other classes operate correctly.
* All implementations that can be instantiated must be final, immutable and thread-safe.
* Subclasses should be Serializable wherever possible.
*
* @param
* 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
*/
D 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
*/
LocalTime 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
* The {@code Chronology} represents the calendar system in use.
* The era and other fields in {@link ChronoField} are defined by the chronology.
*
* @return the chronology, not null
*/
Chronology getChronology();
/**
* Gets the zone offset, such as '+01:00'.
*
* 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 ChronoZonedDateTime} 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 checks if the specified field can be queried on this date-time.
* If false, then calling the {@link #range(TemporalField) range},
* {@link #get(TemporalField) get} and {@link #with(TemporalField, long)}
* methods will throw an exception.
*
* The set of supported fields is defined by the chronology and normally includes
* all {@code ChronoField} fields.
*
* If the field is not a {@code ChronoField}, then the result of this method
* is obtained by invoking {@code TemporalField.isSupportedBy(TemporalAccessor)}
* passing {@code this} as the argument.
* Whether the field is supported is determined by the field.
*
* @param field the field to check, null returns false
* @return true if the field can be queried, false if not
*/
@Override
boolean isSupported(@Nullable TemporalField field);
/**
* 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 {@link #plus(long, TemporalUnit)} and
* {@link #minus(long, TemporalUnit) minus} methods will throw an exception.
*
* The set of supported units is defined by the chronology and normally includes
* all {@code ChronoUnit} units except {@code FOREVER}.
*
* If the unit is not a {@code ChronoUnit}, then the result of this method
* is obtained by invoking {@code TemporalUnit.isSupportedBy(Temporal)}
* passing {@code this} as the argument.
* Whether the unit is supported is determined by the unit.
*
* @param unit the unit to check, null returns false
* @return true if the unit can be added/subtracted, false if not
*/
@Override
boolean isSupported(@Nullable TemporalUnit unit);
//-----------------------------------------------------------------------
// override for covariant return type
/**
* {@inheritDoc}
* @throws DateTimeException {@inheritDoc}
*
*/
@Override
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 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
*/
Instant toInstant();
/**
* 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
*/
long toEpochSecond();
//-----------------------------------------------------------------------
/**
* 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
int compareTo(ChronoZonedDateTime other);
/**
* 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
*/
boolean isBefore(ChronoZonedDateTime other);
/**
* 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
*/
boolean isAfter(ChronoZonedDateTime other);
/**
* 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
*/
boolean isEqual(ChronoZonedDateTime other);
//-----------------------------------------------------------------------
/**
* 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(@Nullable 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
// */
// String format(DateTimeFormatter formatter);
//-----------------------------------------------------------------------
/**
* Converts this date-time to an {@code Instant}.
*