LocalDateTime
Extends:
A date-time without a time-zone in the ISO-8601 calendar system, such as {@code 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.
Static properties of Class LocalTime
LocalDateTime.MIN
The minimum supported LocalDateTime, '-999999999-01-01T00:00:00'. This is the local date-time of midnight at the start of the minimum date. This combines LocalDate#MIN and LocalTime#MIN. This could be used by an application as a 'far past' date-time.
LocalDateTime.MAX
The maximum supported LocalDateTime, '+999999999-12-31T23:59:59.999999999'. This is the local date-time just before midnight at the end of the maximum date. This combines LocalDate#MAX and LocalTime#MAX. This could be used by an application as a 'far future' date-time.
Static Method Summary
Static Public Methods | ||
public static |
from(temporal: TemporalAccessor): LocalDateTime Obtains an instance of LocalDateTime from a temporal object. |
|
public static |
now(clock: Clock): LocalDateTime Obtains the current date-time from the specified clock. |
|
public static |
of(): LocalDateTime function overloading for LocalDateTime.of |
|
public static |
ofDateAndTime(date: LocalDate, time: LocalTime): LocalDateTime Obtains an instance of LocalDateTime from a date and time. |
|
public static |
ofEpochSecond(epochSecond: number, nanoOfSecond: number, offset: ZoneOffset): LocalDateTime Obtains an instance of LocalDateTime using seconds from the epoch of 1970-01-01T00:00:00Z. |
|
public static |
ofInstant(instant: Instant, zone: ZoneId): LocalDateTime Obtains an instance of LocalDateTime from an Instant and zone ID. |
|
public static |
ofNumbers(year: number, month: number, dayOfMonth: number, hour: number, minute: number, second: number, nanoOfSecond: number): LocalDateTime Obtains an instance of LocalDateTime from year, month, day, hour, minute, second and nanosecond. |
|
public static |
parse(text: string, formatter: DateTimeFormatter): LocalDateTime Obtains an instance of LocalDateTime from a text string using a specific formatter. |
Constructor Summary
Public Constructor | ||
public |
constructor(date: LocalDate, time: LocalTime) Constructor. |
Method Summary
Public Methods | ||
public |
adjustInto(temporal: TemporalAdjuster): LocalDateTime Adjusts the specified temporal object to have the same date and time as this object. |
|
public |
atZone(zone: ZoneId): ZonedDateTime Combines this date-time with a time-zone to create a ZonedDateTime. |
|
public |
compareTo(other: LocalDateTime): number Compares this date-time to another date-time. |
|
public |
dayOfMonth(): number Gets the day-of-month field. |
|
public |
Gets the day-of-week field, which is an enum DayOfWeek. |
|
public |
Gets the day-of-year field. |
|
public |
Checks if this date-time is equal to another date-time. |
|
public |
format(formatter: DateTimeFormatter): String Outputs this date-time as a String using the formatter. |
|
public |
get(field: TemporalField): number Gets the value of the specified field from this date-time as an int. |
|
public |
getLong(field: TemporalField): number Gets the value of the specified field from this date-time as a long. |
|
public |
A hash code for this date-time. |
|
public |
Gets the hour-of-day field. |
|
public |
isAfter(other: LocalDateTime): boolean Checks if this date-time is after the specified date-time. |
|
public |
isBefore(other: LocalDateTime): boolean Checks if this date-time is before the specified date-time. |
|
public |
Checks if this date-time is equal to the specified date-time. |
|
public |
isSupported(fieldOrUnit: TemporalField | TemporalUnit): boolean Checks if the specified field is supported. |
|
public |
minus(amount: TemporalAmount | number, unit: TemporalUnit): LocalDateTime function overloading for LocalDateTime.minus |
|
public |
minus2(amountToSubtract: number, unit: TemporalUnit): LocalDateTime Returns a copy of this date-time with the specified period subtracted. |
|
public |
minusDays(days: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in days subtracted. |
|
public |
minusHours(hours: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in hours subtracted. |
|
public |
minusMinutes(minutes: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in minutes subtracted. |
|
public |
minusMonths(months: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in months subtracted. |
|
public |
minusNanos(nanos: Number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in nanoseconds subtracted. |
|
public |
minusSeconds(seconds: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in seconds subtracted. |
|
public |
minusTemporalAmount(amount: TemporalAmount): LocalDateTime Returns a copy of this date-time with the specified period subtracted. |
|
public |
minusWeeks(weeks: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in weeks subtracted. |
|
public |
minusYears(years: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in years subtracted. |
|
public |
Gets the minute-of-hour field. |
|
public |
Gets the month-of-year field using the Month enum. |
|
public |
monthValue(): number Gets the month-of-year field from 1 to 12. |
|
public |
Gets the nano-of-second field. |
|
public |
plus(amount: TemporalAmount | number, unit: TemporalUnit): LocalDateTime function overloading for LocalDateTime.plus |
|
public |
plus2(amountToAdd: number, unit: TemporalUnit): LocalDateTime Returns a copy of this date-time with the specified period added. |
|
public |
plusDays(days: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in days added. |
|
public |
plusHours(hours: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in hours added. |
|
public |
plusMinutes(minutes: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in minutes added. |
|
public |
plusMonths(months: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in months added. |
|
public |
plusNanos(nanos: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in nanoseconds added. |
|
public |
plusSeconds(seconds: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in seconds added. |
|
public |
plusTemporalAmount(amount: TemporalAmount): LocalDateTime Returns a copy of this date-time with the specified period added. |
|
public |
plusWeeks(weeks: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in weeks added. |
|
public |
plusYears(years: number): LocalDateTime Returns a copy of this LocalDateTime with the specified period in years added. |
|
public |
query(query: TemporalQuery): * Queries this date-time using the specified query. |
|
public |
range(field: TemporalField): ValueRange Gets the range of valid values for the specified field. |
|
public |
Gets the second-of-minute field. |
|
public |
Gets the LocalDate part of this date-time. |
|
public |
Gets the LocalTime part of this date-time. |
|
public |
Outputs this date-time as a String, such as {@code 2007-12-03T10:15:30}. |
|
public |
truncatedTo(unit: TemporalUnit): LocalDateTime Returns a copy of this LocalDateTime with the time truncated. |
|
public |
until(endExclusive: Temporal, unit: TemporalUnit): number Calculates the period between this date-time and another date-time in terms of the specified unit. |
|
public |
with(adjusterOrField: TemporalAdjuster | TemporalField, newValue: number): LocalDateTime function overloading for LocalDateTime.with |
|
public |
with2(field: TemporalField, newValue: number): LocalDateTime Returns a copy of this date-time with the specified field set to a new value. |
|
public |
withDayOfMonth(dayOfMonth: number): LocalDateTime Returns a copy of this LocalDateTime with the day-of-month altered. |
|
public |
withDayOfYear(dayOfYear: number): LocalDateTime Returns a copy of this LocalDateTime with the day-of-year altered. |
|
public |
withHour(hour: number): LocalDateTime Returns a copy of this LocalDateTime with the hour-of-day value altered. |
|
public |
withMinute(minute: number): LocalDateTime Returns a copy of this LocalDateTime with the minute-of-hour value altered. |
|
public |
withMonth(month: number | Month): LocalDateTime Returns a copy of this LocalDateTime with the month-of-year altered. |
|
public |
withNano(nanoOfSecond: number): LocalDateTime Returns a copy of this LocalDateTime with the nano-of-second value altered. |
|
public |
withSecond(second: number): LocalDateTime Returns a copy of this LocalDateTime with the second-of-minute value altered. |
|
public |
withTemporalAdjuster(adjuster: TemporalAdjuster): LocalDateTime Returns an adjusted copy of this date-time. |
|
public |
withYear(year: number): LocalDateTime Returns a copy of this LocalDateTime with the year altered. |
|
public |
Gets the year field. |
Inherited Summary
From class TemporalAccessor | ||
public |
get(field: TemporalField): number Gets the value of the specified field as an {@code int}. |
|
public |
query(query: TemporalQuery): * Queries this date-time. |
|
public |
range(field: TemporalField): ValueRange Gets the range of valid values for the specified field. |
From class ChronoLocalDateTime | ||
public |
adjustInto(temporal: *): * |
|
public |
chronology(): * Gets the chronology of this date-time. |
|
public |
query(query: TemporalQuery): * |
|
public |
toEpochSecond(offset: ZoneOffset): number Converts this date-time to the number of seconds from the epoch of 1970-01-01T00:00:00Z. |
|
public |
toInstant(offset: ZoneOffset): Instant Converts this date-time to an {@code Instant}. |
Static Public Methods
public static from(temporal: TemporalAccessor): LocalDateTime source
Obtains an instance of LocalDateTime from a temporal object.
A TemporalAccessor represents some form of date and time information. This factory converts the arbitrary temporal object to an instance of LocalDateTime.
The conversion extracts and combines LocalDate and LocalTime.
This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, {@code LocalDateTime::from}.
Params:
Name | Type | Attribute | Description |
temporal | TemporalAccessor |
|
the temporal object to convert, not null |
Throw:
if unable to convert to a LocalDateTime |
public static now(clock: Clock): LocalDateTime source
Obtains the current date-time from the specified clock.
This will query the specified clock to obtain the current date-time. Using this method allows the use of an alternate clock for testing. The alternate clock may be introduced using {@link Clock dependency injection}.
Params:
Name | Type | Attribute | Description |
clock | Clock | the clock to use, defaults to Clock.systemDefaultZone() |
public static of(): LocalDateTime source
function overloading for LocalDateTime.of
if called with 2 arguments and first argument is an instance of LocalDate and second is an instance of LocalTime, then LocalDateTime.ofDateAndTime is executed.
Otherwise LocalDateTime.ofNumbers is executed.
public static ofDateAndTime(date: LocalDate, time: LocalTime): LocalDateTime source
Obtains an instance of LocalDateTime from a date and time.
public static ofEpochSecond(epochSecond: number, nanoOfSecond: number, offset: ZoneOffset): LocalDateTime source
Obtains an instance of LocalDateTime using seconds from the epoch of 1970-01-01T00:00:00Z.
This allows the ChronoField.INSTANT_SECONDS epoch-second field to be converted to a local date-time. This is primarily intended for low-level conversions rather than general application usage.
Params:
Name | Type | Attribute | Description |
epochSecond | number | the number of seconds from the epoch of 1970-01-01T00:00:00Z |
|
nanoOfSecond | number | the nanosecond within the second, from 0 to 999,999,999 |
|
offset | ZoneOffset | the zone offset, not null |
Throw:
if the result exceeds the supported range |
public static ofInstant(instant: Instant, zone: ZoneId): LocalDateTime source
Obtains an instance of LocalDateTime from an Instant and zone ID.
This creates a local date-time based on the specified instant. First, the offset from UTC/Greenwich is obtained using the zone ID and instant, which is simple as there is only one valid offset for each instant. Then, the instant and offset are used to calculate the local date-time.
Throw:
if the result exceeds the supported range |
public static ofNumbers(year: number, month: number, dayOfMonth: number, hour: number, minute: number, second: number, nanoOfSecond: number): LocalDateTime source
Obtains an instance of LocalDateTime from year, month, day, hour, minute, second and nanosecond.
The day must be valid for the year and month, otherwise an exception will be thrown.
Params:
Name | Type | Attribute | Description |
year | number |
|
the year to represent, from MIN_YEAR to MAX_YEAR |
month | number |
|
the month-of-year to represent, from 1 to 12 or from a Month |
dayOfMonth | number |
|
the day-of-month to represent, from 1 to 31 |
hour | number |
|
the hour-of-day to represent, from 0 to 23 |
minute | number |
|
the minute-of-hour to represent, from 0 to 59 |
second | number |
|
the second-of-minute to represent, from 0 to 59 |
nanoOfSecond | number |
|
the nano-of-second to represent, from 0 to 999,999,999 |
Throw:
if the value of any field is out of range |
|
if the day-of-month is invalid for the month-year |
public static parse(text: string, formatter: DateTimeFormatter): LocalDateTime source
Obtains an instance of LocalDateTime from a text string using a specific formatter.
The text is parsed using the formatter, returning a date-time.
Params:
Name | Type | Attribute | Description |
text | string |
|
the text to parse, not null |
formatter | DateTimeFormatter |
|
the formatter to use, defaults to DateTimeFormatter.ISO_LOCAL_DATE_TIME |
Throw:
if the text cannot be parsed |
Public Constructors
Public Methods
public adjustInto(temporal: TemporalAdjuster): LocalDateTime source
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 {@link Temporal#with(TemporalField, long)} twice, passing ChronoField#EPOCH_DAY and ChronoField#NANO_OF_DAY as the fields.
In most cases, it is clearer to reverse the calling pattern by using {@link 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.
Override:
ChronoLocalDateTime#adjustIntoParams:
Name | Type | Attribute | Description |
temporal | TemporalAdjuster | the target object to be adjusted, not null |
Throw:
if unable to make the adjustment |
|
if numeric overflow occurs |
public atZone(zone: ZoneId): ZonedDateTime source
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 {@link 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 {@link ZonedDateTime#withLaterOffsetAtOverlap()} on the result of this method. To throw an exception when there is a gap or overlap, use {@link ZonedDateTime#ofStrict(LocalDateTime, ZoneOffset, ZoneId)}.
Params:
Name | Type | Attribute | Description |
zone | ZoneId | the time-zone to use, not null |
public compareTo(other: LocalDateTime): number source
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, see ChronoLocalDateTime#compareTo.
Params:
Name | Type | Attribute | Description |
other | LocalDateTime |
|
the other date-time to compare to, not null |
public dayOfMonth(): number source
Gets the day-of-month field.
This method returns the primitive int value for the day-of-month.
public dayOfWeek(): number source
Gets the day-of-week field, which is an enum DayOfWeek.
This method returns the enum DayOfWeek for the day-of-week. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the {@link DayOfWeek#getValue() int value}.
Additional information can be obtained from the DayOfWeek. This includes textual names of the values.
public dayOfYear(): number source
Gets the day-of-year field.
This method returns the primitive int value for the day-of-year.
public equals(other: *): boolean source
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 type LocalDateTime are compared, other types return false.
Params:
Name | Type | Attribute | Description |
other | * | the object to check, null returns false |
public format(formatter: DateTimeFormatter): String source
Outputs this date-time as a String using the formatter.
This date-time will be passed to the formatter {@link DateTimeFormatter#format(TemporalAccessor) print method}.
Params:
Name | Type | Attribute | Description |
formatter | DateTimeFormatter |
|
the formatter to use, not null |
Throw:
if an error occurs during printing |
public get(field: TemporalField): number source
Gets the value of the specified field from this date-time as an int.
This queries this date-time for the value for the specified field. The returned value will always be within the valid range of values for the field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here. The {@link #isSupported(TemporalField) supported fields} will return valid values based on this date-time, except NANO_OF_DAY, MICRO_OF_DAY, EPOCH_DAY and EPOCH_MONTH which are too large to fit in an int and throw a DateTimeException. All other ChronoField instances will throw a DateTimeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)} passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.
Override:
TemporalAccessor#getParams:
Name | Type | Attribute | Description |
field | TemporalField |
|
the field to get, not null |
Throw:
if a value for the field cannot be obtained |
|
if numeric overflow occurs |
public getLong(field: TemporalField): number source
Gets the value of the specified field from this date-time as a long.
This queries this date-time for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here. The {@link #isSupported(TemporalField) supported fields} will return valid values based on this date-time. All other ChronoField instances will throw a DateTimeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking {@code TemporalField.getFrom(TemporalAccessor)} passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.
Params:
Name | Type | Attribute | Description |
field | TemporalField |
|
the field to get, not null |
Throw:
if a value for the field cannot be obtained |
|
if numeric overflow occurs |
public isAfter(other: LocalDateTime): boolean source
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 {@link #compareTo(ChronoLocalDateTime)}, but is the same approach as #DATE_TIME_COMPARATOR.
Params:
Name | Type | Attribute | Description |
other | LocalDateTime | the other date-time to compare to, not null |
public isBefore(other: LocalDateTime): boolean source
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 {@link #compareTo(ChronoLocalDateTime)}, but is the same approach as #DATE_TIME_COMPARATOR.
Params:
Name | Type | Attribute | Description |
other | LocalDateTime | the other date-time to compare to, not null |
public isEqual(other: *): boolean source
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 {@link #compareTo(ChronoLocalDateTime)}, but is the same approach as #DATE_TIME_COMPARATOR.
Params:
Name | Type | Attribute | Description |
other | * | the other date-time to compare to, not null |
public isSupported(fieldOrUnit: TemporalField | TemporalUnit): boolean source
Checks if the specified field is supported.
This checks if this date-time can be queried for the specified field. If false, then calling the LocalDateTime.range range and LocalDateTime.get get methods will throw an exception.
If the field is a ChronoField then the query is implemented here. The supported fields are:
If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.isSupportedBy passing this as the argument. Whether the field is supported is determined by the field.
Params:
Name | Type | Attribute | Description |
fieldOrUnit | TemporalField | TemporalUnit | the field to check, null returns false |
public minus(amount: TemporalAmount | number, unit: TemporalUnit): LocalDateTime source
function overloading for LocalDateTime.minus
if called with 1 argument LocalDateTime.minusTemporalAmount is applied, otherwise LocalDateTime.minus2
Params:
Name | Type | Attribute | Description |
amount | TemporalAmount | number |
|
|
unit | TemporalUnit |
public minus2(amountToSubtract: number, unit: TemporalUnit): LocalDateTime source
Returns a copy of this date-time with the specified period subtracted.
This method returns a new date-time based on this date-time with the specified period subtracted. This can be used to subtract any period that is defined by a unit, for example to subtract years, months or days. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
amountToSubtract | number | the amount of the unit to subtract from the result, may be negative |
|
unit | TemporalUnit | the unit of the period to subtract, not null |
Return:
LocalDateTime | a LocalDateTime based on this date-time with the specified period subtracted, not null |
Throw:
if the unit cannot be added to this type |
public minusDays(days: number): LocalDateTime source
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.
Params:
Name | Type | Attribute | Description |
days | number | the days to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public minusHours(hours: number): LocalDateTime source
Returns a copy of this LocalDateTime with the specified period in hours subtracted.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
hours | number | the hours to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public minusMinutes(minutes: number): LocalDateTime source
Returns a copy of this LocalDateTime with the specified period in minutes subtracted.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
minutes | number | the minutes to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public minusMonths(months: number): LocalDateTime source
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:
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.
Params:
Name | Type | Attribute | Description |
months | number | the months to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public minusNanos(nanos: Number): LocalDateTime source
Returns a copy of this LocalDateTime with the specified period in nanoseconds subtracted.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
nanos | Number | the nanos to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public minusSeconds(seconds: number): LocalDateTime source
Returns a copy of this LocalDateTime with the specified period in seconds subtracted.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
seconds | number | the seconds to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public minusTemporalAmount(amount: TemporalAmount): LocalDateTime source
Returns a copy of this date-time with the specified period subtracted.
This method returns a new date-time based on this time with the specified period subtracted. The amount is typically Period but may be any other type implementing the TemporalAmount interface. The calculation is delegated to the specified adjuster, which typically calls back to {@link #minus(long, TemporalUnit)}.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
amount | TemporalAmount | the amount to subtract, not null |
Throw:
if the subtraction cannot be made |
|
if numeric overflow occurs |
public minusWeeks(weeks: number): LocalDateTime source
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.
Params:
Name | Type | Attribute | Description |
weeks | number | the weeks to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public minusYears(years: number): LocalDateTime source
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:
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.
Params:
Name | Type | Attribute | Description |
years | number | the years to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public month(): Month source
Gets the month-of-year field using the Month enum.
This method returns the enum Month for the month. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the {@link Month#getValue() int value}.
See:
public monthValue(): number source
Gets the month-of-year field from 1 to 12.
This method returns the month as an int from 1 to 12. Application code is frequently clearer if the enum Month is used by calling {@link #getMonth()}.
See:
public plus(amount: TemporalAmount | number, unit: TemporalUnit): LocalDateTime source
function overloading for LocalDateTime.plus
if called with 1 argument LocalDateTime.plusTemporalAmount is applied, otherwise LocalDateTime.plus2
Params:
Name | Type | Attribute | Description |
amount | TemporalAmount | number |
|
|
unit | TemporalUnit |
public plus2(amountToAdd: number, unit: TemporalUnit): LocalDateTime source
Returns a copy of this date-time with the specified period added.
This method returns a new date-time based on this date-time with the specified period added. This can be used to add any period that is defined by a unit, for example to add years, months or days. The unit is responsible for the details of the calculation, including the resolution of any edge cases in the calculation.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
amountToAdd | number | the amount of the unit to add to the result, may be negative |
|
unit | TemporalUnit |
|
the unit of the period to add, not null |
Return:
LocalDateTime | a LocalDateTime based on this date-time with the specified period added, not null |
Throw:
if the unit cannot be added to this type |
public plusDays(days: number): LocalDateTime source
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.
Params:
Name | Type | Attribute | Description |
days | number | the days to add, may be negative |
Throw:
if the result exceeds the supported date range |
public plusHours(hours: number): LocalDateTime source
Returns a copy of this LocalDateTime with the specified period in hours added.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
hours | number | the hours to add, may be negative |
Throw:
if the result exceeds the supported date range |
public plusMinutes(minutes: number): LocalDateTime source
Returns a copy of this LocalDateTime with the specified period in minutes added.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
minutes | number | the minutes to add, may be negative |
Throw:
if the result exceeds the supported date range |
public plusMonths(months: number): LocalDateTime source
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:
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.
Params:
Name | Type | Attribute | Description |
months | number | the months to add, may be negative |
Throw:
if the result exceeds the supported date range |
public plusNanos(nanos: number): LocalDateTime source
Returns a copy of this LocalDateTime with the specified period in nanoseconds added.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
nanos | number | the nanos to add, may be negative |
Throw:
if the result exceeds the supported date range |
public plusSeconds(seconds: number): LocalDateTime source
Returns a copy of this LocalDateTime with the specified period in seconds added.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
seconds | number | the seconds to add, may be negative |
Throw:
if the result exceeds the supported date range |
public plusTemporalAmount(amount: TemporalAmount): LocalDateTime source
Returns a copy of this date-time with the specified period added.
This method returns a new date-time based on this time with the specified period added. The amount is typically Period but may be any other type implementing the TemporalAmount interface. The calculation is delegated to the specified adjuster, which typically calls back to {@link #plus(long, TemporalUnit)}.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
amount | TemporalAmount | the amount to add, not null |
Throw:
if the addition cannot be made |
|
if numeric overflow occurs |
public plusWeeks(weeks: number): LocalDateTime source
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.
Params:
Name | Type | Attribute | Description |
weeks | number | the weeks to add, may be negative |
Throw:
if the result exceeds the supported date range |
public plusYears(years: number): LocalDateTime source
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:
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.
Params:
Name | Type | Attribute | Description |
years | number | the years to add, may be negative |
Throw:
if the result exceeds the supported date range |
public query(query: TemporalQuery): * source
Queries this date-time using the specified query.
This queries this date-time using the specified query strategy object. The TemporalQuery object defines the logic to be used to obtain the result. Read the documentation of the query to understand what the result of this method will be.
The result of this method is obtained by invoking the {@link TemporalQuery#queryFrom(TemporalAccessor)} method on the specified query passing this as the argument.
Override:
ChronoLocalDateTime#queryParams:
Name | Type | Attribute | Description |
query | TemporalQuery | the query to invoke, not null |
Return:
* | the query result, null may be returned (defined by the query) |
Throw:
if unable to query (defined by the query) |
|
if numeric overflow occurs (defined by the query) |
public range(field: TemporalField): ValueRange source
Gets the range of valid values for the specified field.
The range object expresses the minimum and maximum valid values for a field. This date-time is used to enhance the accuracy of the returned range. If it is not possible to return the range, because the field is not supported or for some other reason, an exception is thrown.
If the field is a ChronoField then the query is implemented here. The {@link #isSupported(TemporalField) supported fields} will return appropriate range instances. All other ChronoField instances will throw a DateTimeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking {@code TemporalField.rangeRefinedBy(TemporalAccessor)} passing this as the argument. Whether the range can be obtained is determined by the field.
Override:
TemporalAccessor#rangeParams:
Name | Type | Attribute | Description |
field | TemporalField |
|
the field to query the range for, not null |
Throw:
if the range for the field cannot be obtained |
public toLocalDate(): LocalDate source
Gets the LocalDate part of this date-time.
This returns a LocalDate with the same year, month and day as this date-time.
public toLocalTime(): LocalTime source
Gets the LocalTime part of this date-time.
This returns a LocalTime with the same hour, minute, second and nanosecond as this date-time.
public toString(): string source
Outputs this date-time as a String, such as {@code 2007-12-03T10:15:30}.
The output will be one of the following ISO-8601 formats:
- {@code yyyy-MM-dd'T'HH:mm}
- {@code yyyy-MM-dd'T'HH:mm:ss}
- {@code yyyy-MM-dd'T'HH:mm:ss.SSS}
- {@code yyyy-MM-dd'T'HH:mm:ss.SSSSSS}
- {@code 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.
public truncatedTo(unit: TemporalUnit): LocalDateTime source
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 {@link ChronoUnit#MINUTES minutes} unit will set the second-of-minute and nano-of-second field to zero.
The unit must have a {@linkplain TemporalUnit#getDuration() duration} that divides into the length of a standard day without remainder. This includes all supplied time units on ChronoUnit and {@link ChronoUnit#DAYS DAYS}. Other units throw an exception.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
unit | TemporalUnit | the unit to truncate to, not null |
Throw:
if unable to truncate |
public until(endExclusive: Temporal, unit: TemporalUnit): number source
Calculates the period between this date-time and another date-time in terms of the specified unit.
This calculates the period between two date-times in terms of a single unit. The start and end points are this and the specified date-time. The result will be negative if the end is before the start. The Temporal passed to this method must be a LocalDateTime. For example, the period in days between two date-times can be calculated using {@code startDateTime.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 a long representing the amount of the specified unit. By contrast, the result of between is an object that can be used directly in addition/subtraction:
long period = start.until(end, MONTHS); // this method dateTime.plus(MONTHS.between(start, end)); // use in plus/minus
The calculation is implemented in this method for ChronoUnit. The units NANOS, MICROS, MILLIS, SECONDS, MINUTES, HOURS and HALF_DAYS, DAYS, WEEKS, MONTHS, YEARS, DECADES, CENTURIES, MILLENNIA and ERAS are supported. Other ChronoUnit values will throw an exception.
If the unit is not a ChronoUnit, then the result of this method is obtained by invoking {@code TemporalUnit.between(Temporal, Temporal)} passing this as the first argument and the input temporal as the second argument.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
endExclusive | Temporal | the end date-time, which is converted to a LocalDateTime, not null |
|
unit | TemporalUnit | the unit to measure the period in, not null |
Throw:
if the period cannot be calculated |
|
if numeric overflow occurs |
public with(adjusterOrField: TemporalAdjuster | TemporalField, newValue: number): LocalDateTime source
function overloading for LocalDateTime.with
if called with 1 argument, LocalDateTime.withTemporalAdjuster is applied, otherwise LocalDateTime.with2.
Params:
Name | Type | Attribute | Description |
adjusterOrField | TemporalAdjuster | TemporalField |
|
|
newValue | number | only require if first argument is a TemporalField |
public with2(field: TemporalField, newValue: number): LocalDateTime source
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 {@link #isSupported(TemporalField) supported fields} will behave as per the matching method on {@link LocalDate#with(TemporalField, long) LocalDate} or {@link LocalTime#with(TemporalField, long) LocalTime}. All other ChronoField instances will throw a DateTimeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking {@code TemporalField.adjustInto(Temporal, long)} passing this as the argument. In this case, the field determines whether and how to adjust the instant.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
field | TemporalField | the field to set in the result, not null |
|
newValue | number | the new value of the field in the result |
Throw:
if the field cannot be set |
|
if numeric overflow occurs |
public withDayOfMonth(dayOfMonth: number): LocalDateTime source
Returns a copy of this LocalDateTime with the day-of-month altered. If the resulting LocalDateTime 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.
Params:
Name | Type | Attribute | Description |
dayOfMonth | number | the day-of-month to set in the result, from 1 to 28-31 |
Throw:
if the day-of-month value is invalid |
|
if the day-of-month is invalid for the month-year |
public withDayOfYear(dayOfYear: number): LocalDateTime source
Returns a copy of this LocalDateTime with the day-of-year altered. If the resulting LocalDateTime is invalid, an exception is thrown.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
dayOfYear | number | the day-of-year to set in the result, from 1 to 365-366 |
Throw:
if the day-of-year value is invalid |
|
if the day-of-year is invalid for the year |
public withHour(hour: number): LocalDateTime source
Returns a copy of this LocalDateTime with the hour-of-day value altered.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
hour | number | the hour-of-day to set in the result, from 0 to 23 |
Throw:
if the hour value is invalid |
public withMinute(minute: number): LocalDateTime source
Returns a copy of this LocalDateTime with the minute-of-hour value altered.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
minute | number | the minute-of-hour to set in the result, from 0 to 59 |
Throw:
if the minute value is invalid |
public withMonth(month: number | Month): LocalDateTime source
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.
Throw:
if the month-of-year value is invalid |
public withNano(nanoOfSecond: number): LocalDateTime source
Returns a copy of this LocalDateTime with the nano-of-second value altered.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
nanoOfSecond | number | the nano-of-second to set in the result, from 0 to 999,999,999 |
Return:
LocalDateTime | a LocalDateTime based on this date-time with the requested nanosecond, not null |
Throw:
if the nano value is invalid |
public withSecond(second: number): LocalDateTime source
Returns a copy of this LocalDateTime with the second-of-minute value altered.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
second | number | the second-of-minute to set in the result, from 0 to 59 |
Throw:
if the second value is invalid |
public withTemporalAdjuster(adjuster: TemporalAdjuster): LocalDateTime source
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 the TemporalAdjuster interface, such as Month and {@link MonthDay MonthDay}. The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.
For example this code returns a date on the last day of July:
import static org.threeten.bp.Month.; import static org.threeten.bp.temporal.Adjusters.;
result = localDateTime.with(JULY).with(lastDayOfMonth());
The classes LocalDate and LocalTime implement TemporalAdjuster, thus this method can be used to change the date, time or offset:
result = localDateTime.with(date); result = localDateTime.with(time);
The result of this method is obtained by invoking the {@link TemporalAdjuster#adjustInto(Temporal)} method on the specified adjuster passing this as the argument.
This instance is immutable and unaffected by this method call.
Params:
Name | Type | Attribute | Description |
adjuster | TemporalAdjuster | the adjuster to use, not null |
Throw:
if the adjustment cannot be made |
|
if numeric overflow occurs |
public withYear(year: number): LocalDateTime source
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.
Params:
Name | Type | Attribute | Description |
year | number | the year to set in the result, from MIN_YEAR to MAX_YEAR |
Throw:
if the year value is invalid |