D
- the concrete type for the date of this date-time
since 1.8public 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.
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.
Modifier and Type | Method and Description |
---|---|
int |
compareTo(ChronoZonedDateTime<?> other)
Compares this date-time to another date-time, including the chronology.
|
boolean |
equals(Object obj)
Checks if this date-time is equal to another date-time.
|
int |
get(TemporalField field)
Gets the value of the specified field as an
int . |
Chronology |
getChronology()
Gets the chronology of this date-time.
|
long |
getLong(TemporalField field)
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.
|
boolean |
isAfter(ChronoZonedDateTime<?> other)
Checks if the instant of this date-time is after that of the specified date-time.
|
boolean |
isBefore(ChronoZonedDateTime<?> other)
Checks if the instant of this date-time is before that of the specified date-time.
|
boolean |
isEqual(ChronoZonedDateTime<?> other)
Checks if the instant of this date-time is equal to that of the specified date-time.
|
boolean |
isSupported(TemporalField field)
Checks if the specified field is supported.
|
boolean |
isSupported(TemporalUnit unit)
Checks if the specified unit is supported.
|
ChronoZonedDateTime<D> |
minus(long amountToSubtract,
TemporalUnit unit)
Returns an object of the same type as this object with the specified period subtracted.
|
ChronoZonedDateTime<D> |
minus(TemporalAmount amount)
Returns an object of the same type as this object with an amount subtracted.
|
ChronoZonedDateTime<D> |
plus(long amountToAdd,
TemporalUnit unit)
Returns an object of the same type as this object with the specified period added.
|
ChronoZonedDateTime<D> |
plus(TemporalAmount amount)
Returns an object of the same type as this object with an amount added.
|
<R> R |
query(TemporalQuery<R> query)
Queries this date-time using the specified query.
|
ValueRange |
range(TemporalField field)
Gets the range of valid values for the specified field.
|
long |
toEpochSecond()
Converts this date-time to the number of seconds from the epoch
of 1970-01-01T00:00:00Z.
|
Instant |
toInstant()
Converts this date-time to an
Instant . |
D |
toLocalDate()
Gets the local date part of this date-time.
|
ChronoLocalDateTime<D> |
toLocalDateTime()
Gets the local date-time part of this date-time.
|
LocalTime |
toLocalTime()
Gets the local time part of this date-time.
|
String |
toString()
Outputs this date-time as a
String . |
ChronoZonedDateTime<D> |
with(TemporalAdjuster adjuster)
Returns an adjusted object of the same type as this object with the adjustment made.
|
ChronoZonedDateTime<D> |
with(TemporalField field,
long newValue)
Returns an object of the same type as this object with the specified field altered.
|
ChronoZonedDateTime<D> |
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<D> |
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<D> |
withZoneSameInstant(ZoneId zone)
Returns a copy of this date-time with a different time-zone,
retaining the instant.
|
ChronoZonedDateTime<D> |
withZoneSameLocal(ZoneId zone)
Returns a copy of this date-time with a different time-zone,
retaining the local date-time if possible.
|
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<ChronoZonedDateTime<?>>
other
- the other date-time to compare to, not nullboolean equals(@Nullable 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.
equals
in class Object
obj
- the object to check, null returns falseObject.hashCode()
,
HashMap
int get(TemporalField field)
TemporalAccessor
int
.
This queries the 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 the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.
Implementations must check and handle all fields defined in ChronoField
. If the field is
supported and has an int
range, then the value of the field must be returned. If unsupported,
then an UnsupportedTemporalTypeException
must be thrown.
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.
Implementations must ensure that no observable state is altered when this read-only method is invoked.
The default implementation must behave equivalent to this code:
if (range(field).isIntValue()) { return range(field).checkValidIntValue(getLong(field), field); } throw new UnsupportedTemporalTypeException( "Invalid field " + field + " + for get() method, use getLong() instead");
get
in interface TemporalAccessor
field
- the field to get, not nullChronology getChronology()
The Chronology
represents the calendar system in use.
The era and other fields in ChronoField
are defined by the chronology.
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.
Implementations must check and handle all fields defined in ChronoField
. If the field is
supported, then the value of the field must be returned. If unsupported, then an
UnsupportedTemporalTypeException
must be thrown.
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.
Implementations must ensure that no observable state is altered when this read-only method is invoked.
getLong
in interface TemporalAccessor
field
- the field to get, not nullZoneOffset 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.
int hashCode()
hashCode
in class Object
Object.equals(java.lang.Object)
,
System.identityHashCode(java.lang.Object)
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 nullboolean 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 nullboolean 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 isSupported(@Nullable 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 falseboolean isSupported(@Nullable 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 falseChronoZonedDateTime<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.
Implementations must behave in a manor equivalent to the default method behavior.
Implementations must not alter this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
The default implementation must behave equivalent to this code:
return (amountToSubtract == Long.MIN_VALUE ? plus(Long.MAX_VALUE, unit).plus(1, unit) : plus(-amountToSubtract, unit));
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 subtractedChronoZonedDateTime<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.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
The default implementation must behave equivalent to this code:
return amount.subtractFrom(this);
minus
in interface Temporal
amount
- the amount to subtract, not nullDateTimeException
- if the subtraction cannot be madeChronoZonedDateTime<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.
Implementations must check and handle all units defined in ChronoUnit
. If the unit is
supported, then the addition must be performed. If unsupported, then an
UnsupportedTemporalTypeException
must be thrown.
If the unit is not a ChronoUnit
, then the result of this method is obtained by invoking
TemporalUnit.addTo(Temporal, long)
passing this
as the first argument.
Implementations must not alter this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
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 addedChronoZonedDateTime<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.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
The default implementation must behave equivalent to this code:
return amount.addTo(this);
plus
in interface Temporal
amount
- the amount to add, not nullDateTimeException
- if the addition cannot be made@Nullable <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)ValueRange range(TemporalField field)
TemporalAccessor
All fields can be expressed as a long
integer. This method returns an object that describes the valid
range for that value. The value of this temporal object is used to enhance the accuracy of the returned range. If
the date-time cannot return the range, because the field is unsupported or for some other reason, an exception
will be thrown.
Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.
Implementations must check and handle all fields defined in ChronoField
. If the field is
supported, then the range of the field must be returned. If unsupported, then an
UnsupportedTemporalTypeException
must be thrown.
If the field is not a ChronoField
, then the result of this method is obtained by invoking
TemporalField.rangeRefinedBy(TemporalAccessorl)
passing this
as the argument.
Implementations must ensure that no observable state is altered when this read-only method is invoked.
The default implementation must behave equivalent to this code:
if (field instanceof ChronoField) { if (isSupported(field)) { return field.range(); } throw new UnsupportedTemporalTypeException("Unsupported field: " + field); } return field.rangeRefinedBy(this);
range
in interface TemporalAccessor
field
- the field to query the range for, not nulllong 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.
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 nullD toLocalDate()
This returns a local date with the same year, month and day as this date-time.
ChronoLocalDateTime<D> toLocalDateTime()
This returns a local date with the same year, month and day as this date-time.
LocalTime toLocalTime()
This returns a local time with the same hour, minute, second and nanosecond as this date-time.
String toString()
String
.
The output will include the full zoned date-time.
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 DayOfWeekimplSpec
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
The default implementation must behave equivalent to this code:
return adjuster.adjustInto(this);
with
in interface Temporal
adjuster
- the adjuster to use, not nullDateTimeException
- if unable to make the adjustmentChronoZonedDateTime<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.
Implementations must check and handle all fields defined in ChronoField
. If the field is
supported, then the adjustment must be performed. If unsupported, then an
UnsupportedTemporalTypeException
must be thrown.
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 first argument.
Implementations must not alter this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
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 setChronoZonedDateTime<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> 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 rangeChronoZonedDateTime<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 null