org.threeten.bp
Class LocalDate

java.lang.Object
  org.threeten.bp.jdk8.DefaultInterfaceTemporalAccessor
      org.threeten.bp.jdk8.DefaultInterfaceTemporal
          org.threeten.bp.chrono.ChronoLocalDate
              org.threeten.bp.LocalDate

All Implemented Interfaces:

Serializable, Comparable<ChronoLocalDate>, Temporal, TemporalAccessor, TemporalAdjuster

public final class LocalDate
extends ChronoLocalDate
implements Temporal, TemporalAdjuster, Serializable

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.

Specification for implementors

See Also:

Serialized Form

MIN

public static final LocalDate MIN

The minimum supported LocalDate, '-999999999-01-01'. This could be used by an application as a "far past" date.

MAX

public static final LocalDate MAX

The maximum supported LocalDate, '+999999999-12-31'. This could be used by an application as a "far future" date.

FROM

public static final TemporalQuery<LocalDate> FROM

Simulate JDK 8 method reference LocalDate::from.

now

public static LocalDate now()

Obtains the current date from the system clock in the default time-zone.

This will query the system clock in the default time-zone to obtain the current date.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Returns:

the current date using the system clock and default time-zone, not null

now

public static LocalDate now(ZoneId zone)

Obtains the current date from the system clock in the specified time-zone.

This will query the system clock to obtain the current date. Specifying the time-zone avoids dependence on the default time-zone.

Using this method will prevent the ability to use an alternate clock for testing because the clock is hard-coded.

Parameters:

zone - the zone ID to use, not null

Returns:

the current date using the system clock, not null

now

public static LocalDate now(Clock clock)

Obtains 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. The alternate clock may be introduced using dependency injection.

Parameters:

clock - the clock to use, not null

Returns:

the current date, not null

of

public static LocalDate of(int year,
                           Month month,
                           int dayOfMonth)

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

The day must be valid for the year and month, otherwise an exception will be thrown.

Parameters:

year - the year to represent, from MIN_YEAR to MAX_YEAR

month - the month-of-year to represent, not null

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

Returns:

the local date, not null

Throws:

DateTimeException - if the value of any field is out of range

DateTimeException - if the day-of-month is invalid for the month-year

of

public static LocalDate of(int year,
                           int month,
                           int dayOfMonth)

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

The day must be valid for the year and month, otherwise an exception will be thrown.

Parameters:

year - the year to represent, from MIN_YEAR to MAX_YEAR

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

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

Returns:

the local date, not null

Throws:

DateTimeException - if the value of any field is out of range

DateTimeException - if the day-of-month is invalid for the month-year

ofYearDay

public static LocalDate ofYearDay(int year,
                                  int dayOfYear)

Obtains an instance of LocalDate from a year and day-of-year.

The day-of-year must be valid for the year, otherwise an exception will be thrown.

Parameters:

year - the year to represent, from MIN_YEAR to MAX_YEAR

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

Returns:

the local date, not null

Throws:

DateTimeException - if the value of any field is out of range

DateTimeException - if the day-of-year is invalid for the month-year

ofEpochDay

public static LocalDate ofEpochDay(long epochDay)

Obtains an instance of LocalDate from the epoch day count.

The Epoch Day count is a simple incrementing count of days where day 0 is 1970-01-01. Negative numbers represent earlier days.

Parameters:

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

Returns:

the local date, not null

Throws:

DateTimeException - if the epoch days exceeds the supported date range

from

public static LocalDate from(TemporalAccessor temporal)

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

Parameters:

temporal - the temporal object to convert, not null

Returns:

the local date, not null

Throws:

DateTimeException - if unable to convert to a LocalDate

parse

public static LocalDate parse(CharSequence text)

Obtains an instance of LocalDate from a text string such as 2007-12-03.

The string must represent a valid date and is parsed using DateTimeFormatter.ISO_LOCAL_DATE.

Parameters:

text - the text to parse such as "2007-12-03", not null

Returns:

the parsed local date, not null

Throws:

DateTimeParseException - if the text cannot be parsed

parse

public static LocalDate parse(CharSequence text,
                              DateTimeFormatter formatter)

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

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

Parameters:

text - the text to parse, not null

formatter - the formatter to use, not null

Returns:

the parsed local date, not null

Throws:

DateTimeParseException - if the text cannot be parsed

isSupported

public boolean isSupported(TemporalField field)

Checks if the specified field is supported.

This checks if this date can be queried for the specified field. If false, then calling the range and get methods will throw an exception.

If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this date-time. The supported fields are:

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

All 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(TemporalAccessor) passing this as the argument. Whether the field is supported is determined by the field.

Specified by:

isSupported in interface TemporalAccessor

Overrides:

isSupported in class ChronoLocalDate

Parameters:

field - the field to check, null returns false

Returns:

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

range

public ValueRange range(TemporalField field)

Gets the range of valid values for the specified field.

The range object expresses the minimum and maximum valid values for a field. This date 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 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(TemporalAccessor) passing this as the argument. Whether the range can be obtained is determined by the field.

Specified by:

range in interface TemporalAccessor

Overrides:

range in class DefaultInterfaceTemporalAccessor

Parameters:

field - the field to query the range for, not null

Returns:

the range of valid values for the field, not null

Throws:

DateTimeException - if the range for the field cannot be obtained

get

public int get(TemporalField field)

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 supported fields will return valid values based on this date, except EPOCH_DAY and EPOCH_MONTH which are too large to fit in an int and throw a DateTimeException. All other ChronoField instances will throw a DateTimeException.

If the field is not a ChronoField, then the result of this method is obtained by invoking TemporalField.getFrom(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Specified by:

get in interface TemporalAccessor

Overrides:

get in class DefaultInterfaceTemporalAccessor

Parameters:

field - the field to get, not null

Returns:

the value for the field

Throws:

DateTimeException - if a value for the field cannot be obtained

ArithmeticException - if numeric overflow occurs

getLong

public long getLong(TemporalField field)

Gets the value of the specified field from this date as a long.

This queries this date for the value for the specified field. If it is not possible to return the value, because the field is not supported or for some other reason, an exception is thrown.

If the field is a ChronoField then the query is implemented here. The supported fields will return valid values based on this date. 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(TemporalAccessor) passing this as the argument. Whether the value can be obtained, and what the value represents, is determined by the field.

Specified by:

getLong in interface TemporalAccessor

Parameters:

field - the field to get, not null

Returns:

the value for the field

Throws:

DateTimeException - if a value for the field cannot be obtained

ArithmeticException - if numeric overflow occurs

getChronology

public IsoChronology getChronology()

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.

Specified by:

getChronology in class ChronoLocalDate

Returns:

the ISO chronology, not null

getEra

public Era getEra()

Gets the era applicable at this date.

The official ISO-8601 standard does not define eras, however IsoChronology does. It defines two eras, 'CE' from year one onwards and 'BCE' from year zero backwards. Since dates before the Julian-Gregorian cutover are not in line with history, the cutover between 'BCE' and 'CE' is also not aligned with the commonly used eras, often referred to using 'BC' and 'AD'.

Users of this class should typically ignore this method as it exists primarily to fulfill the ChronoLocalDate contract where it is necessary to support the Japanese calendar system.

The returned era will be a singleton capable of being compared with the constants in IsoChronology using the == operator.

Overrides:

getEra in class ChronoLocalDate

Returns:

the IsoChronology era constant applicable at this date, not null

getYear

public int getYear()

Gets the year field.

This method returns the primitive int value for the year.

The year returned by this method is proleptic as per get(YEAR). To obtain the year-of-era, use get(YEAR_OF_ERA.

Returns:

the year, from MIN_YEAR to MAX_YEAR

getMonthValue

public int getMonthValue()

Gets the month-of-year field from 1 to 12.

This method returns the month as an int from 1 to 12. Application code is frequently clearer if the enum Month is used by calling getMonth().

Returns:

the month-of-year, from 1 to 12

See Also:

getMonth()

getMonth

public Month getMonth()

Gets the month-of-year field using the Month enum.

This method returns the enum Month for the month. This avoids confusion as to what int values mean. If you need access to the primitive int value then the enum provides the int value.

Returns:

the month-of-year, not null

See Also:

getMonthValue()

getDayOfMonth

public int getDayOfMonth()

Gets the day-of-month field.

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

Returns:

the day-of-month, from 1 to 31

getDayOfYear

public int getDayOfYear()

Gets the day-of-year field.

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

Returns:

the day-of-year, from 1 to 365, or 366 in a leap year

getDayOfWeek

public DayOfWeek getDayOfWeek()

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 int value.

Additional information can be obtained from the DayOfWeek. This includes textual names of the values.

Returns:

the day-of-week, not null

isLeapYear

public boolean isLeapYear()

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.

Overrides:

isLeapYear in class ChronoLocalDate

Returns:

true if the year is leap, false otherwise

lengthOfMonth

public int lengthOfMonth()

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.

Specified by:

lengthOfMonth in class ChronoLocalDate

Returns:

the length of the month in days

lengthOfYear

public int lengthOfYear()

Returns the length of the year represented by this date.

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

Overrides:

lengthOfYear in class ChronoLocalDate

Returns:

366 if the year is leap, 365 otherwise

with

public LocalDate with(TemporalAdjuster adjuster)

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(Temporal) method on the specified adjuster passing this as the argument.

This instance is immutable and unaffected by this method call.

Specified by:

with in interface Temporal

Overrides:

with in class ChronoLocalDate

Parameters:

adjuster - the adjuster to use, not null

Returns:

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

Throws:

DateTimeException - if the adjustment cannot be made

ArithmeticException - if numeric overflow occurs

with

public LocalDate with(TemporalField field,
                      long newValue)

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(long).
• 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(Temporal, long) passing this as the argument. In this case, the field determines whether and how to adjust the instant.

This instance is immutable and unaffected by this method call.

Specified by:

with in interface Temporal

Specified by:

with in class ChronoLocalDate

Parameters:

field - the field to set in the result, not null

newValue - the new value of the field in the result

Returns:

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

Throws:

DateTimeException - if the field cannot be set

ArithmeticException - if numeric overflow occurs

withYear

public LocalDate withYear(int year)

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.

This instance is immutable and unaffected by this method call.

Parameters:

year - the year to set in the result, from MIN_YEAR to MAX_YEAR

Returns:

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

Throws:

DateTimeException - if the year value is invalid

withMonth

public LocalDate withMonth(int month)

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.

This instance is immutable and unaffected by this method call.

Parameters:

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

Returns:

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

Throws:

DateTimeException - if the month-of-year value is invalid

withDayOfMonth

public LocalDate withDayOfMonth(int dayOfMonth)

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

This instance is immutable and unaffected by this method call.

Parameters:

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

Returns:

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

Throws:

DateTimeException - if the day-of-month value is invalid

DateTimeException - if the day-of-month is invalid for the month-year

withDayOfYear

public LocalDate withDayOfYear(int dayOfYear)

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

This instance is immutable and unaffected by this method call.

Parameters:

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

Returns:

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

Throws:

DateTimeException - if the day-of-year value is invalid

DateTimeException - if the day-of-year is invalid for the year

plus

public LocalDate plus(TemporalAmount amount)

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 plus(long, TemporalUnit).

This instance is immutable and unaffected by this method call.

Specified by:

plus in interface Temporal

Overrides:

plus in class ChronoLocalDate

Parameters:

amount - the amount to add, not null

Returns:

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

Throws:

DateTimeException - if the addition cannot be made

ArithmeticException - if numeric overflow occurs

plus

public LocalDate plus(long amountToAdd,
                      TemporalUnit unit)

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.

This instance is immutable and unaffected by this method call.

Specified by:

plus in interface Temporal

Specified by:

plus in class ChronoLocalDate

Parameters:

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

unit - the unit of the period to add, not null

Returns:

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

Throws:

DateTimeException - if the unit cannot be added to this type

plusYears

public LocalDate plusYears(long yearsToAdd)

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.

This instance is immutable and unaffected by this method call.

Parameters:

yearsToAdd - the years to add, may be negative

Returns:

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

Throws:

DateTimeException - if the result exceeds the supported date range

plusMonths

public LocalDate plusMonths(long monthsToAdd)

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.

This instance is immutable and unaffected by this method call.

Parameters:

monthsToAdd - the months to add, may be negative

Returns:

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

Throws:

DateTimeException - if the result exceeds the supported date range

plusWeeks

public LocalDate plusWeeks(long weeksToAdd)

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.

This instance is immutable and unaffected by this method call.

Parameters:

weeksToAdd - the weeks to add, may be negative

Returns:

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

Throws:

DateTimeException - if the result exceeds the supported date range

plusDays

public LocalDate plusDays(long daysToAdd)

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.

This instance is immutable and unaffected by this method call.

Parameters:

daysToAdd - the days to add, may be negative

Returns:

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

Throws:

DateTimeException - if the result exceeds the supported date range

minus

public LocalDate minus(TemporalAmount amount)

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(long, TemporalUnit).

This instance is immutable and unaffected by this method call.

Specified by:

minus in interface Temporal

Overrides:

minus in class ChronoLocalDate

Parameters:

amount - the amount to subtract, not null

Returns:

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

Throws:

DateTimeException - if the subtraction cannot be made

ArithmeticException - if numeric overflow occurs

minus

public LocalDate minus(long amountToSubtract,
                       TemporalUnit unit)

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.

This instance is immutable and unaffected by this method call.

Specified by:

minus in interface Temporal

Overrides:

minus in class ChronoLocalDate

Parameters:

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

unit - the unit of the period to subtract, not null

Returns:

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

Throws:

DateTimeException - if the unit cannot be added to this type

minusYears

public LocalDate minusYears(long yearsToSubtract)

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.

This instance is immutable and unaffected by this method call.

Parameters:

yearsToSubtract - the years to subtract, may be negative

Returns:

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

Throws:

DateTimeException - if the result exceeds the supported date range

minusMonths

public LocalDate minusMonths(long monthsToSubtract)

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.

This instance is immutable and unaffected by this method call.

Parameters:

monthsToSubtract - the months to subtract, may be negative

Returns:

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

Throws:

DateTimeException - if the result exceeds the supported date range

minusWeeks

public LocalDate minusWeeks(long weeksToSubtract)

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.

This instance is immutable and unaffected by this method call.

Parameters:

weeksToSubtract - the weeks to subtract, may be negative

Returns:

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

Throws:

DateTimeException - if the result exceeds the supported date range

minusDays

public LocalDate minusDays(long daysToSubtract)

Returns a copy of this LocalDate with the specified number of days subtracted.

This method subtracts the specified amount 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-01 minus one day would result in 2008-12-31.

This instance is immutable and unaffected by this method call.

Parameters:

daysToSubtract - the days to subtract, may be negative

Returns:

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

Throws:

DateTimeException - if the result exceeds the supported date range

query

public <R> R query(TemporalQuery<R> query)

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(TemporalAccessor) method on the specified query passing this as the argument.

Specified by:

query in interface TemporalAccessor

Overrides:

query in class ChronoLocalDate

Type Parameters:

R - the type of the result

Parameters:

query - the query to invoke, not null

Returns:

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

Throws:

DateTimeException - if unable to query (defined by the query)

ArithmeticException - if numeric overflow occurs (defined by the query)

adjustInto

public Temporal adjustInto(Temporal temporal)

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(TemporalField, long) passing ChronoField.EPOCH_DAY as the field.

In most cases, it is clearer to reverse the calling pattern by using Temporal.with(TemporalAdjuster):

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

This instance is immutable and unaffected by this method call.

Specified by:

adjustInto in interface TemporalAdjuster

Overrides:

adjustInto in class ChronoLocalDate

Parameters:

temporal - the target object to be adjusted, not null

Returns:

the adjusted object, not null

Throws:

DateTimeException - if unable to make the adjustment

ArithmeticException - if numeric overflow occurs

until

public long until(Temporal endExclusive,
                  TemporalUnit unit)

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(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(org.threeten.bp.temporal.Temporal, org.threeten.bp.temporal.Temporal). 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(Temporal, Temporal) passing this as the first argument and the input temporal as the second argument.

This instance is immutable and unaffected by this method call.

Specified by:

until in interface Temporal

Parameters:

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

unit - the unit to measure the period in, not null

Returns:

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

Throws:

DateTimeException - if the period cannot be calculated

ArithmeticException - if numeric overflow occurs

until

public Period until(ChronoLocalDate endDate)

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

Specified by:

until in class ChronoLocalDate

Parameters:

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

Returns:

the period between this date and the end date, not null

atTime

public LocalDateTime atTime(LocalTime time)

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.

Overrides:

atTime in class ChronoLocalDate

Parameters:

time - the time to combine with, not null

Returns:

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

atTime

public LocalDateTime atTime(int hour,
                            int minute)

Combines this date with a time to create a LocalDateTime.

This returns a LocalDateTime formed from this date at the specified hour and minute. The seconds and nanosecond fields will be set to zero. The individual time fields must be within their valid range. All possible combinations of date and time are valid.

Parameters:

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

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

Returns:

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

Throws:

DateTimeException - if the value of any field is out of range

atTime

public LocalDateTime atTime(int hour,
                            int minute,
                            int second)

Combines this date with a time to create a LocalDateTime.

This returns a LocalDateTime formed from this date at the specified hour, minute and second. The nanosecond field will be set to zero. The individual time fields must be within their valid range. All possible combinations of date and time are valid.

Parameters:

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

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

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

Returns:

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

Throws:

DateTimeException - if the value of any field is out of range

atTime

public LocalDateTime atTime(int hour,
                            int minute,
                            int second,
                            int nanoOfSecond)

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.

Parameters:

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

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

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

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

Returns:

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

Throws:

DateTimeException - if the value of any field is out of range

atTime

public OffsetDateTime atTime(OffsetTime time)

Combines this date with an offset time to create an OffsetDateTime.

This returns an OffsetDateTime formed from this date at the specified time. All possible combinations of date and time are valid.

Parameters:

time - the time to combine with, not null

Returns:

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

atStartOfDay

public LocalDateTime atStartOfDay()

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.

Returns:

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

atStartOfDay

public ZonedDateTime atStartOfDay(ZoneId zone)

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(LocalTime) followed by LocalDateTime.atZone(ZoneId).

Parameters:

zone - the zone ID to use, not null

Returns:

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

toEpochDay

public long toEpochDay()

Description copied from class: ChronoLocalDate

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.

Overrides:

toEpochDay in class ChronoLocalDate

Returns:

the Epoch Day equivalent to this date

compareTo

public int compareTo(ChronoLocalDate other)

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(org.threeten.bp.chrono.ChronoLocalDate).

Specified by:

compareTo in interface Comparable<ChronoLocalDate>

Overrides:

compareTo in class ChronoLocalDate

Parameters:

other - the other date to compare to, not null

Returns:

the comparator value, negative if less, positive if greater

isAfter

public boolean isAfter(ChronoLocalDate other)

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

Overrides:

isAfter in class ChronoLocalDate

Parameters:

other - the other date to compare to, not null

Returns:

true if this date is after the specified date

isBefore

public boolean isBefore(ChronoLocalDate other)

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

Overrides:

isBefore in class ChronoLocalDate

Parameters:

other - the other date to compare to, not null

Returns:

true if this date is before the specified date

isEqual

public boolean isEqual(ChronoLocalDate other)

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

Overrides:

isEqual in class ChronoLocalDate

Parameters:

other - the other date to compare to, not null

Returns:

true if this date is equal to the specified date

equals

public boolean equals(Object obj)

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. To compare the dates of two TemporalAccessor instances, including dates in two different chronologies, use ChronoField.EPOCH_DAY as a comparator.

Overrides:

equals in class ChronoLocalDate

Parameters:

obj - the object to check, null returns false

Returns:

true if this is equal to the other date

hashCode

public int hashCode()

A hash code for this date.

Overrides:

hashCode in class ChronoLocalDate

Returns:

a suitable hash code

toString

public String toString()

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

The output will be in the ISO-8601 format yyyy-MM-dd.

Overrides:

toString in class ChronoLocalDate

Returns:

a string representation of this date, not null

format

public String format(DateTimeFormatter formatter)

Outputs this date as a String using the formatter.

This date will be passed to the formatter print method.

Overrides:

format in class ChronoLocalDate

Parameters:

formatter - the formatter to use, not null

Returns:

the formatted date string, not null

Throws:

DateTimeException - if an error occurs during printing