Home Reference Source
import {LocalDate} from 'js-joda/src/LocalDate.js'
public class | source

LocalDate

Extends:

TemporalAccessorTemporalChronoLocalDate → LocalDate

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

Obtains an instance of LocalDate from a temporal object.

public static

now(clockOrZone: Clock | ZoneId): LocalDate

Obtains the current date from the system clock in the default time-zone or if specified, the current date from the specified clock or if argument is a ZoneId this will query a clock with the specified ZoneId.

public static

of(year: number, month: Month | Number, dayOfMonth: number): LocalDate

Obtains an instance of LocalDate from a year, month and day.

public static

Obtains an instance of LocalDate from the epoch day count.

public static

ofInstant(instant: Instant, zone: ZoneId): LocalDate

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

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

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

Combines this date with a time-zone to create a ZonedDateTime at the start of the day

public

function overloading for LocalDate.atTime

public

Combines this date with a time to create a LocalDateTime.

public

atTime4(hour: number, minute: number, second: number, nanoOfSecond: number): LocalDateTime

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
public

Gets the day-of-week field, which is an enum DayOfWeek.

public

Gets the day-of-year field.

public

equals(otherDate: *): boolean

Checks if this date is equal to another date.

public

Outputs this date as a string using the formatter.

public

get(field: TemporalField): *

Gets the value of the specified field from this date as an 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

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

function overloading for minus

public

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
public

function overloading for plus

public

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

plusDays(daysToAdd: number): LocalDate

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

plusWeeks(weeksToAdd: number): LocalDate

Returns a copy of this LocalDate with the specified period in weeks added.

public

plusYears(yearsToAdd: number): LocalDate

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

Gets the range of valid values for the specified field.

public

Converts this date to the Epoch Day.

public
public

Outputs this date as a String, such as 2007-12-03.

public

function overloading for LocalDate.until

public

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

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

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

Returns an adjusted copy of this date.

public

Returns a copy of this date with the year altered.

public

Inherited Summary

From class TemporalAccessor
public

Gets the value of the specified field as an int.

public

query(query: TemporalQuery): *

Queries this date-time.

public

Gets the range of valid values for the specified field.

From class ChronoLocalDate
public

adjustInto(temporal: *): *

public

Formats this date using the specified formatter.

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 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:

NameTypeAttributeDescription
temporal TemporalAccessor
  • nullable: false

the temporal object to convert, not null

Return:

LocalDate

the local date, not null

Throw:

DateTimeException

if unable to convert to a LocalDate

public static now(clockOrZone: Clock | ZoneId): 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 or if argument is a ZoneId this will query a clock with the specified ZoneId.

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:

NameTypeAttributeDescription
clockOrZone Clock | ZoneId
  • optional
  • default: Clock.systemDefaultZone()

the clock or zone to use, if null, the system clock and default time-zone is used.

Return:

LocalDate

the current date, not null

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:

NameTypeAttributeDescription
year number
  • nullable: false

the year to represent, from Year.MIN_VALUE to Year.MAX_VALUE

month Month | Number
  • nullable: false

the month-of-year to represent, from 1 (January) to 12 (December)

dayOfMonth number
  • nullable: false

the day-of-month to represent, from 1 to 31

Return:

LocalDate

the local date, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
epochDay number
  • optional
  • default: 0

the Epoch Day to convert, based on the epoch 1970-01-01

Return:

LocalDate

the local date, not null

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

Params:

NameTypeAttributeDescription
instant Instant
  • nullable: false
zone ZoneId
  • optional
  • default: ZoneId.systemDefault()

, defaults to ZoneId.systemDefault()

Return:

LocalDate

the current date, not null

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.

Params:

NameTypeAttributeDescription
year number
  • nullable: false

the year to represent, from Year.MIN_VALUE to Year.MAX_VALUE

dayOfYear number
  • nullable: false

the day-of-year to represent, from 1 to 366

Return:

LocalDate

the local date, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
text string
  • nullable: false

the text to parse, not null

formatter DateTimeFormatter
  • optional
  • default: DateTimeFormatter.ISO_LOCAL_DATE

the formatter to use, default is DateTimeFormatter.ISO_LOCAL_DATE

Return:

LocalDate

the parsed local date, not null

Throw:

DateTimeParseException

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 Temporal#with passing ChronoField.EPOCH_DAY as the field.

In most cases, it is clearer to reverse the calling pattern by using Temporal#with:

  // these two lines are equivalent, but the second approach is recommended
  temporal = thisLocalDate.adjustInto(temporal);
  temporal = temporal.with(thisLocalDate);

Override:

ChronoLocalDate#adjustInto

Params:

NameTypeAttributeDescription
temporal TemporalAdjuster
  • nullable: false

the target object to be adjusted, not null

Return:

*

the adjusted object, not null

Throw:

DateTimeException

if unable to make the adjustment

ArithmeticException

if numeric overflow occurs

public atStartOfDay(zone: ZoneId): LocalDateTime | ZonedDateTime 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.

Params:

NameTypeAttributeDescription
zone ZoneId

if zone is not null @see LocalDate.atStartOfDayWithZone

Return:

LocalDateTime | ZonedDateTime

the local date-time of midnight at the start of this date, not null

public atStartOfDayWithZone(zone: ZoneId): ZonedDateTime source

Combines this date with a time-zone to create a ZonedDateTime at the start of the day

This returns a ZonedDateTime formed from this date at the specified zone, with the time set to be the earliest valid time according to the rules in the time-zone.

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 not be midnight.

In most cases, there is only one valid offset for a local date-time. In the case of an overlap, there are two valid offsets, and the earlier one is used, corresponding to the first occurrence of midnight on the date. In the case of a gap, the zoned date-time will represent the instant just after the gap.

If the zone ID is a ZoneOffset, then the result always has a time of midnight.

To convert to a specific time in a given time-zone call atTime followed by LocalDateTime#atZone.

Params:

NameTypeAttributeDescription
zone ZoneId
  • nullable: false

the zone ID to use, not null

Return:

ZonedDateTime

the zoned date-time formed from this date and the earliest valid time for the zone, not null

public atTime(): LocalDateTime source

function overloading for LocalDate.atTime

if called with 1 argument LocalDate.atTime1 is called otherwise LocalDate.atTime4

Return:

LocalDateTime

the local date-time formed from this date and the specified params

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:

NameTypeAttributeDescription
time LocalTime

the time to combine with, not null

Return:

LocalDateTime

the local date-time formed from this date and the specified time, 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:

NameTypeAttributeDescription
hour number
  • nullable: false

the hour-of-day to use, from 0 to 23

minute number
  • nullable: false

the minute-of-hour to use, from 0 to 59

second number
  • optional
  • default: 0

the second-of-minute to represent, from 0 to 59

nanoOfSecond number
  • optional
  • default: 0

the nano-of-second to represent, from 0 to 999,999,999

Return:

LocalDateTime

the local date-time formed from this date and the specified time, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
other LocalDate
  • nullable: false

the other date to compare to, not null

Return:

number

the comparator value, negative if less, positive if greater

public dayOfMonth(): number source

Return:

number

gets the day of month

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.

Return:

DayOfWeek

the day-of-week, not null

public dayOfYear(): number source

Gets the day-of-year field.

This method returns the primitive int value for the day-of-year.

Return:

number

the day-of-year, from 1 to 365, or 366 in a leap 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:

NameTypeAttributeDescription
otherDate *

the object to check, null returns false

Return:

boolean

true if this is equal to the other date

public format(formatter: DateTimeFormatter): String source

Outputs this date as a string using the formatter.

Override:

ChronoLocalDate#format

Params:

NameTypeAttributeDescription
formatter DateTimeFormatter

the formatter to use, not null

Return:

String

the formatted date string, not null

Throw:

*

DateTimeException if an error occurs during printing

public get(field: TemporalField): * source

Gets the value of the specified field from this date as an 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 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#get

Params:

NameTypeAttributeDescription
field TemporalField
  • nullable: false

the field to get, not null

Return:

*

the value for the field

Throw:

DateTimeException

if a value for the field cannot be obtained

ArithmeticException

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:

NameTypeAttributeDescription
field TemporalField
  • nullable: false

Return:

*

public hashCode(): number source

A hash code for this date.

Return:

number

a suitable hash code

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 compareTo, but is the same approach as DATE_COMPARATOR.

Params:

NameTypeAttributeDescription
other LocalDate
  • nullable: false

the other date to compare to, not null

Return:

boolean

true if this date is after the specified date

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 compareTo, but is the same approach as DATE_COMPARATOR.

Params:

NameTypeAttributeDescription
other LocalDate
  • nullable: false

the other date to compare to, not null

Return:

boolean

true if this date is before the specified date

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 compareTo but is the same approach as DATE_COMPARATOR.

Params:

NameTypeAttributeDescription
other LocalDate
  • nullable: false

the other date to compare to, not null

Return:

boolean

true if this date is equal to the specified date

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.

Return:

boolean

true if the year is leap, false otherwise

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:

  • ChronoField.DAY_OF_WEEK
  • ChronoField.ALIGNED_DAY_OF_WEEK_IN_MONTH
  • ChronoField.ALIGNED_DAY_OF_WEEK_IN_YEAR
  • ChronoField.DAY_OF_MONTH
  • ChronoField.DAY_OF_YEAR
  • ChronoField.EPOCH_DAY
  • ChronoField.ALIGNED_WEEK_OF_MONTH
  • ChronoField.ALIGNED_WEEK_OF_YEAR
  • ChronoField.MONTH_OF_YEAR
  • ChronoField.EPOCH_MONTH
  • ChronoField.YEAR_OF_ERA
  • ChronoField.YEAR
  • ChronoField.ERA

All other ChronoField instances will return false.

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#isSupported

Params:

NameTypeAttributeDescription
field TemporalField

the field to check, null returns false

Return:

boolean

true if the field is supported on this date, false if not

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.

Return:

number

the length of the month in days

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.

Return:

number

366 if the year is leap, 365 otherwise

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:

NameTypeAttributeDescription
p1 TemporalAmount | number
  • nullable: false
p2 TemporalUnit

required if called with 2 arguments

Return:

LocalDate

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 minus.

Params:

NameTypeAttributeDescription
amount TemporalAmount
  • nullable: false

the amount to subtract, not null

Return:

LocalDate

a LocalDate based on this date with the subtraction made, not null

Throw:

DateTimeException

if the subtraction cannot be made

ArithmeticException

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:

NameTypeAttributeDescription
amountToSubtract number
  • nullable: false

the amount of the unit to subtract from the result, may be negative

unit TemporalUnit
  • nullable: false

the unit of the period to subtract, not null

Return:

LocalDate

a LocalDate based on this date with the specified period subtracted, not null

Throw:

DateTimeException

if the unit cannot be added to this type

public minusDays(daysToSubtract: *): * source

Params:

NameTypeAttributeDescription
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:

  1. Subtract the input months to the month-of-year field
  2. Check if the resulting date would be invalid
  3. 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-02-31. Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead.

Params:

NameTypeAttributeDescription
monthsToSubtract number
  • nullable: false

the months to subtract, may be negative

Return:

LocalDate

a LocalDate based on this date with the months subtracted, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
weeksToSubtract number
  • nullable: false

the weeks to subtract, may be negative

Return:

LocalDate

a LocalDate based on this date with the weeks subtracted, not null

Throw:

DateTimeException

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:

  1. Subtract the input years to the year field
  2. Check if the resulting date would be invalid
  3. 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 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:

NameTypeAttributeDescription
yearsToSubtract number
  • nullable: false

the years to subtract, may be negative

Return:

LocalDate

a LocalDate based on this date with the years subtracted, not null

Throw:

DateTimeException

if the result exceeds the supported date range

public month(): Month source

Return:

Month

month

public monthValue(): number source

Return:

number

gets the month value

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:

NameTypeAttributeDescription
p1 TemporalAmount | number
  • nullable: false
p2 TemporalUnit

required if called with 2 arguments

Return:

LocalDate

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:

NameTypeAttributeDescription
amount TemporalAmount
  • nullable: false

the amount to add, not null

Return:

LocalDate

a LocalDate based on this date with the addition made, not null

Throw:

DateTimeException

if the addition cannot be made

ArithmeticException

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:

NameTypeAttributeDescription
amountToAdd number
  • nullable: false

the amount of the unit to add to the result, may be negative

unit TemporalUnit
  • nullable: false

the unit of the period to add, not null

Return:

LocalDate

a LocalDate based on this date with the specified period added, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
daysToAdd number

the days to add, may be negative

Return:

LocalDate

a LocalDate based on this date with the days added, not null

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:

  1. Add the input months to the month-of-year field
  2. Check if the resulting date would be invalid
  3. 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.

Params:

NameTypeAttributeDescription
monthsToAdd number

the months to add, may be negative

Return:

LocalDate

a LocalDate based on this date with the months added, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
weeksToAdd number
  • nullable: false

the weeks to add, may be negative

Return:

LocalDate

a LocalDate based on this date with the weeks added, not null

Throw:

DateTimeException

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:

  1. Add the input years to the year field
  2. Check if the resulting date would be invalid
  3. 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.

Params:

NameTypeAttributeDescription
yearsToAdd number
  • nullable: false

the years to add, may be negative

Return:

LocalDate

a LocalDate based on this date with the years added, not null

Throw:

DateTimeException

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 TemporalQuery#queryFrom method on the specified query passing this as the argument.

Override:

ChronoLocalDate#query

Params:

NameTypeAttributeDescription
query TemporalQuery

the query to invoke, not null

Return:

*

the query result, null may be returned (defined by the query)

Throw:

DateTimeException

if unable to query (defined by the query)

ArithmeticException

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#range

Params:

NameTypeAttributeDescription
field TemporalField

the field to query the range for, not null

Return:

ValueRange

the range of valid values for the field, not null

Throw:

DateTimeException

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.

Return:

number

the Epoch Day equivalent to this date

public toJSON(): string source

Return:

string

same as LocalDate.toString

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.

Return:

string

a string representation of this date, not null

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:

NameTypeAttributeDescription
p1 TemporalAccessor
  • nullable: false
p2 TemporalUnit

not null if called with 2 arguments

Return:

number | Period

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 Period#between:

  // 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:

NameTypeAttributeDescription
endDate TemporalAccessor
  • nullable: false

the end date, exclusive, which may be in any chronology, not null

Return:

Period

the period between this date and the end date, 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 startDate.until.

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 TemporalUnit.between passing this as the first argument and the input temporal as the second argument.

Params:

NameTypeAttributeDescription
endExclusive TemporalAccessor
  • nullable: false

the end date, which is converted to a LocalDate, not null

unit TemporalUnit
  • nullable: false

the unit to measure the period in, not null

Return:

number

the amount of the period between this date and the end date

Throw:

DateTimeException

if the period cannot be calculated

ArithmeticException

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 newValue argument is expected and LocalDate.withFieldAndValue is called.

Params:

NameTypeAttributeDescription
fieldOrAdjuster TemporalAdjuster | TemporalField
  • nullable: false
newValue number

required if first argument is a TemporalField

Return:

LocalDate

the new LocalDate with the newValue set.

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:

NameTypeAttributeDescription
dayOfMonth number
  • nullable: false

the day-of-month to set in the result, from 1 to 28-31

Return:

LocalDate

based on this date with the requested day, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
dayOfYear *

the day-of-year to set in the result, from 1 to 365-366

Return:

LocalDate

a LocalDate based on this date with the requested day, not null

Throw:

DateTimeException

if the day-of-year value is invalid

DateTimeException

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:

  • DAY_OF_WEEK - Returns a LocalDate with the specified day-of-week. The date is adjusted up to 6 days forward or backward within the boundary of a Monday to Sunday week.
  • ALIGNED_DAY_OF_WEEK_IN_MONTH - Returns a LocalDate with the specified aligned-day-of-week. The date is adjusted to the specified month-based aligned-day-of-week. Aligned weeks are counted such that the first week of a given month starts on the first day of that month. This may cause the date to be moved up to 6 days into the following month.
  • ALIGNED_DAY_OF_WEEK_IN_YEAR - Returns a LocalDate with the specified aligned-day-of-week. The date is adjusted to the specified year-based aligned-day-of-week. Aligned weeks are counted such that the first week of a given year starts on the first day of that year. This may cause the date to be moved up to 6 days into the following year.
  • DAY_OF_MONTH - Returns a LocalDate with the specified day-of-month. The month and year will be unchanged. If the day-of-month is invalid for the year and month, then a DateTimeException is thrown.
  • DAY_OF_YEAR - Returns a LocalDate with the specified day-of-year. The year will be unchanged. If the day-of-year is invalid for the year, then a DateTimeException is thrown.
  • EPOCH_DAY - Returns a LocalDate with the specified epoch-day. This completely replaces the date and is equivalent to ofEpochDay.
  • ALIGNED_WEEK_OF_MONTH - Returns a LocalDate with the specified aligned-week-of-month. Aligned weeks are counted such that the first week of a given month starts on the first day of that month. This adjustment moves the date in whole week chunks to match the specified week. The result will have the same day-of-week as this date. This may cause the date to be moved into the following month.
  • ALIGNED_WEEK_OF_YEAR - Returns a LocalDate with the specified aligned-week-of-year. Aligned weeks are counted such that the first week of a given year starts on the first day of that year. This adjustment moves the date in whole week chunks to match the specified week. The result will have the same day-of-week as this date. This may cause the date to be moved into the following year.
  • MONTH_OF_YEAR - Returns a LocalDate with the specified month-of-year. The year will be unchanged. The day-of-month will also be unchanged, unless it would be invalid for the new month and year. In that case, the day-of-month is adjusted to the maximum valid value for the new month and year.
  • PROLEPTIC_MONTH - Returns a LocalDate with the specified proleptic-month. The day-of-month will be unchanged, unless it would be invalid for the new month and year. In that case, the day-of-month is adjusted to the maximum valid value for the new month and year.
  • YEAR_OF_ERA - Returns a LocalDate with the specified year-of-era. The era and month will be unchanged. The day-of-month will also be unchanged, unless it would be invalid for the new month and year. In that case, the day-of-month is adjusted to the maximum valid value for the new month and year.
  • YEAR - Returns a LocalDate with the specified year. The month will be unchanged. The day-of-month will also be unchanged, unless it would be invalid for the new month and year. In that case, the day-of-month is adjusted to the maximum valid value for the new month and year.
  • ERA - Returns a LocalDate with the specified era. The year-of-era and month will be unchanged. The day-of-month will also be unchanged, unless it would be invalid for the new month and year. In that case, the day-of-month is adjusted to the maximum valid value for the new month and year.

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 TemporalField.adjustInto passing this as the argument. In this case, the field determines whether and how to adjust the instant.

Params:

NameTypeAttributeDescription
field TemporalField

the field to set in the result, not null

newValue number

the new value of the field in the result

Return:

LocalDate

a LocalDate based on this with the specified field set, not null

Throw:

DateTimeException

if the field cannot be set

ArithmeticException

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.

Params:

NameTypeAttributeDescription
month Month | number
  • nullable: false

the month-of-year to set in the result, from 1 (January) to 12 (December)

Return:

LocalDate

a LocalDate based on this date with the requested month, not null

Throw:

DateTimeException

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:

NameTypeAttributeDescription
adjuster TemporalAdjuster
  • nullable: false

the adjuster to use, not null

Return:

LocalDate

a LocalDate based on this with the adjustment made, not null

Throw:

DateTimeException

if the adjustment cannot be made

ArithmeticException

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:

NameTypeAttributeDescription
year number
  • nullable: false

the year to set in the result, from Year.MIN_VALUE to Year.MAX_VALUE

Return:

LocalDate

a LocalDate based on this date with the requested year, not null

Throw:

DateTimeException

if the year value is invalid

public year(): number source

Return:

number

gets the year