Class/Object

java.time

ZonedDateTime

Related Docs: object ZonedDateTime | package time

Permalink

final class ZonedDateTime extends ChronoZonedDateTime[LocalDate] with Temporal with Serializable

A date-time with a time-zone in the ISO-8601 calendar system, such as 2007-12-03T10:15:30+01:00 Europe/Paris.

ZonedDateTime is an immutable representation of a date-time with a time-zone. This class stores all date and time fields, to a precision of nanoseconds, and a time-zone, with a zone offset used to handle ambiguous local date-times. For example, the value "2nd October 2007 at 13:45.30.123456789 +02:00 in the Europe/Paris time-zone" can be stored in a ZonedDateTime.

This class handles conversion from the local time-line of LocalDateTime to the instant time-line of Instant. The difference between the two time-lines is the offset from UTC/Greenwich, represented by a ZoneOffset.

Converting between the two time-lines involves calculating the offset using the rules accessed from the ZoneId. Obtaining the offset for an instant is simple, as there is exactly one valid offset for each instant. By contrast, obtaining the offset for a local date-time is not straightforward. There are three cases:

Any method that converts directly or implicitly from a local date-time to an instant by obtaining the offset has the potential to be complicated.

For Gaps, the general strategy is that if the local date-time falls in the middle of a Gap, then the resulting zoned date-time will have a local date-time shifted forwards by the length of the Gap, resulting in a date-time in the later offset, typically "summer" time.

For Overlaps, the general strategy is that if the local date-time falls in the middle of an Overlap, then the previous offset will be retained. If there is no previous offset, or the previous offset is invalid, then the earlier offset is used, typically "summer" time.. Two additional methods, #withEarlierOffsetAtOverlap() and #withLaterOffsetAtOverlap(), help manage the case of an overlap.

Specification for implementors

A ZonedDateTime holds state equivalent to three separate objects, a LocalDateTime, a ZoneId and the resolved ZoneOffset. The offset and local date-time are used to define an instant when necessary. The zone ID is used to obtain the rules for how and when the offset changes. The offset cannot be freely set, as the zone controls which offsets are valid.

This class is immutable and thread-safe.

Annotations
@SerialVersionUID()
Linear Supertypes
Ordering
  1. Alphabetic
  2. By Inheritance
Inherited
  1. ZonedDateTime
  2. Serializable
  3. ChronoZonedDateTime
  4. Ordered
  5. Comparable
  6. Temporal
  7. TemporalAccessor
  8. AnyRef
  9. Any
  1. Hide All
  2. Show All
Visibility
  1. Public
  2. All

Instance Constructors

  1. new ZonedDateTime(dateTime: LocalDateTime, offset: ZoneOffset, zone: ZoneId)

    Permalink

    dateTime

    the date-time, validated as not null

    offset

    the zone offset, validated as not null

    zone

    the time-zone, validated as not null

Value Members

  1. final def !=(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  2. final def ##(): Int

    Permalink
    Definition Classes
    AnyRef → Any
  3. def <(that: ChronoZonedDateTime[_]): Boolean

    Permalink
    Definition Classes
    Ordered
  4. def <=(that: ChronoZonedDateTime[_]): Boolean

    Permalink
    Definition Classes
    Ordered
  5. final def ==(arg0: Any): Boolean

    Permalink
    Definition Classes
    AnyRef → Any
  6. def >(that: ChronoZonedDateTime[_]): Boolean

    Permalink
    Definition Classes
    Ordered
  7. def >=(that: ChronoZonedDateTime[_]): Boolean

    Permalink
    Definition Classes
    Ordered
  8. final def asInstanceOf[T0]: T0

    Permalink
    Definition Classes
    Any
  9. def clone(): AnyRef

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  10. def compare(other: ChronoZonedDateTime[_]): Int

    Permalink

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

    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.

    other

    the other date-time to compare to, not null

    returns

    the comparator value, negative if less, positive if greater

    Definition Classes
    ChronoZonedDateTime → Ordered
  11. def compareTo(other: ChronoZonedDateTime[_]): Int

    Permalink
    Definition Classes
    ZonedDateTime → Ordered → Comparable
  12. final def eq(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  13. def equals(obj: Any): Boolean

    Permalink

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

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

    The comparison is based on the offset date-time and the zone. Only objects of type ZonedDateTime are compared, other types return false.

    obj

    the object to check, null returns false

    returns

    true if this is equal to the other date-time

    Definition Classes
    ZonedDateTimeChronoZonedDateTime → AnyRef → Any
  14. def finalize(): Unit

    Permalink
    Attributes
    protected[java.lang]
    Definition Classes
    AnyRef
    Annotations
    @throws( classOf[java.lang.Throwable] )
  15. def format(formatter: DateTimeFormatter): String

    Permalink

    Outputs this date-time as a String using the formatter.

    Outputs this date-time as a String using the formatter.

    This date will be passed to the formatter print method.

    formatter

    the formatter to use, not null

    returns

    the formatted date-time string, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTime
    Exceptions thrown

    DateTimeException if an error occurs during printing

  16. def get(field: TemporalField): Int

    Permalink

    Gets the value of the specified field from this date-time as an int.

    Gets the value of the specified field from this date-time as an int.

    This queries this 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 it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

    If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this date-time, except NANO_OF_DAY, MICRO_OF_DAY, EPOCH_DAY, EPOCH_MONTH and INSTANT_SECONDS which are too large to fit in an int and throw a DateTimeException. All other ChronoField instances will throw a DateTimeException.

    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. Whether the value can be obtained, and what the value represents, is determined by the field.

    field

    the field to get, not null

    returns

    the value for the field

    Definition Classes
    ZonedDateTimeChronoZonedDateTimeTemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if a value for the field cannot be obtained

  17. def getChronology: Chronology

    Permalink

    Gets the chronology of this date-time.

    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

    Definition Classes
    ChronoZonedDateTime
  18. final def getClass(): Class[_]

    Permalink
    Definition Classes
    AnyRef → Any
  19. def getDayOfMonth: Int

    Permalink

    Gets the day-of-month field.

    Gets the day-of-month field.

    This method returns the primitive int value for the day-of-month.

    returns

    the day-of-month, from 1 to 31

  20. def getDayOfWeek: DayOfWeek

    Permalink

    Gets the day-of-week field, which is an enum DayOfWeek.

    Gets the day-of-week field, which is an enum DayOfWeek.

    This method returns the enum DayOfWeek for the day-of-week. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the int value.

    Additional information can be obtained from the DayOfWeek. This includes textual names of the values.

    returns

    the day-of-week, not null

  21. def getDayOfYear: Int

    Permalink

    Gets the day-of-year field.

    Gets the day-of-year field.

    This method returns the primitive int value for the day-of-year.

    returns

    the day-of-year, from 1 to 365, or 366 in a leap year

  22. def getHour: Int

    Permalink

    Gets the hour-of-day field.

    Gets the hour-of-day field.

    returns

    the hour-of-day, from 0 to 23

  23. def getLong(field: TemporalField): Long

    Permalink

    Gets the value of the specified field from this date-time as a long.

    Gets the value of the specified field from this date-time as a long.

    This queries this date-time for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

    If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this date-time. All other ChronoField instances will throw a DateTimeException.

    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. Whether the value can be obtained, and what the value represents, is determined by the field.

    field

    the field to get, not null

    returns

    the value for the field

    Definition Classes
    ZonedDateTimeChronoZonedDateTimeTemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if a value for the field cannot be obtained

  24. def getMinute: Int

    Permalink

    Gets the minute-of-hour field.

    Gets the minute-of-hour field.

    returns

    the minute-of-hour, from 0 to 59

  25. def getMonth: Month

    Permalink

    Gets the month-of-year field using the Month enum.

    Gets the month-of-year field using the Month enum.

    This method returns the enum Month for the month. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the int value.

    returns

    the month-of-year, not null

    See also

    #getMonthValue()

  26. def getMonthValue: Int

    Permalink

    Gets the month-of-year field from 1 to 12.

    Gets the month-of-year field from 1 to 12.

    This method returns the month as an int from 1 to 12. Application code is frequently clearer if the enum Month is used by calling #getMonth().

    returns

    the month-of-year, from 1 to 12

    See also

    #getMonth()

  27. def getNano: Int

    Permalink

    Gets the nano-of-second field.

    Gets the nano-of-second field.

    returns

    the nano-of-second, from 0 to 999,999,999

  28. def getOffset: ZoneOffset

    Permalink

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

    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

    Definition Classes
    ZonedDateTimeChronoZonedDateTime
  29. def getSecond: Int

    Permalink

    Gets the second-of-minute field.

    Gets the second-of-minute field.

    returns

    the second-of-minute, from 0 to 59

  30. def getYear: Int

    Permalink

    Gets the year field.

    Gets the year field.

    This method returns the primitive int value for the year.

    The year returned by this method is proleptic as per get(YEAR). To obtain the year-of-era, use get(YEAR_OF_ERA.

    returns

    the year, from MIN_YEAR to MAX_YEAR

  31. def getZone: ZoneId

    Permalink

    Gets the time-zone, such as 'Europe/Paris'.

    Gets the time-zone, such as 'Europe/Paris'.

    This returns the zone ID. This identifies the time-zone rules that determine when and how the offset from UTC/Greenwich changes.

    The zone ID may be same as the offset. If this is true, then any future calculations, such as addition or subtraction, have no complex edge cases due to time-zone rules. See also #withFixedOffsetZone().

    returns

    the time-zone, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTime
  32. def hashCode(): Int

    Permalink

    A hash code for this date-time.

    A hash code for this date-time.

    returns

    a suitable hash code

    Definition Classes
    ZonedDateTimeChronoZonedDateTime → AnyRef → Any
  33. def isAfter(other: ChronoZonedDateTime[_]): Boolean

    Permalink

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

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

    This method differs from the comparison in #compareTo in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().isAfter(dateTime2.toInstant());.

    other

    the other date-time to compare to, not null

    returns

    true if this is after the specified date-time

    Definition Classes
    ChronoZonedDateTime
  34. def isBefore(other: ChronoZonedDateTime[_]): Boolean

    Permalink

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

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

    This method differs from the comparison in #compareTo in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().isBefore(dateTime2.toInstant());.

    other

    the other date-time to compare to, not null

    returns

    true if this point is before the specified date-time

    Definition Classes
    ChronoZonedDateTime
  35. def isEqual(other: ChronoZonedDateTime[_]): Boolean

    Permalink

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

    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 and #equals in that it only compares the instant of the date-time. This is equivalent to using dateTime1.toInstant().equals(dateTime2.toInstant());.

    other

    the other date-time to compare to, not null

    returns

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

    Definition Classes
    ChronoZonedDateTime
  36. final def isInstanceOf[T0]: Boolean

    Permalink
    Definition Classes
    Any
  37. def isSupported(unit: TemporalUnit): Boolean

    Permalink

    Checks if the specified unit is supported.

    Checks if the specified unit is supported.

    This checks if the date-time can be queried for the specified unit. If false, then calling the plus and minus methods will throw an exception.

    Specification for implementors

    Implementations must check and handle all fields defined in ChronoUnit. If the field is supported, then true is returned, otherwise false

    If the field is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.isSupportedBy(Temporal) passing this as the argument.

    Implementations must not alter this object.

    unit

    the unit to check, null returns false

    returns

    true if this date-time can be queried for the unit, false if not

    Definition Classes
    ZonedDateTimeTemporal
  38. def isSupported(field: TemporalField): Boolean

    Permalink

    Checks if the specified field is supported.

    Checks if the specified field is supported.

    This checks if this date-time can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

    If the field is a ChronoField then the query is implemented here. The supported fields are:

    • NANO_OF_SECOND
    • NANO_OF_DAY
    • MICRO_OF_SECOND
    • MICRO_OF_DAY
    • MILLI_OF_SECOND
    • MILLI_OF_DAY
    • SECOND_OF_MINUTE
    • SECOND_OF_DAY
    • MINUTE_OF_HOUR
    • MINUTE_OF_DAY
    • HOUR_OF_AMPM
    • CLOCK_HOUR_OF_AMPM
    • HOUR_OF_DAY
    • CLOCK_HOUR_OF_DAY
    • AMPM_OF_DAY
    • DAY_OF_WEEK
    • ALIGNED_DAY_OF_WEEK_IN_MONTH
    • ALIGNED_DAY_OF_WEEK_IN_YEAR
    • DAY_OF_MONTH
    • DAY_OF_YEAR
    • EPOCH_DAY
    • ALIGNED_WEEK_OF_MONTH
    • ALIGNED_WEEK_OF_YEAR
    • MONTH_OF_YEAR
    • EPOCH_MONTH
    • YEAR_OF_ERA
    • YEAR
    • ERA
    • INSTANT_SECONDS
    • OFFSET_SECONDS

    All other ChronoField instances will return false.

    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.

    field

    the field to check, null returns false

    returns

    true if the field is supported on this date-time, false if not

    Definition Classes
    ZonedDateTimeTemporalAccessor
  39. def minus(amountToSubtract: Long, unit: TemporalUnit): ZonedDateTime

    Permalink

    Returns a copy of this date-time with the specified period subtracted.

    Returns a copy of this date-time with the specified period subtracted.

    This method returns a new date-time based on this date-time with the specified period subtracted. This can be used to subtract any period that is defined by a unit, for example to subtract years, months or days. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation.

    The calculation for date and time units differ.

    Date units operate on the local time-line. The period is first subtracted from the local date-time, then converted back to a zoned date-time using the zone ID. The conversion uses ZoneId, ZoneOffset) with the offset before the subtraction.

    Time units operate on the instant time-line. The period is first subtracted from the local date-time, then converted back to a zoned date-time using the zone ID. The conversion uses ZoneOffset, ZoneId) with the offset before the subtraction.

    This instance is immutable and unaffected by this method call.

    amountToSubtract

    the amount of the unit to subtract from the result, may be negative

    unit

    the unit of the period to subtract, not null

    returns

    a { @code ZonedDateTime} based on this date-time with the specified period subtracted, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTimeTemporal
    Exceptions thrown

    DateTimeException if the unit cannot be added to this type

  40. def minus(amount: TemporalAmount): ZonedDateTime

    Permalink

    Returns a copy of this date-time with the specified period subtracted.

    Returns a copy of this date-time with the specified period subtracted.

    This method returns a new date-time based on this time with the specified period subtracted. The amount is typically Period but may be any other type implementing the TemporalAmount interface. The calculation is delegated to the specified adjuster, which typically calls back to TemporalUnit).

    This instance is immutable and unaffected by this method call.

    amount

    the amount to subtract, not null

    returns

    a { @code ZonedDateTime} based on this date-time with the subtraction made, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTimeTemporal
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the subtraction cannot be made

  41. def minusDays(days: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in days subtracted.

    Returns a copy of this ZonedDateTime with the specified period in days subtracted.

    This operates on the local time-line, subtracting days to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    days

    the days to subtract, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the days subtracted, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  42. def minusHours(hours: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in hours subtracted.

    Returns a copy of this ZonedDateTime with the specified period in hours subtracted.

    This operates on the instant time-line, such that subtracting one hour will always be a duration of one hour earlier. This may cause the local date-time to change by an amount other than one hour. Note that this is a different approach to that used by days, months and years, thus subtracting one day is not the same as adding 24 hours.

    For example, consider a time-zone where the spring DST cutover means that the local times 01:00 to 01:59 occur twice changing from offset +02:00 to +01:00.

    • Subtracting one hour from 02:30+01:00 will result in 01:30+02:00
    • Subtracting one hour from 01:30+01:00 will result in 01:30+02:00
    • Subtracting one hour from 01:30+02:00 will result in 00:30+01:00
    • Subtracting three hours from 02:30+01:00 will result in 00:30+02:00

    This instance is immutable and unaffected by this method call.

    hours

    the hours to subtract, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the hours subtracted, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  43. def minusMinutes(minutes: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in minutes subtracted.

    Returns a copy of this ZonedDateTime with the specified period in minutes subtracted.

    This operates on the instant time-line, such that subtracting one minute will always be a duration of one minute earlier. This may cause the local date-time to change by an amount other than one minute. Note that this is a different approach to that used by days, months and years.

    This instance is immutable and unaffected by this method call.

    minutes

    the minutes to subtract, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the minutes subtracted, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  44. def minusMonths(months: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in months subtracted.

    Returns a copy of this ZonedDateTime with the specified period in months subtracted.

    This operates on the local time-line, subtracting months to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    months

    the months to subtract, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the months subtracted, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  45. def minusNanos(nanos: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in nanoseconds subtracted.

    Returns a copy of this ZonedDateTime with the specified period in nanoseconds subtracted.

    This operates on the instant time-line, such that subtracting one nano will always be a duration of one nano earlier. This may cause the local date-time to change by an amount other than one nano. Note that this is a different approach to that used by days, months and years.

    This instance is immutable and unaffected by this method call.

    nanos

    the nanos to subtract, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the nanoseconds subtracted, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  46. def minusSeconds(seconds: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in seconds subtracted.

    Returns a copy of this ZonedDateTime with the specified period in seconds subtracted.

    This operates on the instant time-line, such that subtracting one second will always be a duration of one second earlier. This may cause the local date-time to change by an amount other than one second. Note that this is a different approach to that used by days, months and years.

    This instance is immutable and unaffected by this method call.

    seconds

    the seconds to subtract, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the seconds subtracted, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  47. def minusWeeks(weeks: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in weeks subtracted.

    Returns a copy of this ZonedDateTime with the specified period in weeks subtracted.

    This operates on the local time-line, subtracting weeks to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    weeks

    the weeks to subtract, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the weeks subtracted, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  48. def minusYears(years: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in years subtracted.

    Returns a copy of this ZonedDateTime with the specified period in years subtracted.

    This operates on the local time-line, subtracting years to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    years

    the years to subtract, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the years subtracted, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  49. final def ne(arg0: AnyRef): Boolean

    Permalink
    Definition Classes
    AnyRef
  50. final def notify(): Unit

    Permalink
    Definition Classes
    AnyRef
  51. final def notifyAll(): Unit

    Permalink
    Definition Classes
    AnyRef
  52. def plus(amountToAdd: Long, unit: TemporalUnit): ZonedDateTime

    Permalink

    Returns a copy of this date-time with the specified period added.

    Returns a copy of this date-time with the specified period added.

    This method returns a new date-time based on this date-time with the specified period added. This can be used to add any period that is defined by a unit, for example to add years, months or days. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation.

    The calculation for date and time units differ.

    Date units operate on the local time-line. The period is first added to the local date-time, then converted back to a zoned date-time using the zone ID. The conversion uses ZoneId, ZoneOffset) with the offset before the addition.

    Time units operate on the instant time-line. The period is first added to the local date-time, then converted back to a zoned date-time using the zone ID. The conversion uses ZoneOffset, ZoneId) with the offset before the addition.

    This instance is immutable and unaffected by this method call.

    amountToAdd

    the amount of the unit to add to the result, may be negative

    unit

    the unit of the period to add, not null

    returns

    a { @code ZonedDateTime} based on this date-time with the specified period added, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTimeTemporal
    Exceptions thrown

    DateTimeException if the unit cannot be added to this type

  53. def plus(amount: TemporalAmount): ZonedDateTime

    Permalink

    Returns a copy of this date-time with the specified period added.

    Returns a copy of this date-time with the specified period added.

    This method returns a new date-time based on this time with the specified period added. The amount is typically Period but may be any other type implementing the TemporalAmount interface. The calculation is delegated to the specified adjuster, which typically calls back to TemporalUnit).

    This instance is immutable and unaffected by this method call.

    amount

    the amount to add, not null

    returns

    a { @code ZonedDateTime} based on this date-time with the addition made, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTimeTemporal
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the addition cannot be made

  54. def plusDays(days: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in days added.

    Returns a copy of this ZonedDateTime with the specified period in days added.

    This operates on the local time-line, adding days to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    days

    the days to add, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the days added, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  55. def plusHours(hours: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in hours added.

    Returns a copy of this ZonedDateTime with the specified period in hours added.

    This operates on the instant time-line, such that adding one hour will always be a duration of one hour later. This may cause the local date-time to change by an amount other than one hour. Note that this is a different approach to that used by days, months and years, thus adding one day is not the same as adding 24 hours.

    For example, consider a time-zone where the spring DST cutover means that the local times 01:00 to 01:59 occur twice changing from offset +02:00 to +01:00.

    • Adding one hour to 00:30+02:00 will result in 01:30+02:00
    • Adding one hour to 01:30+02:00 will result in 01:30+01:00
    • Adding one hour to 01:30+01:00 will result in 02:30+01:00
    • Adding three hours to 00:30+02:00 will result in 02:30+01:00

    This instance is immutable and unaffected by this method call.

    hours

    the hours to add, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the hours added, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  56. def plusMinutes(minutes: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in minutes added.

    Returns a copy of this ZonedDateTime with the specified period in minutes added.

    This operates on the instant time-line, such that adding one minute will always be a duration of one minute later. This may cause the local date-time to change by an amount other than one minute. Note that this is a different approach to that used by days, months and years.

    This instance is immutable and unaffected by this method call.

    minutes

    the minutes to add, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the minutes added, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  57. def plusMonths(months: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in months added.

    Returns a copy of this ZonedDateTime with the specified period in months added.

    This operates on the local time-line, adding months to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    months

    the months to add, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the months added, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  58. def plusNanos(nanos: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in nanoseconds added.

    Returns a copy of this ZonedDateTime with the specified period in nanoseconds added.

    This operates on the instant time-line, such that adding one nano will always be a duration of one nano later. This may cause the local date-time to change by an amount other than one nano. Note that this is a different approach to that used by days, months and years.

    This instance is immutable and unaffected by this method call.

    nanos

    the nanos to add, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the nanoseconds added, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  59. def plusSeconds(seconds: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in seconds added.

    Returns a copy of this ZonedDateTime with the specified period in seconds added.

    This operates on the instant time-line, such that adding one second will always be a duration of one second later. This may cause the local date-time to change by an amount other than one second. Note that this is a different approach to that used by days, months and years.

    This instance is immutable and unaffected by this method call.

    seconds

    the seconds to add, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the seconds added, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  60. def plusWeeks(weeks: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in weeks added.

    Returns a copy of this ZonedDateTime with the specified period in weeks added.

    This operates on the local time-line, adding weeks to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    weeks

    the weeks to add, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the weeks added, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  61. def plusYears(years: Long): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the specified period in years added.

    Returns a copy of this ZonedDateTime with the specified period in years added.

    This operates on the local time-line, adding years to the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    years

    the years to add, may be negative

    returns

    a { @code ZonedDateTime} based on this date-time with the years added, not null

    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  62. def query[R](query: TemporalQuery[R]): R

    Permalink

    Queries this date-time using the specified 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 TemporalQuery#queryFrom(TemporalAccessor) method on the specified query passing this as the argument.

    R

    the type of the result

    query

    the query to invoke, not null

    returns

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

    Definition Classes
    ZonedDateTimeChronoZonedDateTimeTemporalAccessor
    Exceptions thrown

    ArithmeticException if numeric overflow occurs (defined by the query)

    DateTimeException if unable to query (defined by the query)

  63. def range(field: TemporalField): ValueRange

    Permalink

    Gets the range of valid values for the specified field.

    Gets the range of valid values for the specified field.

    The range object expresses the minimum and maximum valid values for a field. This date-time is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.

    If the field is a ChronoField then the query is implemented here. The supported fields will return appropriate range instances. All other ChronoField instances will throw a DateTimeException.

    If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

    field

    the field to query the range for, not null

    returns

    the range of valid values for the field, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTimeTemporalAccessor
    Exceptions thrown

    DateTimeException if the range for the field cannot be obtained

  64. final def synchronized[T0](arg0: ⇒ T0): T0

    Permalink
    Definition Classes
    AnyRef
  65. def toEpochSecond: Long

    Permalink

    Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z.

    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

    Definition Classes
    ChronoZonedDateTime
  66. def toInstant: Instant

    Permalink

    Converts this date-time to an Instant.

    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 { @code Instant} representing the same instant, not null

    Definition Classes
    ChronoZonedDateTime
  67. def toLocalDate: LocalDate

    Permalink

    Gets the LocalDate part of this date-time.

    Gets the LocalDate part of this date-time.

    This returns a LocalDate with the same year, month and day as this date-time.

    returns

    the date part of this date-time, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTime
  68. def toLocalDateTime: LocalDateTime

    Permalink

    Gets the LocalDateTime part of this date-time.

    Gets the LocalDateTime part of this date-time.

    This returns a LocalDateTime with the same year, month, day and time as this date-time.

    returns

    the local date-time part of this date-time, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTime
  69. def toLocalTime: LocalTime

    Permalink

    Gets the LocalTime part of this date-time.

    Gets the LocalTime part of this date-time.

    This returns a LocalTime with the same hour, minute, second and nanosecond as this date-time.

    returns

    the time part of this date-time, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTime
  70. def toOffsetDateTime: OffsetDateTime

    Permalink

    Converts this date-time to an OffsetDateTime.

    Converts this date-time to an OffsetDateTime.

    This creates an offset date-time using the local date-time and offset. The zone ID is ignored.

    returns

    an offset date-time representing the same local date-time and offset, not null

  71. def toString(): String

    Permalink

    Outputs this date-time as a String, such as 2007-12-03T10:15:30+01:00[Europe/Paris].

    Outputs this date-time as a String, such as 2007-12-03T10:15:30+01:00[Europe/Paris].

    The format consists of the LocalDateTime followed by the ZoneOffset. If the ZoneId is not the same as the offset, then the ID is output. The output is compatible with ISO-8601 if the offset and ID are the same.

    returns

    a string representation of this date-time, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTime → AnyRef → Any
  72. def truncatedTo(unit: TemporalUnit): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the time truncated.

    Returns a copy of this ZonedDateTime with the time truncated.

    Truncation returns a copy of the original date-time with fields smaller than the specified unit set to zero. For example, truncating with the minutes unit will set the second-of-minute and nano-of-second field to zero.

    The unit must have a duration that divides into the length of a standard day without remainder. This includes all supplied time units on ChronoUnit and DAYS. Other units throw an exception.

    This operates on the local time-line, truncating the underlying local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    unit

    the unit to truncate to, not null

    returns

    a { @code ZonedDateTime} based on this date-time with the time truncated, not null

    Exceptions thrown

    DateTimeException if unable to truncate

  73. def until(endExclusive: Temporal, unit: TemporalUnit): Long

    Permalink

    Calculates the period between this date-time and another date-time in terms of the specified unit.

    Calculates the period between this date-time and another date-time in terms of the specified unit.

    This calculates the period between two date-times in terms of a single unit. The start and end points are this and the specified date-time. The result will be negative if the end is before the start. For example, the period in days between two date-times can be calculated using startDateTime.until(endDateTime, DAYS).

    The Temporal passed to this method must be a ZonedDateTime. If the time-zone differs between the two zoned date-times, the specified end date-time is normalized to have the same zone as this date-time.

    The calculation returns a whole number, representing the number of complete units between the two date-times. For example, the period in months between 2012-06-15T00:00Z and 2012-08-14T23:59Z will only be one month as it is one minute short of two months.

    This method operates in association with TemporalUnit#between. The result of this method is a long representing the amount of the specified unit. By contrast, the result of between is an object that can be used directly in addition/subtraction:

    long period = start.until(end, MONTHS);   // this method
    dateTime.plus(MONTHS.between(start, end));      // use in plus/minus
    

    The calculation is implemented in this method for ChronoUnit. The units NANOS, MICROS, MILLIS, SECONDS, MINUTES, HOURS and HALF_DAYS, DAYS, WEEKS, MONTHS, YEARS, DECADES, CENTURIES, MILLENNIA and ERAS are supported. Other ChronoUnit values will throw an exception.

    The calculation for date and time units differ.

    Date units operate on the local time-line, using the local date-time. For example, the period from noon on day 1 to noon the following day in days will always be counted as exactly one day, irrespective of whether there was a daylight savings change or not.

    Time units operate on the instant time-line. The calculation effectively converts both zoned date-times to instants and then calculates the period between the instants. For example, the period from noon on day 1 to noon the following day in hours may be 23, 24 or 25 hours (or some other amount) depending on whether there was a daylight savings change or not.

    If the unit is not a ChronoUnit, then the result of this method is obtained by invoking TemporalUnit.between(Temporal, Temporal) passing this as the first argument and the input temporal as the second argument.

    This instance is immutable and unaffected by this method call.

    endExclusive

    the end date-time, which is converted to a { @code ZonedDateTime}, not null

    unit

    the unit to measure the period in, not null

    returns

    the amount of the period between this date-time and the end date-time

    Definition Classes
    ZonedDateTimeTemporal
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the period cannot be calculated

  74. final def wait(): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  75. final def wait(arg0: Long, arg1: Int): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  76. final def wait(arg0: Long): Unit

    Permalink
    Definition Classes
    AnyRef
    Annotations
    @throws( ... )
  77. def with(field: TemporalField, newValue: Long): ZonedDateTime

    Permalink

    Returns a copy of this date-time with the specified field set to a new value.

    Returns a copy of this date-time with the specified field set to a new value.

    This returns a ZonedDateTime, based on this one, with the value for the specified field changed. This can be used to change any supported field, such as the year, month or day-of-month. If it is not possible to set the value, because the field is not supported or for some other reason, an exception is thrown.

    In some cases, changing the specified field can cause the resulting date-time to become invalid, such as changing the month from 31st January to February would make the day-of-month invalid. In cases like this, the field is responsible for resolving the date. Typically it will choose the previous valid date, which would be the last valid day of February in this example.

    If the field is a ChronoField then the adjustment is implemented here.

    The INSTANT_SECONDS field will return a date-time with the specified instant. The zone and nano-of-second are unchanged. The result will have an offset derived from the new instant and original zone. If the new instant value is outside the valid range then a DateTimeException will be thrown.

    The OFFSET_SECONDS field will typically be ignored. The offset of a ZonedDateTime is controlled primarily by the time-zone. As such, changing the offset does not generally make sense, because there is only one valid offset for the local date-time and zone. If the zoned date-time is in a daylight savings overlap, then the offset is used to switch between the two valid offsets. In all other cases, the offset is ignored. If the new offset value is outside the valid range then a DateTimeException will be thrown.

    The other supported fields will behave as per the matching method on long) LocalDateTime. The zone is not part of the calculation and will be unchanged. When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    All other ChronoField instances will throw an UnsupportedTemporalTypeException.

    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 argument. In this case, the field determines whether and how to adjust the instant.

    This instance is immutable and unaffected by this method call.

    field

    the field to set in the result, not null

    newValue

    the new value of the field in the result

    returns

    a { @code ZonedDateTime} based on { @code this} with the specified field set, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTimeTemporal
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the field cannot be set

    UnsupportedTemporalTypeException if the field is not supported

  78. def with(adjuster: TemporalAdjuster): ZonedDateTime

    Permalink

    Returns an adjusted copy of this date-time.

    Returns an adjusted copy of this date-time.

    This returns a new ZonedDateTime, based on this one, with the date-time adjusted. The adjustment takes place using the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will be made.

    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". Key date-time classes also implement the TemporalAdjuster interface, such as Month and MonthDay. The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.

    For example this code returns a date on the last day of July:

    import static org.threeten.bp.Month.*;
    import static org.threeten.bp.temporal.Adjusters.*;
    
    result = zonedDateTime.with(JULY).with(lastDayOfMonth());
    

    The classes LocalDate and LocalTime implement TemporalAdjuster, thus this method can be used to change the date, time or offset:

    result = zonedDateTime.with(date);
    result = zonedDateTime.with(time);
    

    ZoneOffset also implements TemporalAdjuster however it is less likely that setting the offset will have the effect you expect. When an offset is passed in, the local date-time is combined with the new offset to form an Instant. The instant and original zone are then used to create the result. This algorithm means that it is quite likely that the output has a different offset to the specified offset. It will however work correctly when passing in the offset applicable for the instant of the zoned date-time, and will work correctly if passing one of the two valid offsets during a daylight savings overlap when the same local time occurs twice.

    The result of this method is obtained by invoking the TemporalAdjuster#adjustInto(Temporal) method on the specified adjuster passing this as the argument.

    This instance is immutable and unaffected by this method call.

    adjuster

    the adjuster to use, not null

    returns

    a { @code ZonedDateTime} based on { @code this} with the adjustment made, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTimeTemporal
    Exceptions thrown

    ArithmeticException if numeric overflow occurs

    DateTimeException if the adjustment cannot be made

  79. def withDayOfMonth(dayOfMonth: Int): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the day-of-month value altered.

    Returns a copy of this ZonedDateTime with the day-of-month value altered.

    This operates on the local time-line, changing the day-of-month of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    dayOfMonth

    the day-of-month to set in the result, from 1 to 28-31

    returns

    a { @code ZonedDateTime} based on this date-time with the requested day, not null

    Exceptions thrown

    DateTimeException if the day-of-month is invalid for the month-year

  80. def withDayOfYear(dayOfYear: Int): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the day-of-year altered.

    Returns a copy of this ZonedDateTime with the day-of-year altered.

    This operates on the local time-line, changing the day-of-year of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    dayOfYear

    the day-of-year to set in the result, from 1 to 365-366

    returns

    a { @code ZonedDateTime} based on this date with the requested day, not null

    Exceptions thrown

    DateTimeException if the day-of-year is invalid for the year

  81. def withEarlierOffsetAtOverlap: ZonedDateTime

    Permalink

    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.

    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 { @code ZonedDateTime} based on this date-time with the earlier offset, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTime
  82. def withFixedOffsetZone: ZonedDateTime

    Permalink

    Returns a copy of this date-time with the zone ID set to the offset.

    Returns a copy of this date-time with the zone ID set to the offset.

    This returns a zoned date-time where the zone ID is the same as #getOffset(). The local date-time, offset and instant of the result will be the same as in this date-time.

    Setting the date-time to a fixed single offset means that any future calculations, such as addition or subtraction, have no complex edge cases due to time-zone rules. This might also be useful when sending a zoned date-time across a network, as most protocols, such as ISO-8601, only handle offsets, and not region-based zone IDs.

    This is equivalent to ZonedDateTime.of(zdt.getDateTime(), zdt.getOffset()).

    returns

    a { @code ZonedDateTime} with the zone ID set to the offset, not null

  83. def withHour(hour: Int): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the hour-of-day value altered.

    Returns a copy of this ZonedDateTime with the hour-of-day value altered.

    This operates on the local time-line, changing the time of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    hour

    the hour-of-day to set in the result, from 0 to 23

    returns

    a { @code ZonedDateTime} based on this date-time with the requested hour, not null

    Exceptions thrown

    DateTimeException if the hour value is invalid

  84. def withLaterOffsetAtOverlap: ZonedDateTime

    Permalink

    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.

    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 { @code ZonedDateTime} based on this date-time with the later offset, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTime
  85. def withMinute(minute: Int): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the minute-of-hour value altered.

    Returns a copy of this ZonedDateTime with the minute-of-hour value altered.

    This operates on the local time-line, changing the time of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    minute

    the minute-of-hour to set in the result, from 0 to 59

    returns

    a { @code ZonedDateTime} based on this date-time with the requested minute, not null

    Exceptions thrown

    DateTimeException if the minute value is invalid

  86. def withMonth(month: Int): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the month-of-year value altered.

    Returns a copy of this ZonedDateTime with the month-of-year value altered.

    This operates on the local time-line, changing the month of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    month

    the month-of-year to set in the result, from 1 (January) to 12 (December)

    returns

    a { @code ZonedDateTime} based on this date-time with the requested month, not null

    Exceptions thrown

    DateTimeException if the month-of-year value is invalid

  87. def withNano(nanoOfSecond: Int): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the nano-of-second value altered.

    Returns a copy of this ZonedDateTime with the nano-of-second value altered.

    This operates on the local time-line, changing the time of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    nanoOfSecond

    the nano-of-second to set in the result, from 0 to 999,999,999

    returns

    a { @code ZonedDateTime} based on this date-time with the requested nanosecond, not null

    Exceptions thrown

    DateTimeException if the nano value is invalid

  88. def withSecond(second: Int): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the second-of-minute value altered.

    Returns a copy of this ZonedDateTime with the second-of-minute value altered.

    This operates on the local time-line, changing the time of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    second

    the second-of-minute to set in the result, from 0 to 59

    returns

    a { @code ZonedDateTime} based on this date-time with the requested second, not null

    Exceptions thrown

    DateTimeException if the second value is invalid

  89. def withYear(year: Int): ZonedDateTime

    Permalink

    Returns a copy of this ZonedDateTime with the year value altered.

    Returns a copy of this ZonedDateTime with the year value altered.

    This operates on the local time-line, changing the year of the local date-time. This is then converted back to a ZonedDateTime, using the zone ID to obtain the offset.

    When converting back to ZonedDateTime, if the local date-time is in an overlap, then the offset will be retained if possible, otherwise the earlier offset will be used. If in a gap, the local date-time will be adjusted forward by the length of the gap.

    This instance is immutable and unaffected by this method call.

    year

    the year to set in the result, from MIN_YEAR to MAX_YEAR

    returns

    a { @code ZonedDateTime} based on this date-time with the requested year, not null

    Exceptions thrown

    DateTimeException if the year value is invalid

  90. def withZoneSameInstant(zone: ZoneId): ZonedDateTime

    Permalink

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

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

    zone

    the time-zone to change to, not null

    returns

    a { @code ZonedDateTime} based on this date-time with the requested zone, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTime
    Exceptions thrown

    DateTimeException if the result exceeds the supported date range

  91. def withZoneSameLocal(zone: ZoneId): ZonedDateTime

    Permalink

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

    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, determined using the same approach as ZoneId, ZoneOffset).

    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 null

    returns

    a { @code ZonedDateTime} based on this date-time with the requested zone, not null

    Definition Classes
    ZonedDateTimeChronoZonedDateTime

Inherited from Serializable

Inherited from ChronoZonedDateTime[LocalDate]

Inherited from Ordered[ChronoZonedDateTime[_]]

Inherited from Comparable[ChronoZonedDateTime[_]]

Inherited from Temporal

Inherited from TemporalAccessor

Inherited from AnyRef

Inherited from Any

Ungrouped