final class LocalDateTime extends ChronoLocalDateTime[LocalDate] with Temporal with TemporalAdjuster with Serializable
A date-time without a time-zone in the ISO-8601 calendar system, such as
2007-12-03T10:15:30
.
LocalDateTime
is an immutable date-time object that represents a date-time, often viewed
as year-month-day-hour-minute-second. Other date and time fields, such as day-of-year,
day-of-week and week-of-year, can also be accessed. Time is represented to nanosecond precision.
For example, the value "2nd October 2007 at 13:45.30.123456789" can be stored in a
LocalDateTime
.
This class does not store or represent a time-zone. Instead, it is a description of the date, as used for birthdays, combined with the local time as seen on a wall clock. It cannot represent an instant on the time-line without additional information such as an offset or time-zone.
The ISO-8601 calendar system is the modern civil calendar system used today in most of the world. It is equivalent to the proleptic Gregorian calendar system, in which today's rules for leap years are applied for all time. For most applications written today, the ISO-8601 rules are entirely suitable. However, any application that makes use of historical dates, and requires them to be accurate will find the ISO-8601 approach unsuitable.
Specification for implementors
This class is immutable and thread-safe.
- Annotations
- @SerialVersionUID()
- Alphabetic
- By Inheritance
- LocalDateTime
- Serializable
- ChronoLocalDateTime
- Ordered
- Comparable
- TemporalAdjuster
- Temporal
- TemporalAccessor
- 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
-
def
<(that: ChronoLocalDateTime[_]): Boolean
- Definition Classes
- Ordered
-
def
<=(that: ChronoLocalDateTime[_]): Boolean
- Definition Classes
- Ordered
-
final
def
==(arg0: Any): Boolean
- Definition Classes
- AnyRef → Any
-
def
>(that: ChronoLocalDateTime[_]): Boolean
- Definition Classes
- Ordered
-
def
>=(that: ChronoLocalDateTime[_]): Boolean
- Definition Classes
- Ordered
-
def
adjustInto(temporal: Temporal): Temporal
Adjusts the specified temporal object to have the same date and time as this object.
Adjusts the specified temporal object to have the same date and time as this object.
This returns a temporal object of the same observable type as the input with the date and time changed to be the same as this.
The adjustment is equivalent to using
long)
twice, passingChronoField#EPOCH_DAY
andChronoField#NANO_OF_DAY
as the fields.In most cases, it is clearer to reverse the calling pattern by using
Temporal#with(TemporalAdjuster)
:// these two lines are equivalent, but the second approach is recommended temporal = thisLocalDateTime.adjustInto(temporal); temporal = temporal.with(thisLocalDateTime);
This instance is immutable and unaffected by this method call.
- temporal
the target object to be adjusted, not null
- returns
the adjusted object, not null
- Definition Classes
- LocalDateTime → ChronoLocalDateTime → TemporalAdjuster
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if unable to make the adjustment
-
final
def
asInstanceOf[T0]: T0
- Definition Classes
- Any
-
def
atOffset(offset: ZoneOffset): OffsetDateTime
Combines this date-time with an offset to create an
OffsetDateTime
.Combines this date-time with an offset to create an
OffsetDateTime
.This returns an
OffsetDateTime
formed from this date-time at the specified offset. All possible combinations of date-time and offset are valid.- offset
the offset to combine with, not null
- returns
the offset date-time formed from this date-time and the specified offset, not null
-
def
atZone(zone: ZoneId): ZonedDateTime
Combines this date-time with a time-zone to create a
ZonedDateTime
.Combines this date-time with a time-zone to create a
ZonedDateTime
.This returns a
ZonedDateTime
formed from this date-time at the specified time-zone. The result will match this 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 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. This method uses the earlier offset 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".
To obtain the later offset during an overlap, call
ZonedDateTime#withLaterOffsetAtOverlap()
on the result of this method. To throw an exception when there is a gap or overlap, useZoneOffset, ZoneId)
.- zone
the time-zone to use, not null
- returns
the zoned date-time formed from this date-time, not null
- Definition Classes
- LocalDateTime → ChronoLocalDateTime
-
def
clone(): AnyRef
- Attributes
- protected[lang]
- Definition Classes
- AnyRef
- Annotations
- @throws( ... ) @native()
-
def
compare(other: ChronoLocalDateTime[_]): 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 underlying time-line date-time, then on the chronology. It is "consistent with equals", as defined by
Comparable
.For example, the following is the comparator order:
2012-12-03T12:00 (ISO)
2012-12-04T12:00 (ISO)
2555-12-04T12:00 (ThaiBuddhist)
2012-12-05T12:00 (ISO)
Values #2 and #3 represent the same date-time on the time-line. When two values represent the same date-time, the chronology ID is compared to distinguish them. This step is needed to make the ordering "consistent with equals".
If all the date-time objects being compared are in the same chronology, then the additional chronology stage is not required and only the local date-time is used.
- other
the other date-time to compare to, not null
- returns
the comparator value, negative if less, positive if greater
- Definition Classes
- ChronoLocalDateTime → Ordered
-
def
compareTo(other: ChronoLocalDateTime[_]): Int
Compares this date-time to another date-time.
Compares this date-time to another date-time.
The comparison is primarily based on the date-time, from earliest to latest. It is "consistent with equals", as defined by
Comparable
.If all the date-times being compared are instances of
LocalDateTime
, then the comparison will be entirely based on the date-time. If some dates being compared are in different chronologies, then the chronology is also considered, seeChronoLocalDateTime#compareTo
.- other
the other date-time to compare to, not null
- returns
the comparator value, negative if less, positive if greater
- Definition Classes
- LocalDateTime → 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.
Compares this
LocalDateTime
with another ensuring that the date-time is the same. Only objects of typeLocalDateTime
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
- LocalDateTime → ChronoLocalDateTime → 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-time will be passed to the formatter
DateTimeFormatter#format(TemporalAccessor) print method
.- formatter
the formatter to use, not null
- returns
the formatted date-time string, not null
- Definition Classes
- LocalDateTime → ChronoLocalDateTime
- 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
andEPOCH_MONTH
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
- LocalDateTime → 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
- ChronoLocalDateTime
-
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
- LocalDateTime → 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
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
hashCode(): Int
A hash code for this date-time.
A hash code for this date-time.
- returns
a suitable hash code
- Definition Classes
- LocalDateTime → ChronoLocalDateTime → AnyRef → Any
-
def
isAfter(other: ChronoLocalDateTime[_ <: ChronoLocalDate]): Boolean
Checks if this date-time is after the specified date-time.
Checks if this date-time is after the specified date-time.
This checks to see if this date-time represents a point on the local time-line after the other date-time.
LocalDate a = LocalDateTime.of(2012, 6, 30, 12, 00); LocalDate b = LocalDateTime.of(2012, 7, 1, 12, 00); a.isAfter(b) == false a.isAfter(a) == false b.isAfter(a) == true
This method only considers the position of the two date-times on the local time-line. It does not take into account the chronology, or calendar system. This is different from the comparison in
#compareTo(ChronoLocalDateTime)
, but is the same approach as#DATE_TIME_COMPARATOR
.- other
the other date-time to compare to, not null
- returns
true if this date-time is after the specified date-time
- Definition Classes
- LocalDateTime → ChronoLocalDateTime
-
def
isBefore(other: ChronoLocalDateTime[_ <: ChronoLocalDate]): Boolean
Checks if this date-time is before the specified date-time.
Checks if this date-time is before the specified date-time.
This checks to see if this date-time represents a point on the local time-line before the other date-time.
LocalDate a = LocalDateTime.of(2012, 6, 30, 12, 00); LocalDate b = LocalDateTime.of(2012, 7, 1, 12, 00); a.isBefore(b) == true a.isBefore(a) == false b.isBefore(a) == false
This method only considers the position of the two date-times on the local time-line. It does not take into account the chronology, or calendar system. This is different from the comparison in
#compareTo(ChronoLocalDateTime)
, but is the same approach as#DATE_TIME_COMPARATOR
.- other
the other date-time to compare to, not null
- returns
true if this date-time is before the specified date-time
- Definition Classes
- LocalDateTime → ChronoLocalDateTime
-
def
isEqual(other: ChronoLocalDateTime[_ <: ChronoLocalDate]): Boolean
Checks if this date-time is equal to the specified date-time.
Checks if this date-time is equal to the specified date-time.
This checks to see if this date-time represents the same point on the local time-line as the other date-time.
LocalDate a = LocalDateTime.of(2012, 6, 30, 12, 00); LocalDate b = LocalDateTime.of(2012, 7, 1, 12, 00); a.isEqual(b) == false a.isEqual(a) == true b.isEqual(a) == false
This method only considers the position of the two date-times on the local time-line. It does not take into account the chronology, or calendar system. This is different from the comparison in
#compareTo(ChronoLocalDateTime)
, but is the same approach as#DATE_TIME_COMPARATOR
.- other
the other date-time to compare to, not null
- returns
true if this date-time is equal to the specified date-time
- Definition Classes
- LocalDateTime → ChronoLocalDateTime
-
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
- LocalDateTime → 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
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
- LocalDateTime → TemporalAccessor
-
def
minus(amountToSubtract: Long, unit: TemporalUnit): LocalDateTime
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.
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 LocalDateTime} based on this date-time with the specified period subtracted, not null
- Definition Classes
- LocalDateTime → ChronoLocalDateTime → Temporal
- Exceptions thrown
DateTimeException
if the unit cannot be added to this type
-
def
minus(amount: TemporalAmount): LocalDateTime
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 LocalDateTime} based on this date-time with the subtraction made, not null
- Definition Classes
- LocalDateTime → ChronoLocalDateTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the subtraction cannot be made
-
def
minusDays(days: Long): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in days subtracted.Returns a copy of this
LocalDateTime
with the specified period in days subtracted.This method subtracts the specified amount from the days field incrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2009-01-01 minus one day would result in 2008-12-31.
This instance is immutable and unaffected by this method call.
- days
the days to subtract, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in hours subtracted.Returns a copy of this
LocalDateTime
with the specified period in hours subtracted.This instance is immutable and unaffected by this method call.
- hours
the hours to subtract, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in minutes subtracted.Returns a copy of this
LocalDateTime
with the specified period in minutes subtracted.This instance is immutable and unaffected by this method call.
- minutes
the minutes to subtract, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in months subtracted.Returns a copy of this
LocalDateTime
with the specified period in months subtracted.This method subtracts the specified amount from the months field in three steps:
- Subtract the input months from the month-of-year field
- Check if the resulting date would be invalid
- Adjust the day-of-month to the last valid day if necessary
For example, 2007-03-31 minus one month would result in the invalid date 2007-04-31. Instead of returning an invalid result, the last valid day of the month, 2007-04-30, is selected instead.
This instance is immutable and unaffected by this method call.
- months
the months to subtract, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in nanoseconds subtracted.Returns a copy of this
LocalDateTime
with the specified period in nanoseconds subtracted.This instance is immutable and unaffected by this method call.
- nanos
the nanos to subtract, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in seconds subtracted.Returns a copy of this
LocalDateTime
with the specified period in seconds subtracted.This instance is immutable and unaffected by this method call.
- seconds
the seconds to subtract, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in weeks subtracted.Returns a copy of this
LocalDateTime
with the specified period in weeks subtracted.This method subtracts the specified amount in weeks from the days field decrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2009-01-07 minus one week would result in 2008-12-31.
This instance is immutable and unaffected by this method call.
- weeks
the weeks to subtract, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in years subtracted.Returns a copy of this
LocalDateTime
with the specified period in years subtracted.This method subtracts the specified amount from the years field in three steps:
- Subtract the input years from the year field
- Check if the resulting date would be invalid
- Adjust the day-of-month to the last valid day if necessary
For example, 2008-02-29 (leap year) minus one year would result in the invalid date 2009-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2009-02-28, is selected instead.
This instance is immutable and unaffected by this method call.
- years
the years to subtract, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
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.
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 LocalDateTime} based on this date-time with the specified period added, not null
- Definition Classes
- LocalDateTime → ChronoLocalDateTime → Temporal
- Exceptions thrown
DateTimeException
if the unit cannot be added to this type
-
def
plus(amount: TemporalAmount): LocalDateTime
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 LocalDateTime} based on this date-time with the addition made, not null
- Definition Classes
- LocalDateTime → ChronoLocalDateTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the addition cannot be made
-
def
plusDays(days: Long): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in days added.Returns a copy of this
LocalDateTime
with the specified period in days added.This method adds the specified amount to the days field incrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2008-12-31 plus one day would result in 2009-01-01.
This instance is immutable and unaffected by this method call.
- days
the days to add, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in hours added.Returns a copy of this
LocalDateTime
with the specified period in hours added.This instance is immutable and unaffected by this method call.
- hours
the hours to add, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in minutes added.Returns a copy of this
LocalDateTime
with the specified period in minutes added.This instance is immutable and unaffected by this method call.
- minutes
the minutes to add, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in months added.Returns a copy of this
LocalDateTime
with the specified period in months added.This method adds the specified amount to the months field in three steps:
- Add the input months to the month-of-year field
- Check if the resulting date would be invalid
- Adjust the day-of-month to the last valid day if necessary
For example, 2007-03-31 plus one month would result in the invalid date 2007-04-31. Instead of returning an invalid result, the last valid day of the month, 2007-04-30, is selected instead.
This instance is immutable and unaffected by this method call.
- months
the months to add, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in nanoseconds added.Returns a copy of this
LocalDateTime
with the specified period in nanoseconds added.This instance is immutable and unaffected by this method call.
- nanos
the nanos to add, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in seconds added.Returns a copy of this
LocalDateTime
with the specified period in seconds added.This instance is immutable and unaffected by this method call.
- seconds
the seconds to add, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in weeks added.Returns a copy of this
LocalDateTime
with the specified period in weeks added.This method adds the specified amount in weeks to the days field incrementing the month and year fields as necessary to ensure the result remains valid. The result is only invalid if the maximum/minimum year is exceeded.
For example, 2008-12-31 plus one week would result in 2009-01-07.
This instance is immutable and unaffected by this method call.
- weeks
the weeks to add, may be negative
- returns
a { @code LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the specified period in years added.Returns a copy of this
LocalDateTime
with the specified period in years added.This method adds the specified amount to the years field in three steps:
- Add the input years to the year field
- Check if the resulting date would be invalid
- Adjust the day-of-month to the last valid day if necessary
For example, 2008-02-29 (leap year) plus one year would result in the invalid date 2009-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2009-02-28, is selected instead.
This instance is immutable and unaffected by this method call.
- years
the years to add, may be negative
- returns
a { @code LocalDateTime} 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
- LocalDateTime → ChronoLocalDateTime → 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
- LocalDateTime → 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(offset: ZoneOffset): 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 combines this local date-time and the specified 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.
- offset
the offset to use for the conversion, not null
- returns
the number of seconds from the epoch of 1970-01-01T00:00:00Z
- Definition Classes
- ChronoLocalDateTime
-
def
toInstant(offset: ZoneOffset): Instant
Converts this date-time to an
Instant
.Converts this date-time to an
Instant
.This combines this local date-time and the specified offset to form an
Instant
.- offset
the offset to use for the conversion, not null
- returns
an
Instant
representing the same instant, not null
- Definition Classes
- ChronoLocalDateTime
-
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
- LocalDateTime → ChronoLocalDateTime
-
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
- LocalDateTime → ChronoLocalDateTime
-
def
toString(): String
Outputs this date-time as a
String
, such as2007-12-03T10:15:30
.Outputs this date-time as a
String
, such as2007-12-03T10:15:30
.The output will be one of the following ISO-8601 formats:
yyyy-MM-dd'T'HH:mm
yyyy-MM-dd'T'HH:mm:ss
yyyy-MM-dd'T'HH:mm:ss.SSS
yyyy-MM-dd'T'HH:mm:ss.SSSSSS
yyyy-MM-dd'T'HH:mm:ss.SSSSSSSSS
The format used will be the shortest that outputs the full value of the time where the omitted parts are implied to be zero.
- returns
a string representation of this date-time, not null
- Definition Classes
- LocalDateTime → ChronoLocalDateTime → AnyRef → Any
-
def
truncatedTo(unit: TemporalUnit): LocalDateTime
Returns a copy of this
LocalDateTime
with the time truncated.Returns a copy of this
LocalDateTime
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 instance is immutable and unaffected by this method call.
- unit
the unit to truncate to, not null
- returns
a { @code LocalDateTime} 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. TheTemporal
passed to this method must be aLocalDateTime
. For example, the period in days between two date-times can be calculated usingstartDateTime.until(endDateTime, DAYS)
.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:00 and 2012-08-14T23:59 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.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 LocalDateTime}, 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
- LocalDateTime → 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): LocalDateTime
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 new
LocalDateTime
, 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#isSupported(TemporalField) supported fields
will behave as per the matching method onLocalDate#with(TemporalField, long) LocalDate
orlong) LocalTime
. All otherChronoField
instances will throw aDateTimeException
.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 LocalDateTime} based on { @code this} with the specified field set, not null
- Definition Classes
- LocalDateTime → ChronoLocalDateTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the field cannot be set
-
def
with(adjuster: TemporalAdjuster): LocalDateTime
Returns an adjusted copy of this date-time.
Returns an adjusted copy of this date-time.
This returns a new
LocalDateTime
, 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 = localDateTime.with(JULY).with(lastDayOfMonth());
The classes
LocalDate
andLocalTime
implementTemporalAdjuster
, thus this method can be used to change the date, time or offset:result = localDateTime.with(date); result = localDateTime.with(time);
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 LocalDateTime} based on { @code this} with the adjustment made, not null
- Definition Classes
- LocalDateTime → ChronoLocalDateTime → Temporal
- Exceptions thrown
ArithmeticException
if numeric overflow occursDateTimeException
if the adjustment cannot be made
-
def
withDayOfMonth(dayOfMonth: Int): LocalDateTime
Returns a copy of this
LocalDateTime
with the day-of-month altered.Returns a copy of this
LocalDateTime
with the day-of-month altered. If the resultingLocalDateTime
is invalid, an exception is thrown. The time does not affect the calculation and will be the same in the result.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 LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the day-of-year altered.Returns a copy of this
LocalDateTime
with the day-of-year altered. If the resultingLocalDateTime
is invalid, an exception is thrown.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 LocalDateTime} based on this date with the requested day, not null
- Exceptions thrown
DateTimeException
if the day-of-year is invalid for the year
-
def
withHour(hour: Int): LocalDateTime
Returns a copy of this
LocalDateTime
with the hour-of-day value altered.Returns a copy of this
LocalDateTime
with the hour-of-day value altered.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 LocalDateTime} based on this date-time with the requested hour, not null
- Exceptions thrown
DateTimeException
if the hour value is invalid
-
def
withMinute(minute: Int): LocalDateTime
Returns a copy of this
LocalDateTime
with the minute-of-hour value altered.Returns a copy of this
LocalDateTime
with the minute-of-hour value altered.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 LocalDateTime} based on this date-time with the requested minute, not null
- Exceptions thrown
DateTimeException
if the minute value is invalid
-
def
withMonth(month: Int): LocalDateTime
Returns a copy of this
LocalDateTime
with the month-of-year altered.Returns a copy of this
LocalDateTime
with the month-of-year altered. The time does not affect the calculation and will be the same in the result. If the day-of-month is invalid for the year, it will be changed to the last valid day of the month.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 LocalDateTime} 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): LocalDateTime
Returns a copy of this
LocalDateTime
with the nano-of-second value altered.Returns a copy of this
LocalDateTime
with the nano-of-second value altered.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 LocalDateTime} based on this date-time with the requested nanosecond, not null
- Exceptions thrown
DateTimeException
if the nano value is invalid
-
def
withSecond(second: Int): LocalDateTime
Returns a copy of this
LocalDateTime
with the second-of-minute value altered.Returns a copy of this
LocalDateTime
with the second-of-minute value altered.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 LocalDateTime} based on this date-time with the requested second, not null
- Exceptions thrown
DateTimeException
if the second value is invalid
-
def
withYear(year: Int): LocalDateTime
Returns a copy of this
LocalDateTime
with the year altered.Returns a copy of this
LocalDateTime
with the year altered. The time does not affect the calculation and will be the same in the result. If the day-of-month is invalid for the year, it will be changed to the last valid day of the month.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 LocalDateTime} based on this date-time with the requested year, not null
- Exceptions thrown
DateTimeException
if the year value is invalid