object ZonedDateTime extends Serializable
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- ZonedDateTime
- Serializable
- AnyRef
- Any
- Hide All
- Show All
- Public
- All
Value Members
- final def !=(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def ##(): Int
- Definition Classes
- AnyRef → Any
- final def ==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
- final def asInstanceOf[T0]: T0
- Definition Classes
- Any
- def clone(): AnyRef
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.CloneNotSupportedException]) @native()
- final def eq(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef
- def equals(arg0: AnyRef): Boolean
- Definition Classes
- AnyRef → Any
- def finalize(): Unit
- Attributes
- protected[java.lang]
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.Throwable])
- def from(temporal: TemporalAccessor): ZonedDateTime
Obtains an instance of
ZonedDateTime
from a temporal object.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 ofZonedDateTime
.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 ofZoneId
and instant, orZoneId
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
.- temporal
the temporal object to convert, not null
- returns
the zoned date-time, not null
- Exceptions thrown
DateTimeException
if unable to convert to an { @code ZonedDateTime}
- final def getClass(): Class[_ <: AnyRef]
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- def hashCode(): Int
- Definition Classes
- AnyRef → Any
- Annotations
- @native()
- final def isInstanceOf[T0]: Boolean
- Definition Classes
- Any
- 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 now(clock: Clock): ZonedDateTime
Obtains the current date-time from the specified clock.
Obtains the current date-time from the specified clock.
This will query the specified clock to obtain the current date-time. The zone and offset will be set based on the time-zone in the clock.
Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using
dependency injection
.- clock
the clock to use, not null
- returns
the current date-time, not null
- def now(zone: ZoneId): ZonedDateTime
Obtains the current date-time from the system clock in the specified time-zone.
Obtains the current date-time from the system clock in the specified time-zone.
This will query the
system clock
to obtain the current date-time. Specifying the time-zone avoids dependence on the default time-zone. The offset will be calculated from the specified time-zone.Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.
- zone
the zone ID to use, not null
- returns
the current date-time using the system clock, not null
- def now: ZonedDateTime
Obtains the current date-time from the system clock in the default time-zone.
Obtains the current date-time from the system clock in the default time-zone.
This will query the
system clock
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.
- returns
the current date-time using the system clock, not null
- def of(year: Int, month: Int, dayOfMonth: Int, hour: Int, minute: Int, second: Int, nanoOfSecond: Int, zone: ZoneId): ZonedDateTime
Obtains an instance of
ZonedDateTime
from a year, month, day, hour, minute, second, nanosecond and time-zone.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
rules
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.- year
the year to represent, from MIN_YEAR to MAX_YEAR
- month
the month-of-year to represent, from 1 (January) to 12 (December)
- dayOfMonth
the day-of-month to represent, from 1 to 31
- hour
the hour-of-day to represent, from 0 to 23
- minute
the minute-of-hour to represent, from 0 to 59
- second
the second-of-minute to represent, from 0 to 59
- nanoOfSecond
the nano-of-second to represent, from 0 to 999,999,999
- zone
the time-zone, not null
- returns
the offset date-time, not null
- Exceptions thrown
DateTimeException
if the value of any field is out of range, or if the day-of-month is invalid for the month-year
- def of(localDateTime: LocalDateTime, zone: ZoneId): ZonedDateTime
Obtains an instance of
ZonedDateTime
from a local date-time.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
rules
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".
- localDateTime
the local date-time, not null
- zone
the time-zone, not null
- returns
the zoned date-time, not null
- def of(date: LocalDate, time: LocalTime, zone: ZoneId): ZonedDateTime
Obtains an instance of
ZonedDateTime
from a local date and time.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
rules
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".
- date
the local date, not null
- time
the local time, not null
- zone
the time-zone, not null
- returns
the offset date-time, not null
- def ofInstant(localDateTime: LocalDateTime, offset: ZoneOffset, zone: ZoneId): ZonedDateTime
Obtains an instance of
ZonedDateTime
from the instant formed by combining the local date-time and offset.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
theLocalDateTime
andZoneOffset
. 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 aZoneOffset
, this method is equivalent toZoneId)
.- localDateTime
the local date-time, not null
- offset
the zone offset, not null
- zone
the time-zone, not null
- returns
the zoned date-time, not null
- def ofInstant(instant: Instant, zone: ZoneId): ZonedDateTime
Obtains an instance of
ZonedDateTime
from anInstant
.Obtains an instance of
ZonedDateTime
from anInstant
.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.
- instant
the instant to create the date-time from, not null
- zone
the time-zone, not null
- returns
the zoned date-time, not null
- Exceptions thrown
DateTimeException
if the result exceeds the supported range
- def ofLocal(localDateTime: LocalDateTime, zone: ZoneId, preferredOffset: ZoneOffset): ZonedDateTime
Obtains an instance of
ZonedDateTime
from a local date-time using the preferred offset if possible.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
rules
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".
- localDateTime
the local date-time, not null
- zone
the time-zone, not null
- preferredOffset
the zone offset, null if no preference
- returns
the zoned date-time, not null
- def 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.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.
- localDateTime
the local date-time, not null
- offset
the zone offset, not null
- zone
the time-zone, not null
- returns
the zoned date-time, not null
- def parse(text: CharSequence, formatter: DateTimeFormatter): ZonedDateTime
Obtains an instance of
ZonedDateTime
from a text string using a specific formatter.Obtains an instance of
ZonedDateTime
from a text string using a specific formatter.The text is parsed using the formatter, returning a date-time.
- text
the text to parse, not null
- formatter
the formatter to use, not null
- returns
the parsed zoned date-time, not null
- Exceptions thrown
DateTimeParseException
if the text cannot be parsed
- def parse(text: CharSequence): ZonedDateTime
Obtains an instance of
ZonedDateTime
from a text string such as2007-12-03T10:15:30+01:00[Europe/Paris]
.Obtains an instance of
ZonedDateTime
from a text string such as2007-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
.- text
the text to parse such as "2007-12-03T10:15:30+01:00[Europe/Paris]", not null
- returns
the parsed zoned date-time, not null
- Exceptions thrown
DateTimeParseException
if the text cannot be parsed
- final def synchronized[T0](arg0: => T0): T0
- Definition Classes
- AnyRef
- def toString(): String
- Definition Classes
- AnyRef → Any
- final def wait(): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long, arg1: Int): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException])
- final def wait(arg0: Long): Unit
- Definition Classes
- AnyRef
- Annotations
- @throws(classOf[java.lang.InterruptedException]) @native()