Home Reference Source
import {ZonedDateTime} from 'js-joda/src/ZonedDateTime.js'
public class | source

ZonedDateTime

Extends:

TemporalAccessorTemporalChronoZonedDateTime → ZonedDateTime

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

  • Normal, with one valid offset. For the vast majority of the year, the normal case applies, where there is a single valid offset for the local date-time.
  • Gap, with zero valid offsets. This is when clocks jump forward typically due to the spring daylight savings change from 'winter' to 'summer'. In a gap there are local date-time values with no valid offset.
  • Overlap, with two valid offsets. This is when clocks are set back typically due to the autumn daylight savings change from 'summer' to 'winter'. In an overlap there are local date-time values with two valid offsets.

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.

Static Method Summary

Static Public Methods
public static

Obtains an instance of ZonedDateTime from a temporal object.

public static

now(clockOrZone: Clock | ZoneId): ZonedDateTime

Obtains the current date-time from the system clock in the specified time-zone or clock or default time zone.

public static

of(): *

function overloading for static ZonedDateTime.of

public static

of2(localDateTime: LocalDateTime, zone: ZoneId): ZonedDateTime

Obtains an instance of ZonedDateTime from a local date-time.

public static

of3(date: LocalDate, time: LocalTime, zone: ZoneId): ZonedDateTime

Obtains an instance of ZonedDateTime from a local date and time.

public static

of8(year: number, month: number, dayOfMonth: number, hour: number, minute: number, second: number, nanoOfSecond: number, zone: ZoneId): ZonedDateTime

Obtains an instance of ZonedDateTime from a year, month, day, hour, minute, second, nanosecond and time-zone.

public static

ofInstant(): *

function overloading for ZonedDateTime.ofInstant.

public static

Obtains an instance of ZonedDateTime from an Instant.

public static

ofInstant3(localDateTime: LocalDateTime, offset: ZoneOffset, zone: ZoneId): ZonedDateTime

Obtains an instance of ZonedDateTime from the instant formed by combining the local date-time and offset.

public static

ofLenient(localDateTime: LocalDateTime, offset: ZoneOffset, zone: ZoneId): ZonedDateTime

Obtains an instance of ZonedDateTime leniently, for advanced use cases, allowing any combination of local date-time, offset and zone ID.

public static

ofLocal(localDateTime: LocalDateTime, zone: ZoneId, preferredOffset: ZoneOffset): ZonedDateTime

Obtains an instance of ZonedDateTime from a local date-time using the preferred offset if possible.

public static

ofStrict(localDateTime: LocalDateTime, offset: ZoneOffset, zone: ZoneId): ZonedDateTime

Obtains an instance of ZonedDateTime strictly validating the combination of local date-time, offset and zone ID.

public static

Obtains an instance of ZonedDateTime from a text string such as 2007-12-03T10:15:30+01:00[Europe/Paris].

Method Summary

Public Methods
public

Gets the day-of-month field.

public

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

public

Gets the day-of-year field.

public

equals(other: *): boolean

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

public

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

public

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

public

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

public

A hash code for this date-time.

public

Gets the hour-of-day field.

public

Checks if the specified field is supported.

public

minus(): *

function overloading for ZonedDateTime.minus

public

minus2(amountToSubtract: number, unit: TemporalUnit): ZonedDateTime

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

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

public

Gets the minute-of-hour field.

public

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

public

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

public

Gets the nano-of-second field.

public

offset(): *

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

public

plus(): *

function overloading for ZonedDateTime.plus

public

plus2(amountToAdd: number, unit: TemporalUnit): ZonedDateTime

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

public

plusDays(days: number): *

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

public

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

public

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

public

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

public

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

public

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

public

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

public

plusWeeks(weeks: number): *

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

public

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

public

query(query: TemporalQuery): *

Queries this date-time using the specified query.

public

Gets the range of valid values for the specified field.

public

Gets the second-of-minute field.

public
public

Gets the LocalDate part of this date-time.

public

Gets the LocalDateTime part of this date-time.

public

Gets the LocalTime part of this date-time.

public

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

public

Returns a copy of this ZonedDateTime with the time truncated.

public

until(endExclusive: Temporal, unit: TemporalUnit): number

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

public

with(): *

function overloading for ZonedDateTime.with

public

with2(field: TemporalField, newValue: number): ZonedDateTime

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

public

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

public

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

public

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.

public

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

public

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

public

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.

public

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

public

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

public

withNano(nanoOfSecond: number): ZonedDateTime

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

public

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

public

Returns an adjusted copy of this date-time.

public

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

public

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

public

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

public

Gets the year field.

public

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

Inherited Summary

From class TemporalAccessor
public

Gets the value of the specified field as an int.

public

query(query: TemporalQuery): *

Queries this date-time.

public

Gets the range of valid values for the specified field.

From class ChronoZonedDateTime
public

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

public

equals(other: *): boolean

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

public

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

public

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

public

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

public

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

public

query(query: *): *

public

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

public

Converts this date-time to an Instant.

Static Public Methods

public static from(temporal: TemporalAccessor): ZonedDateTime source

Obtains an instance of ZonedDateTime from a temporal object.

A TemporalAccessor represents some form of date and time information. This factory converts the arbitrary temporal object to an instance of ZonedDateTime.

The conversion will first obtain a ZoneId. It will then try to obtain an instant. If that fails it will try to obtain a local date-time. The zoned date time will either be a combination of ZoneId and instant, or ZoneId and local date-time.

This method matches the signature of the functional interface TemporalQuery allowing it to be used in queries via method reference, ZonedDateTime::from.

Params:

NameTypeAttributeDescription
temporal TemporalAccessor
  • nullable: false

the temporal object to convert, not null

Return:

ZonedDateTime

the zoned date-time, not null

Throw:

*

DateTimeException if unable to convert to an ZonedDateTime

public static now(clockOrZone: Clock | ZoneId): ZonedDateTime source

Obtains the current date-time from the system clock in the specified time-zone or clock or default time zone.

This will query the system clock (see Clock#systemDefaultZone) in the default time-zone to obtain the current date-time. The zone and offset will be set based on the time-zone in the clock.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Params:

NameTypeAttributeDescription
clockOrZone Clock | ZoneId
  • optional
  • default: Clock.systemDefaultZone()

Return:

ZonedDateTime

the current date-time using the system clock, not null

public static of(): * source

function overloading for static ZonedDateTime.of

if called with 2 (or less) args ZonedDateTime.of2 is called, if called with 3 args and the first arg is an instance of LocalDate ZonedDateTime.of3 is called, otherwise ZonedDateTime.of8 is called.

Return:

*

public static of2(localDateTime: LocalDateTime, zone: ZoneId): ZonedDateTime source

Obtains an instance of ZonedDateTime from a local date-time.

This creates a zoned date-time matching the input local date-time as closely as possible. Time-zone rules, such as daylight savings, mean that not every local date-time is valid for the specified zone, thus the local date-time may be adjusted.

The local date-time is resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the ZoneRules of the zone ID.

In most cases, there is only one valid offset for a local date-time. In the case of an overlap, when clocks are set back, there are two valid offsets. This method uses the earlier offset typically corresponding to 'summer'.

In the case of a gap, when clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to 'summer'.

Params:

NameTypeAttributeDescription
localDateTime LocalDateTime
  • nullable: false

the local date-time, not null

zone ZoneId
  • nullable: false

the time-zone, not null

Return:

ZonedDateTime

the zoned date-time, not null

public static of3(date: LocalDate, time: LocalTime, zone: ZoneId): ZonedDateTime source

Obtains an instance of ZonedDateTime from a local date and time.

This creates a zoned date-time matching the input local date and time as closely as possible. Time-zone rules, such as daylight savings, mean that not every local date-time is valid for the specified zone, thus the local date-time may be adjusted.

The local date time and first combined to form a local date-time. The local date-time is then resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the ZoneRules of the zone ID.

In most cases, there is only one valid offset for a local date-time. In the case of an overlap, when clocks are set back, there are two valid offsets. This method uses the earlier offset typically corresponding to 'summer'.

In the case of a gap, when clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to 'summer'.

Params:

NameTypeAttributeDescription
date LocalDate

the local date, not null

time LocalTime

the local time, not null

zone ZoneId

the time-zone, not null

Return:

ZonedDateTime

the offset date-time, not null

public static of8(year: number, month: number, dayOfMonth: number, hour: number, minute: number, second: number, nanoOfSecond: number, zone: ZoneId): ZonedDateTime source

Obtains an instance of ZonedDateTime from a year, month, day, hour, minute, second, nanosecond and time-zone.

This creates a zoned date-time matching the local date-time of the seven specified fields as closely as possible. Time-zone rules, such as daylight savings, mean that not every local date-time is valid for the specified zone, thus the local date-time may be adjusted.

The local date-time is resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the ZoneRules of the zone ID.

In most cases, there is only one valid offset for a local date-time. In the case of an overlap, when clocks are set back, there are two valid offsets. This method uses the earlier offset typically corresponding to 'summer'.

In the case of a gap, when clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to 'summer'.

This method exists primarily for writing test cases. Non test-code will typically use other methods to create an offset time. LocalDateTime has five additional convenience variants of the equivalent factory method taking fewer arguments. They are not provided here to reduce the footprint of the API.

Params:

NameTypeAttributeDescription
year number

the year to represent, from MIN_YEAR to MAX_YEAR

month number

the month-of-year to represent, from 1 (January) to 12 (December)

dayOfMonth number

the day-of-month to represent, from 1 to 31

hour number

the hour-of-day to represent, from 0 to 23

minute number

the minute-of-hour to represent, from 0 to 59

second number

the second-of-minute to represent, from 0 to 59

nanoOfSecond number

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

zone ZoneId

the time-zone, not null

Return:

ZonedDateTime

the offset date-time, not null

Throw:

*

DateTimeException if the value of any field is out of range, or if the day-of-month is invalid for the month-year

public static ofInstant(): * source

function overloading for ZonedDateTime.ofInstant. if called with 2 args ZonedDateTime.ofInstant2 is called otherwise ZonedDateTime.ofInstant3.

Return:

*

public static ofInstant2(instant: Instant, zone: ZoneId): ZonedDateTime source

Obtains an instance of ZonedDateTime from an Instant.

This creates a zoned date-time with the same instant as that specified. Calling toInstant will return an instant equal to the one used here.

Converting an instant to a zoned date-time is simple as there is only one valid offset for each instant.

Params:

NameTypeAttributeDescription
instant Instant
  • nullable: false

the instant to create the date-time from, not null

zone ZoneId
  • nullable: false

the time-zone, not null

Return:

ZonedDateTime

the zoned date-time, not null

Throw:

*

DateTimeException if the result exceeds the supported range

public static ofInstant3(localDateTime: LocalDateTime, offset: ZoneOffset, zone: ZoneId): ZonedDateTime source

Obtains an instance of ZonedDateTime from the instant formed by combining the local date-time and offset.

This creates a zoned date-time by combining the LocalDateTime and ZoneOffset. This combination uniquely specifies an instant without ambiguity.

Converting an instant to a zoned date-time is simple as there is only one valid offset for each instant. If the valid offset is different to the offset specified, the the date-time and offset of the zoned date-time will differ from those specified.

If the ZoneId to be used is a ZoneOffset, this method is equivalent to of.

Params:

NameTypeAttributeDescription
localDateTime LocalDateTime

the local date-time, not null

offset ZoneOffset

the zone offset, not null

zone ZoneId

the time-zone, not null

Return:

ZonedDateTime

the zoned date-time, not null

public static ofLenient(localDateTime: LocalDateTime, offset: ZoneOffset, zone: ZoneId): ZonedDateTime source

Obtains an instance of ZonedDateTime leniently, for advanced use cases, allowing any combination of local date-time, offset and zone ID.

This creates a zoned date-time with no checks other than no nulls. This means that the resulting zoned date-time may have an offset that is in conflict with the zone ID.

This method is intended for advanced use cases. For example, consider the case where a zoned date-time with valid fields is created and then stored in a database or serialization-based store. At some later point, the object is then re-loaded. However, between those points in time, the government that defined the time-zone has changed the rules, such that the originally stored local date-time now does not occur. This method can be used to create the object in an 'invalid' state, despite the change in rules.

Params:

NameTypeAttributeDescription
localDateTime LocalDateTime

the local date-time, not null

offset ZoneOffset

the zone offset, not null

zone ZoneId

the time-zone, not null

Return:

ZonedDateTime

the zoned date-time, not null

public static ofLocal(localDateTime: LocalDateTime, zone: ZoneId, preferredOffset: ZoneOffset): ZonedDateTime source

Obtains an instance of ZonedDateTime from a local date-time using the preferred offset if possible.

The local date-time is resolved to a single instant on the time-line. This is achieved by finding a valid offset from UTC/Greenwich for the local date-time as defined by the ZoneRules of the zone ID.

In most cases, there is only one valid offset for a local date-time. In the case of an overlap, where clocks are set back, there are two valid offsets. If the preferred offset is one of the valid offsets then it is used. Otherwise the earlier valid offset is used, typically corresponding to 'summer'.

In the case of a gap, where clocks jump forward, there is no valid offset. Instead, the local date-time is adjusted to be later by the length of the gap. For a typical one hour daylight savings change, the local date-time will be moved one hour later into the offset typically corresponding to 'summer'.

Params:

NameTypeAttributeDescription
localDateTime LocalDateTime
  • nullable: false

the local date-time, not null

zone ZoneId
  • nullable: false

the time-zone, not null

preferredOffset ZoneOffset

the zone offset, null if no preference

Return:

ZonedDateTime

the zoned date-time, not null

public static ofStrict(localDateTime: LocalDateTime, offset: ZoneOffset, zone: ZoneId): ZonedDateTime source

Obtains an instance of ZonedDateTime strictly validating the combination of local date-time, offset and zone ID.

This creates a zoned date-time ensuring that the offset is valid for the local date-time according to the rules of the specified zone. If the offset is invalid, an exception is thrown.

Params:

NameTypeAttributeDescription
localDateTime LocalDateTime

the local date-time, not null

offset ZoneOffset

the zone offset, not null

zone ZoneId

the time-zone, not null

Return:

ZonedDateTime

the zoned date-time, not null

public static parse(text: string, formatter: DateTimeFormatter): ZonedDateTime source

Obtains an instance of ZonedDateTime from a text string such as 2007-12-03T10:15:30+01:00[Europe/Paris].

The string must represent a valid date-time and is parsed using org.threeten.bp.format.DateTimeFormatter#ISO_ZONED_DATE_TIME.

Params:

NameTypeAttributeDescription
text string
  • nullable: false

the text to parse such as '2007-12-03T10:15:30+01:00[Europe/Paris]', not null

formatter DateTimeFormatter
  • optional
  • default: DateTimeFormatter.ISO_ZONED_DATE_TIME
  • nullable: false

the formatter to use

Return:

ZonedDateTime

the parsed zoned date-time, not null

Throw:

*

DateTimeParseException if the text cannot be parsed

Public Methods

public dayOfMonth(): number source

Gets the day-of-month field.

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

Return:

number

the day-of-month, from 1 to 31

public dayOfWeek(): DayOfWeek source

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, use DayOfWeek#getValue.

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

Return:

DayOfWeek

the day-of-week, not null

public dayOfYear(): number source

Gets the day-of-year field.

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

Return:

number

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

public equals(other: *): boolean source

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.

Override:

ChronoZonedDateTime#equals

Params:

NameTypeAttributeDescription
other *

the object to check, null returns false

Return:

boolean

true if this is equal to the other date-time

public format(formatter: DateTimeFormatter): string source

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

Override:

ChronoZonedDateTime#format

Params:

NameTypeAttributeDescription
formatter DateTimeFormatter

the formatter to use, not null

Return:

string

the formatted date-time string, not null

Throw:

*

DateTimeException if an error occurs during printing

public get(field: TemporalField): number source

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 (see isSupported) 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 passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Override:

TemporalAccessor#get

Params:

NameTypeAttributeDescription
field TemporalField
  • nullable: false

the field to get, not null

Return:

number

the value for the field

Throw:

*

DateTimeException if a value for the field cannot be obtained

*

ArithmeticException if numeric overflow occurs

public getLong(field: TemporalField): number source

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 (see isSupported) 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 passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Params:

NameTypeAttributeDescription
field TemporalField
  • nullable: false

the field to get, not null

Return:

number

the value for the field

Throw:

*

DateTimeException if a value for the field cannot be obtained

*

ArithmeticException if numeric overflow occurs

public hashCode(): number source

A hash code for this date-time.

Return:

number

a suitable hash code

public hour(): number source

Gets the hour-of-day field.

Return:

number

the hour-of-day, from 0 to 23

public isSupported(fieldOrUnit: TemporalField | TemporalUnit): boolean source

Checks if the specified field is supported.

This checks if this date-time can be queried for the specified field. If false, then calling range and get 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 passing this as the argument. Whether the field is supported is determined by the field.

Params:

NameTypeAttributeDescription
fieldOrUnit TemporalField | TemporalUnit

the field to check, null returns false

Return:

boolean

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

public minus(): * source

function overloading for ZonedDateTime.minus

if called with 1 argument ZonedDateTime.minusTemporalAmount is applied, otherwise ZonedDateTime.minus2

Return:

*

public minus2(amountToSubtract: number, unit: TemporalUnit): ZonedDateTime source

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 ofLocal 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 ofInstant with the offset before the subtraction.

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
amountToSubtract number

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

unit TemporalUnit

the unit of the period to subtract, not null

Return:

ZonedDateTime

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

Throw:

*

DateTimeException if the unit cannot be added to this type

public minusDays(days: number): ZonedDateTime source

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

This operates on the local time-line, subtracting days from 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.

Params:

NameTypeAttributeDescription
days number

the days to subtract, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the days subtracted, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public minusHours(hours: number): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
hours number

the hours to subtract, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the hours subtracted, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public minusMinutes(minutes: number): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
minutes number

the minutes to subtract, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the minutes subtracted, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public minusMonths(months: number): ZonedDateTime source

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

This operates on the local time-line, subtracting months from 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.

Params:

NameTypeAttributeDescription
months number

the months to subtract, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the months subtracted, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public minusNanos(nanos: number): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
nanos number

the nanos to subtract, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the nanoseconds subtracted, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public minusSeconds(seconds: number): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
seconds number

the seconds to subtract, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the seconds subtracted, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public minusTemporalAmount(amount: TemporalAmount): ZonedDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
amount TemporalAmount

the amount to subtract, not null

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the subtraction made, not null

Throw:

*

DateTimeException if the subtraction cannot be made

*

ArithmeticException if numeric overflow occurs

public minusWeeks(weeks: number): ZonedDateTime source

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

This operates on the local time-line, subtracting weeks from 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.

Params:

NameTypeAttributeDescription
weeks number

the weeks to subtract, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the weeks subtracted, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public minusYears(years: number): ZonedDateTime source

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

This operates on the local time-line, subtracting years from 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.

Params:

NameTypeAttributeDescription
years number

the years to subtract, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the years subtracted, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public minute(): number source

Gets the minute-of-hour field.

Return:

number

the minute-of-hour, from 0 to 59

public month(): Month source

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, use Month#getValue.

Return:

Month

the month-of-year, not null

See:

public monthValue(): number source

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.

Return:

number

the month-of-year, from 1 to 12

See:

public nano(): number source

Gets the nano-of-second field.

Return:

number

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

public offset(): * source

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

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

Return:

*

{ZoneOffset}the zone offset, not null

public plus(): * source

function overloading for ZonedDateTime.plus

if called with 1 argument ZonedDateTime.plusTemporalAmount is applied, otherwise ZonedDateTime.plus2

Return:

*

public plus2(amountToAdd: number, unit: TemporalUnit): ZonedDateTime source

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 ofLocal 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 ofInstant with the offset before the addition.

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
amountToAdd number

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

unit TemporalUnit

the unit of the period to add, not null

Return:

ZonedDateTime

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

Throw:

*

DateTimeException if the unit cannot be added to this type

public plusDays(days: number): * source

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.

Params:

NameTypeAttributeDescription
days number

the days to add, may be negative

Return:

*

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

Throw:

*

DateTimeException if the result exceeds the supported date range

public plusHours(hours: number): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
hours number

the hours to add, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the hours added, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public plusMinutes(minutes: number): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
minutes number

the minutes to add, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the minutes added, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public plusMonths(months: number): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
months number

the months to add, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the months added, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public plusNanos(nanos: number): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
nanos number

the nanos to add, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the nanoseconds added, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public plusSeconds(seconds: number): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
seconds number

the seconds to add, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the seconds added, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public plusTemporalAmount(amount: TemporalAmount): ZonedDateTime source

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

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
amount TemporalAmount
  • nullable: false

the amount to add, not null

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the addition made, not null

Throw:

*

DateTimeException if the addition cannot be made

*

ArithmeticException if numeric overflow occurs

public plusWeeks(weeks: number): * source

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.

Params:

NameTypeAttributeDescription
weeks number

the weeks to add, may be negative

Return:

*

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

Throw:

*

DateTimeException if the result exceeds the supported date range

public plusYears(years: number): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
years number

the years to add, may be negative

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the years added, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public query(query: TemporalQuery): * source

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

Override:

ChronoZonedDateTime#query

Params:

NameTypeAttributeDescription
query TemporalQuery

the query to invoke, not null

Return:

*

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

Throw:

*

DateTimeException if unable to query (defined by the query)

*

ArithmeticException if numeric overflow occurs (defined by the query)

public range(field: TemporalField): ValueRange source

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 (see isSupported) 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 passing this as the argument. Whether the range can be obtained is determined by the field.

Override:

TemporalAccessor#range

Params:

NameTypeAttributeDescription
field TemporalField

the field to query the range for, not null

Return:

ValueRange

the range of valid values for the field, not null

Throw:

*

DateTimeException if the range for the field cannot be obtained

public second(): number source

Gets the second-of-minute field.

Return:

number

the second-of-minute, from 0 to 59

public toJSON(): string source

Return:

string

same as ZonedDateTime.toString

public toLocalDate(): LocalDate source

Gets the LocalDate part of this date-time.

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

Return:

LocalDate

the date part of this date-time, not null

public toLocalDateTime(): LocalDateTime source

Gets the LocalDateTime part of this date-time.

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

Return:

LocalDateTime

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

public toLocalTime(): LocalTime source

Gets the LocalTime part of this date-time.

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

Return:

LocalTime

the time part of this date-time, not null

public toString(): string source

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.

Return:

string

a string representation of this date-time, not null

public truncatedTo(unit: TemporalUnit): ZonedDateTime source

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 ChronoUnit#MINUTES will set the second-of-minute and nano-of-second field to zero.

The unit must have a duration (see TemporalUnit#getDuration) that divides into the length of a standard day without remainder. This includes all supplied time units on ChronoUnit and ChronoUnit#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.

Params:

NameTypeAttributeDescription
unit TemporalUnit

the unit to truncate to, not null

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the time truncated, not null

Throw:

*

DateTimeException if unable to truncate

public until(endExclusive: Temporal, unit: TemporalUnit): number source

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.

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 passing this as the first argument and the input temporal as the second argument.

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
endExclusive Temporal

the end date-time, which is converted to a ZonedDateTime, not null

unit TemporalUnit

the unit to measure the period in, not null

Return:

number

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

Throw:

*

DateTimeException if the period cannot be calculated

*

ArithmeticException if numeric overflow occurs

public with(): * source

function overloading for ZonedDateTime.with

if called with 1 argument ZonedDateTime.withTemporalAdjuster is applied otherwise ZonedDateTime.with2

Return:

*

public with2(field: TemporalField, newValue: number): ZonedDateTime source

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 (see isSupported) will behave as in LocalDateTime#with. 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 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.

Params:

NameTypeAttributeDescription
field TemporalField

the field to set in the result, not null

newValue number

the new value of the field in the result

Return:

ZonedDateTime

a ZonedDateTime based on this with the specified field set, not null

Throw:

*

DateTimeException if the field cannot be set

*

UnsupportedTemporalTypeException if the field is not supported

*

ArithmeticException if numeric overflow occurs

public withDayOfMonth(dayOfMonth: number): ZonedDateTime source

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 (see LocalDateTime#withDayOfMonth) 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.

Params:

NameTypeAttributeDescription
dayOfMonth number

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

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the requested day, not null

Throw:

*

DateTimeException if the day-of-month value is invalid

*

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

public withDayOfYear(dayOfYear: number): ZonedDateTime source

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

This operates on the local time-line, changing the day-of-year (see LocalDateTime#withDayOfYear) 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.

Params:

NameTypeAttributeDescription
dayOfYear number

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

Return:

ZonedDateTime

a ZonedDateTime based on this date with the requested day, not null

Throw:

*

DateTimeException if the day-of-year value is invalid

*

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

public withEarlierOffsetAtOverlap(): ZonedDateTime source

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.

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the earlier offset, not null

public withFixedOffsetZone(): ZonedDateTime source

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.

Return:

ZonedDateTime

a ZonedDateTime with the zone ID set to the offset, not null

public withHour(hour: number): ZonedDateTime source

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

This operates on the local time-line, changing the time (see LocalDateTime#withHour) 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.

Params:

NameTypeAttributeDescription
hour number

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

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the requested hour, not null

Throw:

*

DateTimeException if the hour value is invalid

public withLaterOffsetAtOverlap(): ZonedDateTime source

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.

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the later offset, not null

public withMinute(minute: number): ZonedDateTime source

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

This operates on the local time-line, changing the time (see LocalDateTime#withMinute) 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.

Params:

NameTypeAttributeDescription
minute number

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

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the requested minute, not null

Throw:

*

DateTimeException if the minute value is invalid

public withMonth(month: number): ZonedDateTime source

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

This operates on the local time-line, changing the month (see LocalDateTime#withMonth) 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.

Params:

NameTypeAttributeDescription
month number

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

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the requested month, not null

Throw:

*

DateTimeException if the month-of-year value is invalid

public withNano(nanoOfSecond: number): ZonedDateTime source

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

This operates on the local time-line, changing the time (see LocalDateTime#withNano) 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.

Params:

NameTypeAttributeDescription
nanoOfSecond number

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

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the requested nanosecond, not null

Throw:

*

DateTimeException if the nano value is invalid

public withSecond(second: number): ZonedDateTime source

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

This operates on the local time-line, changing the time (see LocalDateTime#withSecond) 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.

Params:

NameTypeAttributeDescription
second number

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

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the requested second, not null

Throw:

*

DateTimeException if the second value is invalid

public withTemporalAdjuster(adjuster: TemporalAdjuster): ZonedDateTime source

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 method on the specified adjuster passing this as the argument.

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
adjuster TemporalAdjuster

the adjuster to use, not null

Return:

ZonedDateTime

a ZonedDateTime based on this with the adjustment made, not null

Throw:

*

DateTimeException if the adjustment cannot be made

*

ArithmeticException if numeric overflow occurs

public withYear(year: number): ZonedDateTime source

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

This operates on the local time-line, changing the year (see LocalDateTime#withYear) 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.

Params:

NameTypeAttributeDescription
year number

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

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the requested year, not null

Throw:

*

DateTimeException if the year value is invalid

public withZoneSameInstant(zone: ZoneId): ZonedDateTime source

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.

Params:

NameTypeAttributeDescription
zone ZoneId

the time-zone to change to, not null

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the requested zone, not null

Throw:

*

DateTimeException if the result exceeds the supported date range

public withZoneSameLocal(zone: ZoneId): ZonedDateTime source

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

To change the zone and adjust the local date-time, use withZoneSameInstant.

This instance is immutable and unaffected by this method call.

Params:

NameTypeAttributeDescription
zone ZoneId

the time-zone to change to, not null

Return:

ZonedDateTime

a ZonedDateTime based on this date-time with the requested zone, not null

public year(): number source

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. To obtain the year-of-era, use get(YEAR_OF_ERA).

Return:

number

the year, from MIN_YEAR to MAX_YEAR

public zone(): ZoneId source

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

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

The zone ID may be same as the offset (see getOffset). 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.

Return:

ZoneId

the time-zone, not null