LocalDate

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.

Throw:

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.

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.

Throw:

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.

Throw:

obtain a LocalDate from an Instant in the specified time-zone or, if null in the system default time-zone

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:

Obtains an instance of LocalDate from a text string using a specific formatter.

The text is parsed using the formatter, returning a date.

Throw:

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:

Throw:

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.

If zone is not null, 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.

function overloading for LocalDate.atTime

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

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.

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.

Throw:

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 today's rules for leap years are applied for all time.

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.

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.

Gets the day-of-year field.

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

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.

Outputs this date as a string using the formatter.

Override:

Throw:

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:

Throw:

see {LocalDate.get}, get and getLong are identical in javascript, because we are only limited by MathUtil.MIN_SAFE_INTEGER/ MathUtil.MAX_SAFE_INTEGER

Override:

A hash code for this date.

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.

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.

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.

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.

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:

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.

Returns the length of the year represented by this date.

This returns the length of the year in days, either 365 or 366.

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.

Throw:

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.

Throw:

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.

Throw:

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.

Throw:

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.

Throw:

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.

Throw:

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.

Throw:

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:

Throw:

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:

Throw:

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.

Outputs this date as a String, such as 2007-12-03. The output will be in the ISO-8601 format uuuu-MM-dd.

function overloading for LocalDate.until

called with 1 (or less) arguments {LocalDate.until1} is called otherwise LocalDate.until2

Override:

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);

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.

Throw:

Returns a copy of this LocalDate with the day-of-month altered.

If the resulting date is invalid, an exception is thrown.

Throw:

Returns a copy of this date with the day-of-year altered. If the resulting date is invalid, an exception is thrown.

Throw:

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:

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.

Throw: