Skip to content

Most visited

Recently visited

navigation

ChronoZonedDateTime

public interface ChronoZonedDateTime
implements Temporal, Comparable<ChronoZonedDateTime<?>>

java.time.chrono.ChronoZonedDateTime<D extends java.time.chrono.ChronoLocalDate>
Known Indirect Subclasses


A date-time with a time-zone in an arbitrary chronology, intended for advanced globalization use cases.

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.

When to use this interface

The design of the API encourages the use of 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.

Summary

Public methods

default int compareTo(ChronoZonedDateTime<?> other)

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

abstract boolean equals(Object obj)

Checks if this date-time is equal to another date-time.

default String format(DateTimeFormatter formatter)

Formats this date-time using the specified formatter.

static ChronoZonedDateTime<?> from(TemporalAccessor temporal)

Obtains an instance of ChronoZonedDateTime from a temporal object.

default int get(TemporalField field)

Gets the value of the specified field as an int.

default Chronology getChronology()

Gets the chronology of this date-time.

default long getLong(TemporalField field)

Gets the value of the specified field as a long.

abstract ZoneOffset getOffset()

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

abstract ZoneId getZone()

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

abstract int hashCode()

A hash code for this date-time.

default boolean isAfter(ChronoZonedDateTime<?> other)

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

default boolean isBefore(ChronoZonedDateTime<?> other)

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

default boolean isEqual(ChronoZonedDateTime<?> other)

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

default boolean isSupported(TemporalUnit unit)

Checks if the specified unit is supported.

abstract boolean isSupported(TemporalField field)

Checks if the specified field is supported.

default ChronoZonedDateTime<D> minus(TemporalAmount amount)

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

default ChronoZonedDateTime<D> minus(long amountToSubtract, TemporalUnit unit)

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

default ChronoZonedDateTime<D> plus(TemporalAmount amount)

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

abstract ChronoZonedDateTime<D> plus(long amountToAdd, TemporalUnit unit)

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

default <R> R query(TemporalQuery<R> query)

Queries this date-time using the specified query.

default ValueRange range(TemporalField field)

Gets the range of valid values for the specified field.

static Comparator<ChronoZonedDateTime<?>> 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.

abstract ChronoLocalDateTime<D> toLocalDateTime()

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

default LocalTime toLocalTime()

Gets the local time part of this date-time.

abstract String toString()

Outputs this date-time as a String.

abstract ChronoZonedDateTime<D> with(TemporalField field, long newValue)

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

default ChronoZonedDateTime<D> with(TemporalAdjuster adjuster)

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

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

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

abstract ChronoZonedDateTime<D> withZoneSameInstant(ZoneId zone)

Returns a copy of this date-time with a different time-zone, retaining the instant.

abstract ChronoZonedDateTime<D> withZoneSameLocal(ZoneId zone)

Returns a copy of this date-time with a different time-zone, retaining the local date-time if possible.

Inherited methods

From interface java.time.temporal.Temporal
From interface java.lang.Comparable
From interface java.time.temporal.TemporalAccessor

Public methods

compareTo

added in API level 26
int compareTo (ChronoZonedDateTime<?> other)

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.

Parameters
other ChronoZonedDateTime: the other date-time to compare to, not null

Returns
int the comparator value, negative if less, positive if greater

equals

added in API level 26
boolean equals (Object obj)

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 compareTo(T). Only objects of type ChronoZonedDateTime are compared, other types return false.

Parameters
obj Object: the object to check, null returns false

Returns
boolean true if this is equal to the other date-time

format

added in API level 26
String format (DateTimeFormatter formatter)

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);
 

Parameters
formatter DateTimeFormatter: the formatter to use, not null

Returns
String the formatted date-time string, not null

Throws
DateTimeException if an error occurs during printing

from

added in API level 26
ChronoZonedDateTime<?> from (TemporalAccessor temporal)

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

Parameters
temporal TemporalAccessor: the temporal object to convert, not null

Returns
ChronoZonedDateTime<?> the date-time, not null

Throws
DateTimeException if unable to convert to a ChronoZonedDateTime

get

int get (TemporalField field)

Gets the value of the specified field as an 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.

Parameters
field TemporalField: the field to get, not null

Returns
int the value for the field, within the valid range of values

getChronology

added in API level 26
Chronology getChronology ()

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.

Returns
Chronology the chronology, not null

getLong

added in API level 26
long getLong (TemporalField field)

Gets the value of the specified field as a 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.

Parameters
field TemporalField: the field to get, not null

Returns
long the value for the field

getOffset

added in API level 26
ZoneOffset getOffset ()

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

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

Returns
ZoneOffset the zone offset, not null

getZone

added in API level 26
ZoneId getZone ()

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

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

Returns
ZoneId the zone ID, not null

hashCode

added in API level 26
int hashCode ()

A hash code for this date-time.

Returns
int a suitable hash code

isAfter

added in API level 26
boolean isAfter (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 compareTo(T) 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.

Parameters
other ChronoZonedDateTime: the other date-time to compare to, not null

Returns
boolean true if this is after the specified date-time

isBefore

added in API level 26
boolean isBefore (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 compareTo(T) 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.

Parameters
other ChronoZonedDateTime: the other date-time to compare to, not null

Returns
boolean true if this point is before the specified date-time

isEqual

added in API level 26
boolean isEqual (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 compareTo(T) and equals(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.

Parameters
other ChronoZonedDateTime: the other date-time to compare to, not null

Returns
boolean true if the instant equals the instant of the specified date-time

isSupported

added in API level 26
boolean isSupported (TemporalUnit unit)

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

Parameters
unit TemporalUnit: the unit to check, null returns false

Returns
boolean true if the unit can be added/subtracted, false if not

isSupported

added in API level 26
boolean isSupported (TemporalField field)

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

Parameters
field TemporalField: the field to check, null returns false

Returns
boolean true if the field can be queried, false if not

minus

added in API level 27
ChronoZonedDateTime<D> minus (TemporalAmount amount)

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

Parameters
amount TemporalAmount: the amount to subtract, not null

Returns
ChronoZonedDateTime<D> an object of the same type with the specified adjustment made, not null

Throws
DateTimeException
ArithmeticException

minus

added in API level 27
ChronoZonedDateTime<D> minus (long amountToSubtract, 
                TemporalUnit unit)

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.

Parameters
amountToSubtract long: the amount of the specified unit to subtract, may be negative

unit TemporalUnit: the unit of the amount to subtract, not null

Returns
ChronoZonedDateTime<D> an object of the same type with the specified period subtracted, not null

Throws
DateTimeException
ArithmeticException

plus

added in API level 27
ChronoZonedDateTime<D> plus (TemporalAmount amount)

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

Parameters
amount TemporalAmount: the amount to add, not null

Returns
ChronoZonedDateTime<D> an object of the same type with the specified adjustment made, not null

Throws
DateTimeException
ArithmeticException

plus

added in API level 26
ChronoZonedDateTime<D> plus (long amountToAdd, 
                TemporalUnit unit)

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.

Parameters
amountToAdd long: the amount of the specified unit to add, may be negative

unit TemporalUnit: the unit of the amount to add, not null

Returns
ChronoZonedDateTime<D> an object of the same type with the specified period added, not null

Throws
DateTimeException
ArithmeticException

query

R query (TemporalQuery<R> query)

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 queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

Parameters
query TemporalQuery: the query to invoke, not null

Returns
R the query result, null may be returned (defined by the query)

Throws
DateTimeException if unable to query (defined by the query)
ArithmeticException if numeric overflow occurs (defined by the query)

range

ValueRange range (TemporalField field)

Gets the range of valid values for the specified field.

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.

Parameters
field TemporalField: the field to query the range for, not null

Returns
ValueRange the range of valid values for the field, not null

timeLineOrder

added in API level 26
Comparator<ChronoZonedDateTime<?>> timeLineOrder ()

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

This comparator differs from the comparison in compareTo(T) 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.

Returns
Comparator<ChronoZonedDateTime<?>> a comparator that compares in time-line order ignoring the chronology

toEpochSecond

added in API level 26
long toEpochSecond ()

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.

Returns
long the number of seconds from the epoch of 1970-01-01T00:00:00Z

toInstant

added in API level 26
Instant toInstant ()

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.

Returns
Instant an Instant representing the same instant, not null

toLocalDate

added in API level 26
D toLocalDate ()

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.

Returns
D the date part of this date-time, not null

toLocalDateTime

added in API level 26
ChronoLocalDateTime<D> toLocalDateTime ()

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.

Returns
ChronoLocalDateTime<D> the local date-time part of this date-time, not null

toLocalTime

added in API level 26
LocalTime toLocalTime ()

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.

Returns
LocalTime the time part of this date-time, not null

toString

added in API level 26
String toString ()

Outputs this date-time as a String.

The output will include the full zoned date-time.

Returns
String a string representation of this date-time, not null

with

added in API level 26
ChronoZonedDateTime<D> with (TemporalField field, 
                long newValue)

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.

Parameters
field TemporalField: the field to set in the result, not null

newValue long: the new value of the field in the result

Returns
ChronoZonedDateTime<D> an object of the same type with the specified field set, not null

Throws
DateTimeException
ArithmeticException

with

added in API level 27
ChronoZonedDateTime<D> with (TemporalAdjuster adjuster)

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
 

Parameters
adjuster TemporalAdjuster: the adjuster to use, not null

Returns
ChronoZonedDateTime<D> an object of the same type with the specified adjustment made, not null

Throws
DateTimeException
ArithmeticException

withEarlierOffsetAtOverlap

added in API level 26
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.

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.

Returns
ChronoZonedDateTime<D> a ChronoZonedDateTime based on this date-time with the earlier offset, not null

Throws
DateTimeException if no rules can be found for the zone
DateTimeException if no rules are valid for this date-time

withLaterOffsetAtOverlap

added in API level 26
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.

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.

Returns
ChronoZonedDateTime<D> a ChronoZonedDateTime based on this date-time with the later offset, not null

Throws
DateTimeException if no rules can be found for the zone
DateTimeException if no rules are valid for this date-time

withZoneSameInstant

added in API level 26
ChronoZonedDateTime<D> withZoneSameInstant (ZoneId zone)

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(ZoneId).

Parameters
zone ZoneId: the time-zone to change to, not null

Returns
ChronoZonedDateTime<D> a ChronoZonedDateTime based on this date-time with the requested zone, not null

Throws
DateTimeException if the result exceeds the supported date range

withZoneSameLocal

added in API level 26
ChronoZonedDateTime<D> withZoneSameLocal (ZoneId zone)

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(ZoneId).

This instance is immutable and unaffected by this method call.

Parameters
zone ZoneId: the time-zone to change to, not null

Returns
ChronoZonedDateTime<D> a ChronoZonedDateTime based on this date-time with the requested zone, not null

This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience.
(Sep 2017 survey)