Package org.threeten.bp.chrono

Class ChronoZonedDateTime<D extends ChronoLocalDate>

  • Type Parameters:
    D - the date type
    All Implemented Interfaces:
    Comparable<ChronoZonedDateTime<?>>, Temporal, TemporalAccessor
    Direct Known Subclasses:
    ZonedDateTime
    public abstract class ChronoZonedDateTime<D extends ChronoLocalDate>
extends DefaultInterfaceTemporal
implements Temporal, Comparable<ChronoZonedDateTime<?>>
    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.

    Specification for implementors

    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.

    In JDK 8, this is an interface with default methods. Since there are no default methods in JDK 7, an abstract class is used.

    • Constructor Detail

      • ChronoZonedDateTime

        public ChronoZonedDateTime()

    • Method Detail

      • from

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

        Parameters:
        temporal - the temporal object to convert, not null
        Returns:
        the date-time, not null
        Throws:
        DateTimeException - if unable to convert to a ChronoZonedDateTime
        See Also:
        Chronology.zonedDateTime(TemporalAccessor)

      • range

        public ValueRange range​(TemporalField field)
        Description copied from interface: TemporalAccessor
        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.

        Specification for implementors

        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 a DateTimeException 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 not alter either this object.

        Specified by:
        range in interface TemporalAccessor
        Overrides:
        range in class DefaultInterfaceTemporalAccessor
        Parameters:
        field - the field to query the range for, not null
        Returns:
        the range of valid values for the field, not null

      • get

        public int get​(TemporalField field)
        Description copied from interface: TemporalAccessor
        Gets the value of the specified field as an int.

        This queries the date-time for the value for 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.

        Specification for implementors

        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 a DateTimeException 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 not alter either this object.

        Specified by:
        get in interface TemporalAccessor
        Overrides:
        get in class DefaultInterfaceTemporalAccessor
        Parameters:
        field - the field to get, not null
        Returns:
        the value for the field, within the valid range of values

      • getLong

        public long getLong​(TemporalField field)
        Description copied from interface: TemporalAccessor
        Gets the value of the specified field as a long.

        This queries the date-time for the value for 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.

        Specification for implementors

        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 a DateTimeException 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 not alter either this object.

        Specified by:
        getLong in interface TemporalAccessor
        Parameters:
        field - the field to get, not null
        Returns:
        the value for the field

      • toLocalDate

        public 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:
        the date part of this date-time, not null

      • toLocalTime

        public 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:
        the time part of this date-time, not null

      • toLocalDateTime

        public abstract 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:
        the local date-time part of this date-time, not null

      • getChronology

        public 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:
        the chronology, not null

      • getOffset

        public abstract ZoneOffset getOffset()
        Gets the zone offset, such as '+01:00'.

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

        Returns:
        the zone offset, not null

      • getZone

        public abstract 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:
        the zone ID, not null

      • withEarlierOffsetAtOverlap

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

        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:
        a ZoneChronoDateTime 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

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

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

      • withZoneSameLocal

        public abstract ChronoZonedDateTime<D> withZoneSameLocal​(ZoneId zoneId)
        Returns a copy of this ZonedDateTime 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:
        zoneId - the time-zone to change to, not null
        Returns:
        a ChronoZonedDateTime based on this date-time with the requested zone, not null

      • withZoneSameInstant

        public abstract ChronoZonedDateTime<D> withZoneSameInstant​(ZoneId zoneId)
        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:
        zoneId - the time-zone to change to, not null
        Returns:
        a ChronoZonedDateTime based on this date-time with the requested zone, not null
        Throws:
        DateTimeException - if the result exceeds the supported date range

      • with

        public ChronoZonedDateTime<D> with​(TemporalAdjuster adjuster)
        Description copied from interface: Temporal
        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 TemporalAdjusters
  date = date.with(next(WEDNESDAY));   // static import from TemporalAdjusters and DayOfWeek

        Specification for implementors

        Implementations must not alter either this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
        Specified by:
        with in interface Temporal
        Overrides:
        with in class DefaultInterfaceTemporal
        Parameters:
        adjuster - the adjuster to use, not null
        Returns:
        an object of the same type with the specified adjustment made, not null

      • with

        public abstract ChronoZonedDateTime<D> with​(TemporalField field,
                                            long newValue)
        Description copied from interface: Temporal
        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.

        Specification for implementors

        Implementations must check and handle all fields defined in ChronoField. If the field is supported, then the adjustment must be performed. If unsupported, then a DateTimeException 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 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.

        Specified by:
        with in interface Temporal
        Parameters:
        field - the field to set in the result, not null
        newValue - the new value of the field in the result
        Returns:
        an object of the same type with the specified field set, not null

      • plus

        public ChronoZonedDateTime<D> plus​(TemporalAmount amount)
        Description copied from interface: Temporal
        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.

        Specification for implementors

        Implementations must not alter either this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
        Specified by:
        plus in interface Temporal
        Overrides:
        plus in class DefaultInterfaceTemporal
        Parameters:
        amount - the amount to add, not null
        Returns:
        an object of the same type with the specified adjustment made, not null

      • plus

        public abstract ChronoZonedDateTime<D> plus​(long amountToAdd,
                                            TemporalUnit unit)
        Description copied from interface: Temporal
        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.

        If the implementation represents a date-time that has boundaries, such as LocalTime, then the permitted units must include the boundary unit, but no multiples of the boundary unit. For example, LocalTime must accept DAYS but not WEEKS or MONTHS.

        Specification for implementors

        Implementations must check and handle all units defined in ChronoUnit. If the unit is supported, then the addition must be performed. If unsupported, then a DateTimeException 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 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.

        Specified by:
        plus in interface Temporal
        Parameters:
        amountToAdd - the amount of the specified unit to add, may be negative
        unit - the unit of the period to add, not null
        Returns:
        an object of the same type with the specified period added, not null

      • minus

        public ChronoZonedDateTime<D> minus​(TemporalAmount amount)
        Description copied from interface: Temporal
        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.

        Specification for implementors

        Implementations must not alter either this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
        Specified by:
        minus in interface Temporal
        Overrides:
        minus in class DefaultInterfaceTemporal
        Parameters:
        amount - the amount to subtract, not null
        Returns:
        an object of the same type with the specified adjustment made, not null

      • minus

        public ChronoZonedDateTime<D> minus​(long amountToSubtract,
                                    TemporalUnit unit)
        Description copied from interface: Temporal
        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.

        If the implementation represents a date-time that has boundaries, such as LocalTime, then the permitted units must include the boundary unit, but no multiples of the boundary unit. For example, LocalTime must accept DAYS but not WEEKS or MONTHS.

        Specification for implementors

        Implementations must behave in a manor equivalent to the default method behavior.

        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.

        Specified by:
        minus in interface Temporal
        Overrides:
        minus in class DefaultInterfaceTemporal
        Parameters:
        amountToSubtract - the amount of the specified unit to subtract, may be negative
        unit - the unit of the period to subtract, not null
        Returns:
        an object of the same type with the specified period subtracted, not null

      • query

        public <R> R query​(TemporalQuery<R> query)
        Description copied from interface: TemporalAccessor
        Queries this date-time.

        This queries this date-time using the specified query strategy object.

        Queries are a key tool for extracting information from date-times. They exists to externalize the process of querying, permitting different approaches, as per the strategy design pattern. Examples might be a query that checks if the date is the day before February 29th in a leap year, or calculates the number of days to your next birthday.

        The most common query implementations are method references, such as LocalDate::from and ZoneId::from. Further implementations are on TemporalQueries. Queries may also be defined by applications.

        Specification for implementors

        Implementations of this method must behave as follows: 
           public <R> R query(TemporalQuery<R> type) {
     // only include an if statement if the implementation can return it
     if (query == TemporalQueries.zoneId())  return // the ZoneId
     if (query == TemporalQueries.chronology())  return // the Chrono
     if (query == TemporalQueries.precision())  return // the precision
     // call default method
     return super.query(query);
   }
        Specified by:
        query in interface TemporalAccessor
        Overrides:
        query in class DefaultInterfaceTemporalAccessor
        Type Parameters:
        R - the type of the result
        Parameters:
        query - the query to invoke, not null
        Returns:
        the query result, null may be returned (defined by the query)

      • format

        public String format​(DateTimeFormatter formatter)
        Outputs this date-time as a String using the formatter.
        Parameters:
        formatter - the formatter to use, not null
        Returns:
        the formatted date-time string, not null
        Throws:
        DateTimeException - if an error occurs during printing

      • toInstant

        public 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:
        an Instant representing the same instant, not null

      • toEpochSecond

        public 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:
        the number of seconds from the epoch of 1970-01-01T00:00:00Z

      • compareTo

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

        Specified by:
        compareTo in interface Comparable<D extends ChronoLocalDate>
        Parameters:
        other - the other date-time to compare to, not null
        Returns:
        the comparator value, negative if less, positive if greater

      • isAfter

        public 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(org.threeten.bp.chrono.ChronoZonedDateTime<?>) in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().isAfter(dateTime2.toInstant());.

        Parameters:
        other - the other date-time to compare to, not null
        Returns:
        true if this is after the specified date-time

      • isBefore

        public 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(org.threeten.bp.chrono.ChronoZonedDateTime<?>) in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().isBefore(dateTime2.toInstant());.

        Parameters:
        other - the other date-time to compare to, not null
        Returns:
        true if this point is before the specified date-time

      • isEqual

        public 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(org.threeten.bp.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());.

        Parameters:
        other - the other date-time to compare to, not null
        Returns:
        true if the instant equals the instant of the specified date-time

      • equals

        public 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(org.threeten.bp.chrono.ChronoZonedDateTime<?>). Only objects of type ChronoZoneDateTime are compared, other types return false.

        Overrides:
        equals in class Object
        Parameters:
        obj - the object to check, null returns false
        Returns:
        true if this is equal to the other date-time

      • hashCode

        public int hashCode()
        A hash code for this date-time.
        Overrides:
        hashCode in class Object
        Returns:
        a suitable hash code

      • toString

        public String toString()
        Outputs this date-time as a String.

        The output will include the full zoned date-time and the chronology ID.

        Overrides:
        toString in class Object
        Returns:
        a string representation of this date-time, not null