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:
- 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.
This class is immutable and thread-safe.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- ZonedDateTime
- Serializable
- ChronoZonedDateTime
- Ordered
- Comparable
- Temporal
- TemporalAccessor
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Instance Constructors
-
new
ZonedDateTime(dateTime: LocalDateTime, offset: ZoneOffset, zone: ZoneId)
- 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
-
final
def
!=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
final
def
##(): Int
- Definition Classes
- AnyRef → Any
-
def
<(that: ChronoZonedDateTime[_]): Boolean
- Definition Classes
- Ordered
-
def
<=(that: ChronoZonedDateTime[_]): Boolean
- Definition Classes
- Ordered
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
>(that: ChronoZonedDateTime[_]): Boolean
- Definition Classes
- Ordered
-
def
>=(that: ChronoZonedDateTime[_]): Boolean
- Definition Classes
- Ordered
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
compare(other: ChronoZonedDateTime[_]): Int
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
-
def
compareTo(other: ChronoZonedDateTime[_]): Int
- Definition Classes
- ZonedDateTime → Ordered → Comparable
-
final
def
eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
def
equals(obj: Any): Boolean
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
- ZonedDateTime → ChronoZonedDateTime → AnyRef → Any
-
def
finalize(): Unit
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( classOf[java.lang.Throwable] )
-
def
format(formatter: DateTimeFormatter): String
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
- ZonedDateTime → ChronoZonedDateTime
- Exceptions thrown
DateTimeException
if an error occurs during printing
-
def
get(field: TemporalField): Int
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#isSupported(TemporalField) supported fields
will return valid values based on this date-time, exceptNANO_OF_DAY
,MICRO_OF_DAY
,EPOCH_DAY
,EPOCH_MONTH
andINSTANT_SECONDS
which are too large to fit in anint
and throw aDateTimeException
. All otherChronoField
instances will throw aDateTimeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)
passingthis
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
- ZonedDateTime → ChronoZonedDateTime → TemporalAccessor
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if a value for the field cannot be obtained
-
def
getChronology: Chronology
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 inChronoField
are defined by the chronology.- returns
the chronology, not null
- Definition Classes
- ChronoZonedDateTime
-
final
def
getClass(): Class[_]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
-
def
getDayOfMonth: Int
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
-
def
getDayOfWeek: DayOfWeek
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 whatint
values mean. If you need access to the primitiveint
value then the enum provides theint value
.Additional information can be obtained from the
DayOfWeek
. This includes textual names of the values.- returns
the day-of-week, not null
-
def
getDayOfYear: Int
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
-
def
getHour: Int
Gets the hour-of-day field.
Gets the hour-of-day field.
- returns
the hour-of-day, from 0 to 23
-
def
getLong(field: TemporalField): Long
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#isSupported(TemporalField) supported fields
will return valid values based on this date-time. All otherChronoField
instances will throw aDateTimeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.getFrom(TemporalAccessor)
passingthis
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
- ZonedDateTime → ChronoZonedDateTime → TemporalAccessor
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if a value for the field cannot be obtained
-
def
getMinute: Int
Gets the minute-of-hour field.
Gets the minute-of-hour field.
- returns
the minute-of-hour, from 0 to 59
-
def
getMonth: Month
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 whatint
values mean. If you need access to the primitiveint
value then the enum provides theint value
.- returns
the month-of-year, not null
- See also
#getMonthValue()
-
def
getMonthValue: Int
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 enumMonth
is used by calling#getMonth()
.- returns
the month-of-year, from 1 to 12
- See also
#getMonth()
-
def
getNano: Int
Gets the nano-of-second field.
Gets the nano-of-second field.
- returns
the nano-of-second, from 0 to 999,999,999
-
def
getOffset: ZoneOffset
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
- ZonedDateTime → ChronoZonedDateTime
-
def
getSecond: Int
Gets the second-of-minute field.
Gets the second-of-minute field.
- returns
the second-of-minute, from 0 to 59
-
def
getYear: Int
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, useget(YEAR_OF_ERA
.- returns
the year, from MIN_YEAR to MAX_YEAR
-
def
getZone: ZoneId
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
- ZonedDateTime → ChronoZonedDateTime
-
def
hashCode(): Int
A hash code for this date-time.
A hash code for this date-time.
- returns
a suitable hash code
- Definition Classes
- ZonedDateTime → ChronoZonedDateTime → AnyRef → Any
-
def
isAfter(other: ChronoZonedDateTime[_]): Boolean
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 usingdateTime1.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
-
def
isBefore(other: ChronoZonedDateTime[_]): Boolean
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 usingdateTime1.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
-
def
isEqual(other: ChronoZonedDateTime[_]): Boolean
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 usingdateTime1.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
-
final
def
isInstanceOf[T0]: Boolean
- Definition Classes
- Any
-
def
isSupported(unit: TemporalUnit): Boolean
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
andminus
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 falseIf the field is not a
ChronoUnit
, then the result of this method is obtained by invokingTemporalUnit.isSupportedBy(Temporal)
passingthis
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
- ZonedDateTime → Temporal
-
def
isSupported(field: TemporalField): Boolean
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
andget
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 otherChronoField
instances will return false.
If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.isSupportedBy(TemporalAccessor)
passingthis
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
- ZonedDateTime → TemporalAccessor
-
def
minus(amountToSubtract: Long, unit: TemporalUnit): ZonedDateTime
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
- ZonedDateTime → ChronoZonedDateTime → Temporal
- Exceptions thrown
DateTimeException
if the unit cannot be added to this type
-
def
minus(amount: TemporalAmount): ZonedDateTime
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 theTemporalAmount
interface. The calculation is delegated to the specified adjuster, which typically calls back toTemporalUnit)
.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
- ZonedDateTime → ChronoZonedDateTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the subtraction cannot be made
-
def
minusDays(days: Long): ZonedDateTime
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 aZonedDateTime
, 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
-
def
minusHours(hours: Long): ZonedDateTime
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
-
def
minusMinutes(minutes: Long): ZonedDateTime
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
-
def
minusMonths(months: Long): ZonedDateTime
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 aZonedDateTime
, 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
-
def
minusNanos(nanos: Long): ZonedDateTime
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
-
def
minusSeconds(seconds: Long): ZonedDateTime
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
-
def
minusWeeks(weeks: Long): ZonedDateTime
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 aZonedDateTime
, 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
-
def
minusYears(years: Long): ZonedDateTime
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 aZonedDateTime
, 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
-
final
def
ne(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
-
final
def
notify(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
final
def
notifyAll(): Unit
- Definition Classes
- AnyRef
- Annotations
- @native()
-
def
plus(amountToAdd: Long, unit: TemporalUnit): ZonedDateTime
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
#ofLocal(LocalDateTime, 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
#ofInstant(LocalDateTime, 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
- ZonedDateTime → ChronoZonedDateTime → Temporal
- Exceptions thrown
DateTimeException
if the unit cannot be added to this type
-
def
plus(amount: TemporalAmount): ZonedDateTime
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 theTemporalAmount
interface. The calculation is delegated to the specified adjuster, which typically calls back toTemporalUnit)
.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
- ZonedDateTime → ChronoZonedDateTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the addition cannot be made
-
def
plusDays(days: Long): ZonedDateTime
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 aZonedDateTime
, 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
-
def
plusHours(hours: Long): ZonedDateTime
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
-
def
plusMinutes(minutes: Long): ZonedDateTime
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
-
def
plusMonths(months: Long): ZonedDateTime
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 aZonedDateTime
, 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
-
def
plusNanos(nanos: Long): ZonedDateTime
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
-
def
plusSeconds(seconds: Long): ZonedDateTime
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
-
def
plusWeeks(weeks: Long): ZonedDateTime
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 aZonedDateTime
, 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
-
def
plusYears(years: Long): ZonedDateTime
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 aZonedDateTime
, 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
-
def
query[R](query: TemporalQuery[R]): R
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 passingthis
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
- ZonedDateTime → ChronoZonedDateTime → TemporalAccessor
- Exceptions thrown
ArithmeticException
if numeric overflow occurs (defined by the query)DateTimeException
if unable to query (defined by the query)
-
def
range(field: TemporalField): ValueRange
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#isSupported(TemporalField) supported fields
will return appropriate range instances. All otherChronoField
instances will throw aDateTimeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.rangeRefinedBy(TemporalAccessor)
passingthis
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
- ZonedDateTime → ChronoZonedDateTime → TemporalAccessor
- Exceptions thrown
DateTimeException
if the range for the field cannot be obtained
-
final
def
synchronized[T0](arg0: ⇒ T0): T0
- Definition Classes
- AnyRef
-
def
toEpochSecond: Long
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
-
def
toInstant: Instant
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 #getOffset() offset.- returns
an { @code Instant} representing the same instant, not null
- Definition Classes
- ChronoZonedDateTime
-
def
toLocalDate: LocalDate
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
- ZonedDateTime → ChronoZonedDateTime
-
def
toLocalDateTime: LocalDateTime
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
- ZonedDateTime → ChronoZonedDateTime
-
def
toLocalTime: LocalTime
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
- ZonedDateTime → ChronoZonedDateTime
-
def
toOffsetDateTime: OffsetDateTime
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
-
def
toString(): String
Outputs this date-time as a
String
, such as2007-12-03T10:15:30+01:00[Europe/Paris]
.Outputs this date-time as a
String
, such as2007-12-03T10:15:30+01:00[Europe/Paris]
.The format consists of the
LocalDateTime
followed by theZoneOffset
. If theZoneId
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
- ZonedDateTime → ChronoZonedDateTime → AnyRef → Any
-
def
truncatedTo(unit: TemporalUnit): ZonedDateTime
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
andDAYS
. Other units throw an exception.This operates on the local time-line,
truncating
the underlying local date-time. This is then converted back to aZonedDateTime
, 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
-
def
until(endExclusive: Temporal, unit: TemporalUnit): Long
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 usingstartDateTime.until(endDateTime, DAYS)
.The
Temporal
passed to this method must be aZonedDateTime
. 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 along
representing the amount of the specified unit. By contrast, the result ofbetween
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 unitsNANOS
,MICROS
,MILLIS
,SECONDS
,MINUTES
,HOURS
andHALF_DAYS
,DAYS
,WEEKS
,MONTHS
,YEARS
,DECADES
,CENTURIES
,MILLENNIA
andERAS
are supported. OtherChronoUnit
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 invokingTemporalUnit.between(Temporal, Temporal)
passingthis
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
- ZonedDateTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the period cannot be calculated
-
final
def
wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... )
-
final
def
wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
with(field: TemporalField, newValue: Long): ZonedDateTime
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 aDateTimeException
will be thrown.The
OFFSET_SECONDS
field will typically be ignored. The offset of aZonedDateTime
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 aDateTimeException
will be thrown.The other
supported fields
will behave as per the matching method onlong) LocalDateTime
. The zone is not part of the calculation and will be unchanged. When converting back toZonedDateTime
, 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 anUnsupportedTemporalTypeException
.If the field is not a
ChronoField
, then the result of this method is obtained by invokingTemporalField.adjustInto(Temporal, long)
passingthis
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
- ZonedDateTime → ChronoZonedDateTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the field cannot be setUnsupportedTemporalTypeException
if the field is not supported
-
def
with(adjuster: TemporalAdjuster): ZonedDateTime
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 theTemporalAdjuster
interface, such asMonth
andMonthDay
. 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
andLocalTime
implementTemporalAdjuster
, thus this method can be used to change the date, time or offset:result = zonedDateTime.with(date); result = zonedDateTime.with(time);
ZoneOffset
also implementsTemporalAdjuster
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 anInstant
. 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 passingthis
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
- ZonedDateTime → ChronoZonedDateTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the adjustment cannot be made
-
def
withDayOfMonth(dayOfMonth: Int): ZonedDateTime
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 aZonedDateTime
, 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
-
def
withDayOfYear(dayOfYear: Int): ZonedDateTime
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 aZonedDateTime
, 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
-
def
withEarlierOffsetAtOverlap: ZonedDateTime
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
- ZonedDateTime → ChronoZonedDateTime
-
def
withFixedOffsetZone: ZonedDateTime
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
-
def
withHour(hour: Int): ZonedDateTime
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 aZonedDateTime
, 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
-
def
withLaterOffsetAtOverlap: ZonedDateTime
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
- ZonedDateTime → ChronoZonedDateTime
-
def
withMinute(minute: Int): ZonedDateTime
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 aZonedDateTime
, 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
-
def
withMonth(month: Int): ZonedDateTime
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 aZonedDateTime
, 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
-
def
withNano(nanoOfSecond: Int): ZonedDateTime
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 aZonedDateTime
, 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
-
def
withSecond(second: Int): ZonedDateTime
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 aZonedDateTime
, 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
-
def
withYear(year: Int): ZonedDateTime
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 aZonedDateTime
, 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
-
def
withZoneSameInstant(zone: ZoneId): ZonedDateTime
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
- ZonedDateTime → ChronoZonedDateTime
- Exceptions thrown
DateTimeException
if the result exceeds the supported date range
-
def
withZoneSameLocal(zone: ZoneId): ZonedDateTime
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
#ofLocal(LocalDateTime, 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
- ZonedDateTime → ChronoZonedDateTime