D
- the concrete type for the date of this date-timeComparable<ChronoZonedDateTime<?>>
, Temporal
, TemporalAccessor
ZonedDateTime
public interface ChronoZonedDateTime<D extends ChronoLocalDate> extends Temporal, Comparable<ChronoZonedDateTime<?>>
Most applications should declare method signatures, fields and variables as ZonedDateTime
, not this interface.
A ChronoZonedDateTime
is the abstract representation of an offset date-time where the Chronology chronology
, or calendar system, is pluggable. The date-time is defined in terms of fields expressed by TemporalField
, where most common implementations are defined in ChronoField
. The chronology defines how the calendar system operates and the meaning of the standard fields.
ZonedDateTime
rather than this interface, even in the case where the application needs to deal with multiple calendar systems. The rationale for this is explored in detail in ChronoLocalDate
. Ensure that the discussion in ChronoLocalDate
has been read and understood before using this interface.
Modifier and Type | Method | Description |
---|---|---|
default int |
compareTo |
Compares this date-time to another date-time, including the chronology. |
boolean |
equals |
Checks if this date-time is equal to another date-time. |
default String |
format |
Formats this date-time using the specified formatter. |
static ChronoZonedDateTime |
from |
Obtains an instance of ChronoZonedDateTime from a temporal object. |
default Chronology |
getChronology() |
Gets the chronology of this date-time. |
default long |
getLong |
Gets the value of the specified field as a long . |
ZoneOffset |
getOffset() |
Gets the zone offset, such as '+01:00'. |
ZoneId |
getZone() |
Gets the zone ID, such as 'Europe/Paris'. |
int |
hashCode() |
A hash code for this date-time. |
default boolean |
isAfter |
Checks if the instant of this date-time is after that of the specified date-time. |
default boolean |
isBefore |
Checks if the instant of this date-time is before that of the specified date-time. |
default boolean |
isEqual |
Checks if the instant of this date-time is equal to that of the specified date-time. |
boolean |
isSupported |
Checks if the specified field is supported. |
default boolean |
isSupported |
Checks if the specified unit is supported. |
default ChronoZonedDateTime |
minus |
Returns an object of the same type as this object with the specified period subtracted. |
default ChronoZonedDateTime |
minus |
Returns an object of the same type as this object with an amount subtracted. |
ChronoZonedDateTime |
plus |
Returns an object of the same type as this object with the specified period added. |
default ChronoZonedDateTime |
plus |
Returns an object of the same type as this object with an amount added. |
default <R> R |
query |
Queries this date-time using the specified query. |
static Comparator |
timeLineOrder() |
Gets a comparator that compares ChronoZonedDateTime in time-line order ignoring the chronology. |
default long |
toEpochSecond() |
Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z. |
default Instant |
toInstant() |
Converts this date-time to an Instant . |
default D |
toLocalDate() |
Gets the local date part of this date-time. |
ChronoLocalDateTime |
toLocalDateTime() |
Gets the local date-time part of this date-time. |
default LocalTime |
toLocalTime() |
Gets the local time part of this date-time. |
String |
toString() |
Outputs this date-time as a String . |
default ChronoZonedDateTime |
with |
Returns an adjusted object of the same type as this object with the adjustment made. |
ChronoZonedDateTime |
with |
Returns an object of the same type as this object with the specified field altered. |
ChronoZonedDateTime |
withEarlierOffsetAtOverlap() |
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. |
ChronoZonedDateTime |
withLaterOffsetAtOverlap() |
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. |
ChronoZonedDateTime |
withZoneSameInstant |
Returns a copy of this date-time with a different time-zone, retaining the instant. |
ChronoZonedDateTime |
withZoneSameLocal |
Returns a copy of this date-time with a different time-zone, retaining the local date-time if possible. |
get, range
static Comparator<ChronoZonedDateTime<?>> timeLineOrder()
ChronoZonedDateTime
in time-line order ignoring the chronology. This comparator differs from the comparison in compareTo(java.time.chrono.ChronoZonedDateTime<?>)
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.
static ChronoZonedDateTime<?> from(TemporalAccessor temporal)
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
.
temporal
- the temporal object to convert, not nullDateTimeException
- if unable to convert to a ChronoZonedDateTime
default long getLong(TemporalField field)
TemporalAccessor
long
. This queries the date-time for the value of the specified field. The returned value may be outside the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.
getLong
in interface TemporalAccessor
field
- the field to get, not nulldefault D toLocalDate()
This returns a local date with the same year, month and day as this date-time.
default LocalTime toLocalTime()
This returns a local time with the same hour, minute, second and nanosecond as this date-time.
ChronoLocalDateTime<D> toLocalDateTime()
This returns a local date with the same year, month and day as this date-time.
default Chronology getChronology()
The Chronology
represents the calendar system in use. The era and other fields in ChronoField
are defined by the chronology.
ZoneOffset getOffset()
This is the offset of the local date-time from UTC/Greenwich.
ZoneId getZone()
This returns the stored time-zone id used to determine the time-zone rules.
ChronoZonedDateTime<D> withEarlierOffsetAtOverlap()
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.
ChronoZonedDateTime
based on this date-time with the earlier offset, not nullDateTimeException
- if no rules can be found for the zoneDateTimeException
- if no rules are valid for this date-timeChronoZonedDateTime<D> withLaterOffsetAtOverlap()
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.
ChronoZonedDateTime
based on this date-time with the later offset, not nullDateTimeException
- if no rules can be found for the zoneDateTimeException
- if no rules are valid for this date-timeChronoZonedDateTime<D> withZoneSameLocal(ZoneId zone)
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(ZoneId)
.
This instance is immutable and unaffected by this method call.
zone
- the time-zone to change to, not nullChronoZonedDateTime
based on this date-time with the requested zone, not nullChronoZonedDateTime<D> withZoneSameInstant(ZoneId zone)
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(ZoneId)
.
zone
- the time-zone to change to, not nullChronoZonedDateTime
based on this date-time with the requested zone, not nullDateTimeException
- if the result exceeds the supported date rangeboolean isSupported(TemporalField field)
This checks if the specified field can be queried on this date-time. If false, then calling the range
, get
and with(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
in interface TemporalAccessor
field
- the field to check, null returns falsedefault boolean isSupported(TemporalUnit unit)
This checks if the specified unit can be added to or subtracted from this date-time. If false, then calling the plus(long, 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.
isSupported
in interface Temporal
unit
- the unit to check, null returns falsedefault ChronoZonedDateTime<D> with(TemporalAdjuster adjuster)
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
in interface Temporal
adjuster
- the adjuster to use, not nullDateTimeException
- if unable to make the adjustmentArithmeticException
- if numeric overflow occursChronoZonedDateTime<D> with(TemporalField field, long newValue)
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.
with
in interface Temporal
field
- the field to set in the result, not nullnewValue
- the new value of the field in the resultDateTimeException
- if the field cannot be setArithmeticException
- if numeric overflow occursdefault ChronoZonedDateTime<D> plus(TemporalAmount amount)
This adjusts this temporal, adding according to the rules of the specified amount. The amount is typically a Period
but may be any other type implementing the TemporalAmount
interface, such as 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
in interface Temporal
amount
- the amount to add, not nullDateTimeException
- if the addition cannot be madeArithmeticException
- if numeric overflow occursChronoZonedDateTime<D> plus(long amountToAdd, TemporalUnit unit)
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.
plus
in interface Temporal
amountToAdd
- the amount of the specified unit to add, may be negativeunit
- the unit of the amount to add, not nullDateTimeException
- if the unit cannot be addedArithmeticException
- if numeric overflow occursdefault ChronoZonedDateTime<D> minus(TemporalAmount amount)
This adjusts this temporal, subtracting according to the rules of the specified amount. The amount is typically a Period
but may be any other type implementing the TemporalAmount
interface, such as 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
in interface Temporal
amount
- the amount to subtract, not nullDateTimeException
- if the subtraction cannot be madeArithmeticException
- if numeric overflow occursdefault ChronoZonedDateTime<D> minus(long amountToSubtract, TemporalUnit unit)
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.
minus
in interface Temporal
amountToSubtract
- the amount of the specified unit to subtract, may be negativeunit
- the unit of the amount to subtract, not nullDateTimeException
- if the unit cannot be subtractedArithmeticException
- if numeric overflow occursdefault <R> R query(TemporalQuery<R> 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.
query
in interface TemporalAccessor
R
- the type of the resultquery
- the query to invoke, not nullDateTimeException
- if unable to query (defined by the query)ArithmeticException
- if numeric overflow occurs (defined by the query)default String format(DateTimeFormatter 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);
formatter
- the formatter to use, not nullDateTimeException
- if an error occurs during printingdefault Instant toInstant()
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.
Instant
representing the same instant, not nulldefault long toEpochSecond()
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.
default int compareTo(ChronoZonedDateTime<?> other)
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.
compareTo
in interface Comparable<D extends ChronoLocalDate>
other
- the other date-time to compare to, not nullother
values for the instant, the local date-time, the zone ID, and the chronology, in order, returning the first non-zero result, and otherwise returning zerodefault boolean isBefore(ChronoZonedDateTime<?> other)
This method differs from the comparison in compareTo(java.time.chrono.ChronoZonedDateTime<?>)
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.
other
- the other date-time to compare to, not nulldefault boolean isAfter(ChronoZonedDateTime<?> other)
This method differs from the comparison in compareTo(java.time.chrono.ChronoZonedDateTime<?>)
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.
other
- the other date-time to compare to, not nulldefault boolean isEqual(ChronoZonedDateTime<?> other)
This method differs from the comparison in compareTo(java.time.chrono.ChronoZonedDateTime<?>)
and equals(java.lang.Object)
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.
other
- the other date-time to compare to, not nullboolean equals(Object obj)
The comparison is based on the offset date-time and the zone. To compare for the same instant on the time-line, use compareTo(java.time.chrono.ChronoZonedDateTime<?>)
. Only objects of type ChronoZonedDateTime
are compared, other types return false.
int hashCode()
String toString()
String
. The output will include the full zoned date-time.
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/chrono/ChronoZonedDateTime.html