LocalDate
Extends:
A date without a time-zone in the ISO-8601 calendar system, such as 2007-12-03.
LocalDate is an immutable date-time object that represents a date, often viewed as year-month-day. Other date fields, such as day-of-year, day-of-week and week-of-year, can also be accessed. For example, the value "2nd October 2007" can be stored in a LocalDate.
This class does not store or represent a time or time-zone. Instead, it is a description of the date, as used for birthdays. 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 LocalDate
LocalDate.MIN = LocalDate.of(Year.MIN_VALUE, 1, 1);
The minimum supported LocalDate This could be used by an application as a "far past" date.
LocalDate.MAX = LocalDate.of(Year.MAX_VALUE, 12, 31);
The maximum supported LocalDate This could be used by an application as a "far future" date.
LocalDate.EPOCH_0
The date at epoch day 0, that is 1970-01-01.
Static Method Summary
Static Public Methods | ||
public static |
from(temporal: TemporalAccessor): LocalDate Obtains an instance of LocalDate from a temporal object. |
|
public static |
Obtains the current date from the system clock in the default time-zone or if specified, the current date from the specified clock. |
|
public static |
Obtains an instance of LocalDate from a year, month and day. |
|
public static |
ofEpochDay(epochDay: number): LocalDate Obtains an instance of LocalDate from the epoch day count. |
|
public static |
obtain a LocalDate from an Instant in the specified time-zone or, if null in the system default time-zone |
|
public static |
Obtains an instance of LocalDate from a year and day-of-year. |
|
public static |
parse(text: string, formatter: DateTimeFormatter): LocalDate Obtains an instance of LocalDate from a text string using a specific formatter. |
Method Summary
Public Methods | ||
public |
adjustInto(temporal: TemporalAdjuster): * Adjusts the specified temporal object to have the same date as this object. |
|
public |
Combines this date with the time of midnight to create a LocalDateTime at the start of this date. |
|
public |
function overloading for LocalDate.atTime |
|
public |
atTime1(time: LocalTime): LocalDateTime Combines this date with a time to create a LocalDateTime. |
|
public |
Combines this date with a time to create a LocalDateTime. |
|
public |
chronology(): Chronology Gets the chronology of this date, which is the ISO calendar system. |
|
public |
Compares this date to another date. |
|
public |
dayOfMonth(): number |
|
public |
Gets the day-of-week field, which is an enum DayOfWeek. |
|
public |
Gets the day-of-year field. |
|
public |
Checks if this date is equal to another date. |
|
public |
get(field: TemporalField): * Gets the value of the specified field from this date as an {@code int}. |
|
public |
getLong(field: TemporalField): * see {LocalDate.get}, get and getLong are identical in javascript, because we are only limited by MathUtil.MIN_SAFE_INTEGER/ MathUtil.MAX_SAFE_INTEGER |
|
public |
A hash code for this date. |
|
public |
Checks if this date is after the specified date. |
|
public |
Checks if this date is before the specified date. |
|
public |
Checks if this date is equal to the specified date. |
|
public |
Checks if the year is a leap year, according to the ISO proleptic calendar system rules. |
|
public |
isSupported(field: TemporalField): boolean Checks if the specified field is supported. |
|
public |
Returns the length of the month represented by this date. |
|
public |
Returns the length of the year represented by this date. |
|
public |
minus(p1: TemporalAmount | number, p2: TemporalUnit): LocalDate function overloading for minus |
|
public |
minus1(amount: TemporalAmount): LocalDate Returns a copy of this date with the specified period subtracted. |
|
public |
minus2(amountToSubtract: number, unit: TemporalUnit): LocalDate Returns a copy of this date with the specified period subtracted. |
|
public |
minusDays(daysToSubtract: *): * |
|
public |
minusMonths(monthsToSubtract: number): LocalDate Returns a copy of this LocalDate with the specified period in months subtracted. |
|
public |
minusWeeks(weeksToSubtract: number): LocalDate Returns a copy of this LocalDate with the specified period in weeks subtracted. |
|
public |
minusYears(yearsToSubtract: number): LocalDate Returns a copy of this LocalDate with the specified period in years subtracted. |
|
public |
|
|
public |
monthValue(): number |
|
public |
plus(p1: TemporalAmount | number, p2: TemporalUnit): LocalDate function overloading for plus |
|
public |
plus1(amount: TemporalAmount): LocalDate Returns a copy of this date with the specified period added. |
|
public |
plus2(amountToAdd: number, unit: TemporalUnit): LocalDate Returns a copy of this date with the specified period added. |
|
public |
Returns a copy of this LocalDate with the specified number of days added. |
|
public |
plusMonths(monthsToAdd: number): LocalDate Returns a copy of this LocalDate with the specified period in months added. |
|
public |
Returns a copy of this LocalDate with the specified period in weeks added. |
|
public |
Returns a copy of this LocalDate with the specified period in years added. |
|
public |
query(query: TemporalQuery): * Queries this date using the specified query. |
|
public |
range(field: TemporalField): ValueRange Gets the range of valid values for the specified field. |
|
public |
toEpochDay(): number Converts this date to the Epoch Day. |
|
public |
Outputs this date as a String, such as 2007-12-03. |
|
public |
until(p1: TemporalAccessor, p2: TemporalUnit): number | Period function overloading for LocalDate.until |
|
public |
until1(endDate: TemporalAccessor): Period Calculates the period between this date and another date as a Period. |
|
public |
until2(endExclusive: TemporalAccessor, unit: TemporalUnit): number Calculates the period between this date and another date in terms of the specified unit. |
|
public |
with(fieldOrAdjuster: TemporalAdjuster | TemporalField, newValue: number): LocalDate function overloading for the LocalDate.with method. |
|
public |
withDayOfMonth(dayOfMonth: number): LocalDate Returns a copy of this LocalDate with the day-of-month altered. |
|
public |
withDayOfYear(dayOfYear: *): LocalDate Returns a copy of this date with the day-of-year altered. |
|
public |
withFieldAndValue(field: TemporalField, newValue: number): LocalDate Returns a copy of this date with the specified field set to a new value. |
|
public |
Returns a copy of this date with the month-of-year altered. |
|
public |
withTemporalAdjuster(adjuster: TemporalAdjuster): LocalDate Returns an adjusted copy of this date. |
|
public |
Returns a copy of this date with the year altered. |
|
public |
|
Protected Methods | ||
protected |
|
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 ChronoLocalDate | ||
public |
adjustInto(temporal: *): * |
|
public |
isSupported(fieldOrUnit: *): * |
|
public |
query(query: *): * |
Static Public Methods
public static from(temporal: TemporalAccessor): LocalDate source
Obtains an instance of LocalDate 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 LocalDate.
The conversion uses the {@link TemporalQueries.localDate()} query, which relies on extracting the ChronoField.EPOCH_DAY field.
This method matches the signature of the functional interface TemporalQuery allowing it to be used as a query via method reference, LocalDate::from.
Params:
Name | Type | Attribute | Description |
temporal | TemporalAccessor |
|
the temporal object to convert, not null |
Throw:
if unable to convert to a LocalDate |
public static now(clock: Clock): LocalDate source
Obtains the current date from the system clock in the default time-zone or if specified, the current date from the specified clock.
This will query the specified clock to obtain the current date - today. Using this method allows the use of an alternate clock for testing.
Params:
Name | Type | Attribute | Description |
clock | Clock |
|
the clock to use, if null, the system clock and default time-zone is used. |
public static of(year: number, month: Month | Number, dayOfMonth: number): LocalDate source
Obtains an instance of LocalDate from a year, month and day.
This returns a LocalDate with the specified year, month and day-of-month. 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 Year.MIN_VALUE to Year.MAX_VALUE |
month | Month | Number |
|
the month-of-year to represent, from 1 (January) to 12 (December) |
dayOfMonth | number |
|
the day-of-month to represent, from 1 to 31 |
Throw:
if the value of any field is out of range, or if the day-of-month is invalid for the month-year |
public static ofEpochDay(epochDay: number): LocalDate source
Obtains an instance of LocalDate from the epoch day count.
This returns a LocalDate with the specified epoch-day. The ChronoField.EPOCH_DAY is a simple incrementing count of days where day 0 is 1970-01-01. Negative numbers represent earlier days.
Params:
Name | Type | Attribute | Description |
epochDay | number |
|
the Epoch Day to convert, based on the epoch 1970-01-01 |
Throw:
AssertionError |
if the epoch days exceeds the supported date range |
public static ofInstant(instant: Instant, zone: ZoneId): LocalDate source
obtain a LocalDate from an Instant in the specified time-zone or, if null in the system default time-zone
public static ofYearDay(year: number, dayOfYear: number): LocalDate source
Obtains an instance of LocalDate from a year and day-of-year.
This returns a LocalDate with the specified year and day-of-year. The day-of-year must be valid for the year, otherwise an exception will be thrown.
Throw:
if the value of any field is out of range, or if the day-of-year is invalid for the year |
public static parse(text: string, formatter: DateTimeFormatter): LocalDate source
Obtains an instance of LocalDate from a text string using a specific formatter.
The text is parsed using the formatter, returning a date.
Params:
Name | Type | Attribute | Description |
text | string |
|
the text to parse, not null |
formatter | DateTimeFormatter |
|
the formatter to use, default is DateTimeFormatter.ISO_LOCAL_DATE |
Throw:
if the text cannot be parsed |
Public Methods
public adjustInto(temporal: TemporalAdjuster): * source
Adjusts the specified temporal object to have the same date as this object.
This returns a temporal object of the same observable type as the input with the date changed to be the same as this.
The adjustment is equivalent to using {@link Temporal#with(TemporalField, long)} passing ChronoField.EPOCH_DAY as the field.
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 = thisLocalDate.adjustInto(temporal); temporal = temporal.with(thisLocalDate);
Override:
ChronoLocalDate#adjustIntoParams:
Name | Type | Attribute | Description |
temporal | TemporalAdjuster |
|
the target object to be adjusted, not null |
Return:
* | the adjusted object, not null |
Throw:
if unable to make the adjustment |
|
if numeric overflow occurs |
public atStartOfDay(): LocalDateTime source
Combines this date with the time of midnight to create a LocalDateTime at the start of this date.
This returns a LocalDateTime formed from this date at the time of midnight, 00:00, at the start of this date.
public atTime(): LocalDateTime source
function overloading for LocalDate.atTime
if called with 1 argument LocalDate.atTime1 is called otherwise LocalDate.atTime4
public atTime1(time: LocalTime): LocalDateTime source
Combines this date with a time to create a LocalDateTime.
This returns a LocalDateTime formed from this date at the specified time. All possible combinations of date and time are valid.
Params:
Name | Type | Attribute | Description |
time | LocalTime | the time to combine with, not null |
public atTime4(hour: number, minute: number, second: number, nanoOfSecond: number): LocalDateTime source
Combines this date with a time to create a LocalDateTime.
This returns a LocalDateTime formed from this date at the specified hour, minute, second and nanosecond. The individual time fields must be within their valid range. All possible combinations of date and time are valid.
Params:
Name | Type | Attribute | Description |
hour | number |
|
the hour-of-day to use, from 0 to 23 |
minute | number |
|
the minute-of-hour to use, 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 |
public chronology(): Chronology source
Gets the chronology of this date, which is the ISO calendar system.
The Chronology represents the calendar system in use. 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 todays's rules for leap years are applied for all time.
Return:
Chronology | the ISO chronology, not null |
public compareTo(other: LocalDate): number source
Compares this date to another date.
The comparison is primarily based on the date, from earliest to latest. It is "consistent with equals", as defined by Comparable.
If all the dates being compared are instances of LocalDate, then the comparison will be entirely based on the date. If some dates being compared are in different chronologies, then the chronology is also considered, see ChronoLocalDate.compareTo.
Params:
Name | Type | Attribute | Description |
other | LocalDate |
|
the other date to compare to, not null |
public dayOfWeek(): DayOfWeek source
Gets the day-of-week field, which is an enum DayOfWeek.
This method returns the enum DayOfWeek for the day-of-week. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the DayOfWeek.value 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(otherDate: *): boolean source
Checks if this date is equal to another date.
Compares this LocalDate with another ensuring that the date is the same.
Only objects of type LocalDate are compared, other types return false.
Params:
Name | Type | Attribute | Description |
otherDate | * | the object to check, null returns false |
public get(field: TemporalField): * source
Gets the value of the specified field from this date as an {@code int}.
This queries this date 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 LocalDate.isSupported supported fields will return valid values based on this date, except ChronoField.EPOCH_DAY and ChronoField.EPOCH_MONTH which are too large to fit in an {@code int} and throw a DateTimeException. All other ChronoField instances will throw a DateTimeException.
If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.
Override:
TemporalAccessor#getParams:
Name | Type | Attribute | Description |
field | TemporalField |
|
the field to get, not null |
Return:
* | the value for the field |
Throw:
if a value for the field cannot be obtained |
|
if numeric overflow occurs |
public getLong(field: TemporalField): * source
see {LocalDate.get}, get and getLong are identical in javascript, because we are only limited by MathUtil.MIN_SAFE_INTEGER/ MathUtil.MAX_SAFE_INTEGER
Params:
Name | Type | Attribute | Description |
field | TemporalField |
|
Return:
* |
public isAfter(other: LocalDate): boolean source
Checks if this date is after the specified date.
This checks to see if this date represents a point on the local time-line after the other date.
LocalDate a = LocalDate.of(2012, 6, 30); LocalDate b = LocalDate.of(2012, 7, 1); a.isAfter(b) == false a.isAfter(a) == false b.isAfter(a) == true
This method only considers the position of the two dates 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(ChronoLocalDate)}, but is the same approach as #DATE_COMPARATOR.
Params:
Name | Type | Attribute | Description |
other | LocalDate |
|
the other date to compare to, not null |
public isBefore(other: LocalDate): boolean source
Checks if this date is before the specified date.
This checks to see if this date represents a point on the local time-line before the other date.
LocalDate a = LocalDate.of(2012, 6, 30); LocalDate b = LocalDate.of(2012, 7, 1); a.isBefore(b) == true a.isBefore(a) == false b.isBefore(a) == false
This method only considers the position of the two dates 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(ChronoLocalDate)}, but is the same approach as #DATE_COMPARATOR.
Params:
Name | Type | Attribute | Description |
other | LocalDate |
|
the other date to compare to, not null |
public isEqual(other: LocalDate): boolean source
Checks if this date is equal to the specified date.
This checks to see if this date represents the same point on the local time-line as the other date.
LocalDate a = LocalDate.of(2012, 6, 30); LocalDate b = LocalDate.of(2012, 7, 1); a.isEqual(b) == false a.isEqual(a) == true b.isEqual(a) == false
This method only considers the position of the two dates 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(ChronoLocalDate)} but is the same approach as #DATE_COMPARATOR.
Params:
Name | Type | Attribute | Description |
other | LocalDate |
|
the other date to compare to, not null |
public isLeapYear(): boolean source
Checks if the year is a leap year, according to the ISO proleptic calendar system rules.
This method applies the current rules for leap years across the whole time-line. In general, a year is a leap year if it is divisible by four without remainder. However, years divisible by 100, are not leap years, with the exception of years divisible by 400 which are.
For example, 1904 is a leap year it is divisible by 4. 1900 was not a leap year as it is divisible by 100, however 2000 was a leap year as it is divisible by 400.
The calculation is proleptic - applying the same rules into the far future and far past. This is historically inaccurate, but is correct for the ISO-8601 standard.
public isSupported(field: TemporalField): boolean source
Checks if the specified field is supported.
This checks if this date can be queried for the specified field. If false, then calling the LocalDate.range range and LocalDate.get get methods will throw an exception.
If the field is a ChronoField then the query is implemented here. The LocalDate.isSupported supported fields will return valid values based on this date-time. 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.
Override:
ChronoLocalDate#isSupportedParams:
Name | Type | Attribute | Description |
field | TemporalField | the field to check, null returns false |
public lengthOfMonth(): number source
Returns the length of the month represented by this date.
This returns the length of the month in days. For example, a date in January would return 31.
public lengthOfYear(): number source
Returns the length of the year represented by this date.
This returns the length of the year in days, either 365 or 366.
public minus(p1: TemporalAmount | number, p2: TemporalUnit): LocalDate source
function overloading for minus
called with 1 (or less) arguments, p1 is expected to be a TemporalAmount and LocalDate.minus1 is called.
Otherwise LocalDate.minus2 is called.
Params:
Name | Type | Attribute | Description |
p1 | TemporalAmount | number |
|
|
p2 | TemporalUnit | required if called with 2 arguments |
public minus1(amount: TemporalAmount): LocalDate source
Returns a copy of this date with the specified period subtracted.
This method returns a new date based on this date 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)}.
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 minus2(amountToSubtract: number, unit: TemporalUnit): LocalDate source
Returns a copy of this date with the specified period subtracted.
This method returns a new date based on this date 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.
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 |
Throw:
if the unit cannot be added to this type |
public minusDays(daysToSubtract: *): * source
Params:
Name | Type | Attribute | Description |
daysToSubtract | * |
Return:
* |
public minusMonths(monthsToSubtract: number): LocalDate source
Returns a copy of this LocalDate 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-02-31. Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead.
Params:
Name | Type | Attribute | Description |
monthsToSubtract | number |
|
the months to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public minusWeeks(weeksToSubtract: number): LocalDate source
Returns a copy of this LocalDate 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.
Params:
Name | Type | Attribute | Description |
weeksToSubtract | number |
|
the weeks to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public minusYears(yearsToSubtract: number): LocalDate source
Returns a copy of this LocalDate 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 2007-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead.
Params:
Name | Type | Attribute | Description |
yearsToSubtract | number |
|
the years to subtract, may be negative |
Throw:
if the result exceeds the supported date range |
public plus(p1: TemporalAmount | number, p2: TemporalUnit): LocalDate source
function overloading for plus
called with 1 (or less) arguments, p1 is expected to be a TemporalAmount and LocalDate.plus1 is called.
Otherwise LocalDate.plus2 is called.
Params:
Name | Type | Attribute | Description |
p1 | TemporalAmount | number |
|
|
p2 | TemporalUnit | required if called with 2 arguments |
public plus1(amount: TemporalAmount): LocalDate source
Returns a copy of this date with the specified period added.
This method returns a new date based on this date 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 LocalDate.plus2.
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 plus2(amountToAdd: number, unit: TemporalUnit): LocalDate source
Returns a copy of this date with the specified period added.
This method returns a new date based on this date 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.
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 |
Throw:
if the unit cannot be added to this type |
public plusDays(daysToAdd: number): LocalDate source
Returns a copy of this LocalDate with the specified number of 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.
Params:
Name | Type | Attribute | Description |
daysToAdd | number | the days to add, may be negative |
Throw:
* |
AssertionError if the result exceeds the supported date range |
public plusMonths(monthsToAdd: number): LocalDate source
Returns a copy of this LocalDate 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.
Params:
Name | Type | Attribute | Description |
monthsToAdd | number | the months to add, may be negative |
Throw:
if the result exceeds the supported date range |
public plusWeeks(weeksToAdd: number): LocalDate source
Returns a copy of this LocalDate 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.
Params:
Name | Type | Attribute | Description |
weeksToAdd | number |
|
the weeks to add, may be negative |
Throw:
if the result exceeds the supported date range |
public plusYears(yearsToAdd: number): LocalDate source
Returns a copy of this LocalDate 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.
Params:
Name | Type | Attribute | Description |
yearsToAdd | 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 using the specified query.
This queries this date 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:
ChronoLocalDate#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 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 LocalDate.isSupported 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 TemporalField.rangeRefinedBy 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 toEpochDay(): number source
Converts this date to the Epoch Day.
The Epoch Day count is a simple incrementing count of days where day 0 is 1970-01-01 (ISO). This definition is the same for all chronologies, enabling conversion.
public toString(): string source
Outputs this date as a String, such as 2007-12-03. The output will be in the ISO-8601 format uuuu-MM-dd.
public until(p1: TemporalAccessor, p2: TemporalUnit): number | Period source
function overloading for LocalDate.until
called with 1 (or less) arguments {LocalDate.until1} is called otherwise LocalDate.until2
Params:
Name | Type | Attribute | Description |
p1 | TemporalAccessor |
|
|
p2 | TemporalUnit | not null if called with 2 arguments |
public until1(endDate: TemporalAccessor): Period source
Calculates the period between this date and another date as a Period.
This calculates the period between two dates in terms of years, months and days. The start and end points are this and the specified date. The result will be negative if the end is before the start.
The calculation is performed using the ISO calendar system. If necessary, the input date will be converted to ISO.
The start date is included, but the end date is not. The period is calculated by removing complete months, then calculating the remaining number of days, adjusting to ensure that both have the same sign. The number of months is then normalized into years and months based on a 12 month year. A month is considered to be complete if the end day-of-month is greater than or equal to the start day-of-month. For example, from 2010-01-15 to 2011-03-18 is "1 year, 2 months and 3 days".
The result of this method can be a negative period if the end is before the start. The negative sign will be the same in each of year, month and day.
There are two equivalent ways of using this method. The first is to invoke this method. The second is to use {@link Period#between(LocalDate, LocalDate)}:
// these two lines are equivalent period = start.until(end); period = Period.between(start, end);The choice should be made based on which makes the code more readable.
Params:
Name | Type | Attribute | Description |
endDate | TemporalAccessor |
|
the end date, exclusive, which may be in any chronology, not null |
public until2(endExclusive: TemporalAccessor, unit: TemporalUnit): number source
Calculates the period between this date and another date in terms of the specified unit.
This calculates the period between two dates in terms of a single unit. The start and end points are this and the specified date. The result will be negative if the end is before the start. The Temporal passed to this method must be a LocalDate. For example, the period in days between two dates can be calculated using {@link startDate.until(endDate, DAYS)}.
The calculation returns a whole number, representing the number of complete units between the two dates. For example, the period in months between 2012-06-15 and 2012-08-14 will only be one month as it is one day 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 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 {@link TemporalUnit.between(Temporal, Temporal)} passing this as the first argument and the input temporal as the second argument.
Params:
Name | Type | Attribute | Description |
endExclusive | TemporalAccessor |
|
the end date, which is converted to a LocalDate, 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(fieldOrAdjuster: TemporalAdjuster | TemporalField, newValue: number): LocalDate source
function overloading for the LocalDate.with method.
calling "with" with one (or less) argument, assumes that the argument is an TemporalAdjuster and LocalDate.withTemporalAdjuster is called.
Otherwise a TemporalField and Number newValue argument is expected and LocalDate.withFieldAndValue is called.
Params:
Name | Type | Attribute | Description |
fieldOrAdjuster | TemporalAdjuster | TemporalField |
|
|
newValue | number | required if first argument is a TemporalField |
public withDayOfMonth(dayOfMonth: number): LocalDate source
Returns a copy of this LocalDate with the day-of-month altered.
If the resulting date is invalid, an exception is thrown.
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, or if the day-of-month is invalid for the month-year |
public withDayOfYear(dayOfYear: *): LocalDate source
Returns a copy of this date with the day-of-year altered. If the resulting date is invalid, an exception is thrown.
Params:
Name | Type | Attribute | Description |
dayOfYear | * | 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 withFieldAndValue(field: TemporalField, newValue: number): LocalDate source
Returns a copy of this date with the specified field set to a new value.
This returns a new LocalDate, 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 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 supported fields behave as follows:
In all cases, if the new value is outside the valid range of values for the field then a DateTimeException will be thrown.
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 {@link TemporalField.adjustInto(Temporal, long)} passing this as the argument. In this case, the field determines whether and how to adjust the instant.
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 withMonth(month: Month | number): LocalDate source
Returns a copy of this date with the month-of-year altered. If the day-of-month is invalid for the year, it will be changed to the last valid day of the month.
Throw:
if the month-of-year value is invalid |
public withTemporalAdjuster(adjuster: TemporalAdjuster): LocalDate source
Returns an adjusted copy of this date.
This returns a new LocalDate, based on this one, with the date adjusted. The adjustment takes place using the specified adjuster strategy object. Read the documentation of the adjuster to understand what adjustment will be made.
A simple adjuster might simply set the one of the fields, such as the year field. A more complex adjuster might set the date to the last day of the month. A selection of common adjustments is provided in TemporalAdjusters. These include finding the "last day of the month" and "next Wednesday". Key date-time classes also implement the TemporalAdjuster interface, such as Month and MonthDay. The adjuster is responsible for handling special cases, such as the varying lengths of month and leap years.
For example this code returns a date on the last day of July:
import static org.threeten.bp.Month.; import static org.threeten.bp.temporal.Adjusters.;
result = localDate.with(JULY).with(lastDayOfMonth());
The result of this method is obtained by invoking the TemporalAdjuster.adjustInto method on the specified adjuster passing this as the argument.
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): LocalDate source
Returns a copy of this date with the year altered. If the day-of-month is invalid for the year, it will be changed to the last valid day of the month.
Params:
Name | Type | Attribute | Description |
year | number |
|
the year to set in the result, from Year.MIN_VALUE to Year.MAX_VALUE |
Throw:
if the year value is invalid |