public final class LocalDate extends DefaultInterfaceChronoLocalDate<ISOChrono> implements Temporal, TemporalAdjuster, ChronoLocalDate<ISOChrono>, Serializable
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.
| Modifier and Type | Field and Description |
|---|---|
static LocalDate |
MAX
The maximum supported
LocalDate, '+999999999-12-31'. |
static LocalDate |
MIN
The minimum supported
LocalDate, '-999999999-01-01'. |
DATE_COMPARATOR| Modifier and Type | Method and Description |
|---|---|
Temporal |
adjustInto(Temporal temporal)
Adjusts the specified temporal object to have the same date as this object.
|
OffsetDate |
atOffset(ZoneOffset offset)
Returns an offset date formed from this date and the specified offset.
|
ZonedDateTime |
atStartOfDay(ZoneId zone)
Returns a zoned date-time from this date at the earliest valid time according
to the rules in the time-zone.
|
LocalDateTime |
atTime(int hour,
int minute)
Returns a local date-time formed from this date at the specified time.
|
LocalDateTime |
atTime(int hour,
int minute,
int second)
Returns a local date-time formed from this date at the specified time.
|
LocalDateTime |
atTime(int hour,
int minute,
int second,
int nanoOfSecond)
Returns a local date-time formed from this date at the specified time.
|
LocalDateTime |
atTime(LocalTime time)
Returns a local date-time formed from this date at the specified time.
|
int |
compareTo(ChronoLocalDate<?> other)
Compares this date to another date.
|
boolean |
equals(Object obj)
Checks if this date is equal to another date.
|
static LocalDate |
from(TemporalAccessor temporal)
Obtains an instance of
LocalDate from a temporal object. |
int |
get(TemporalField field)
Gets the value of the specified field from this date as an
int. |
ISOChrono |
getChrono()
Gets the chronology of this date, which is the ISO calendar system.
|
int |
getDayOfMonth()
Gets the day-of-month field.
|
DayOfWeek |
getDayOfWeek()
Gets the day-of-week field, which is an enum
DayOfWeek. |
int |
getDayOfYear()
Gets the day-of-year field.
|
Era<ISOChrono> |
getEra()
Gets the era applicable at this date.
|
long |
getLong(TemporalField field)
Gets the value of the specified field from this date as a
long. |
Month |
getMonth()
Gets the month-of-year field using the
Month enum. |
int |
getMonthValue()
Gets the month-of-year field from 1 to 12.
|
int |
getYear()
Gets the year field.
|
int |
hashCode()
A hash code for this date.
|
boolean |
isAfter(ChronoLocalDate<?> other)
Checks if this date is after the specified date.
|
boolean |
isBefore(ChronoLocalDate<?> other)
Checks if this date is before the specified date.
|
boolean |
isEqual(ChronoLocalDate<?> other)
Checks if this date is equal to the specified date.
|
boolean |
isLeapYear()
Checks if the year is a leap year, according to the ISO proleptic
calendar system rules.
|
boolean |
isSupported(TemporalField field)
Checks if the specified field is supported.
|
int |
lengthOfMonth()
Returns the length of the month represented by this date.
|
int |
lengthOfYear()
Returns the length of the year represented by this date.
|
LocalDate |
minus(long amountToSubtract,
TemporalUnit unit)
Returns a copy of this date with the specified period subtracted.
|
LocalDate |
minus(TemporalSubtractor subtractor)
Returns a copy of this date with the specified period subtracted.
|
LocalDate |
minusDays(long daysToSubtract)
Returns a copy of this
LocalDate with the specified number of days subtracted. |
LocalDate |
minusMonths(long monthsToSubtract)
Returns a copy of this
LocalDate with the specified period in months subtracted. |
LocalDate |
minusWeeks(long weeksToSubtract)
Returns a copy of this
LocalDate with the specified period in weeks subtracted. |
LocalDate |
minusYears(long yearsToSubtract)
Returns a copy of this
LocalDate with the specified period in years subtracted. |
static LocalDate |
now()
Obtains the current date from the system clock in the default time-zone.
|
static LocalDate |
now(Clock clock)
Obtains the current date from the specified clock.
|
static LocalDate |
now(ZoneId zone)
Obtains the current date from the system clock in the specified time-zone.
|
static LocalDate |
of(int year,
int month,
int dayOfMonth)
Obtains an instance of
LocalDate from a year, month and day. |
static LocalDate |
of(int year,
Month month,
int dayOfMonth)
Obtains an instance of
LocalDate from a year, month and day. |
static LocalDate |
ofEpochDay(long epochDay)
Obtains an instance of
LocalDate from the epoch day count. |
static LocalDate |
ofYearDay(int year,
int dayOfYear)
Obtains an instance of
LocalDate from a year and day-of-year. |
static LocalDate |
parse(CharSequence text)
Obtains an instance of
LocalDate from a text string such as 2007-12-03. |
static LocalDate |
parse(CharSequence text,
DateTimeFormatter formatter)
Obtains an instance of
LocalDate from a text string using a specific formatter. |
long |
periodUntil(Temporal endDate,
TemporalUnit unit)
Calculates the period between this date and another date in
terms of the specified unit.
|
LocalDate |
plus(long amountToAdd,
TemporalUnit unit)
Returns a copy of this date with the specified period added.
|
LocalDate |
plus(TemporalAdder adder)
Returns a copy of this date with the specified period added.
|
LocalDate |
plusDays(long daysToAdd)
Returns a copy of this
LocalDate with the specified number of days added. |
LocalDate |
plusMonths(long monthsToAdd)
Returns a copy of this
LocalDate with the specified period in months added. |
LocalDate |
plusWeeks(long weeksToAdd)
Returns a copy of this
LocalDate with the specified period in weeks added. |
LocalDate |
plusYears(long yearsToAdd)
Returns a copy of this
LocalDate with the specified period in years added. |
<R> R |
query(TemporalQuery<R> query)
Queries this date using the specified query.
|
ValueRange |
range(TemporalField field)
Gets the range of valid values for the specified field.
|
long |
toEpochDay()
Converts this date to the Epoch Day.
|
String |
toString()
Outputs this date as a
String, such as 2007-12-03. |
String |
toString(DateTimeFormatter formatter)
Outputs this date as a
String using the formatter. |
LocalDate |
with(TemporalAdjuster adjuster)
Returns an adjusted copy of this date.
|
LocalDate |
with(TemporalField field,
long newValue)
Returns a copy of this date with the specified field set to a new value.
|
LocalDate |
withDayOfMonth(int dayOfMonth)
Returns a copy of this date with the day-of-month altered.
|
LocalDate |
withDayOfYear(int dayOfYear)
Returns a copy of this date with the day-of-year altered.
|
LocalDate |
withMonth(int month)
Returns a copy of this date with the month-of-year altered.
|
LocalDate |
withYear(int year)
Returns a copy of this date with the year altered.
|
public static final LocalDate MIN
LocalDate, '-999999999-01-01'.
This could be used by an application as a "far past" date.public static LocalDate now()
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.
public static LocalDate now(ZoneId 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.
zone - the zone ID to use, not nullpublic static LocalDate now(Clock 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.
clock - the clock to use, not nullpublic static LocalDate of(int year, Month month, int dayOfMonth)
LocalDate from a year, month and day.
The day must be valid for the year and month, otherwise an exception will be thrown.
year - the year to represent, from MIN_YEAR to MAX_YEARmonth - the month-of-year to represent, not nulldayOfMonth - the day-of-month to represent, from 1 to 31DateTimeException - if the value of any field is out of rangeDateTimeException - if the day-of-month is invalid for the month-yearpublic static LocalDate of(int year, int month, int dayOfMonth)
LocalDate from a year, month and day.
The day must be valid for the year and month, otherwise an exception will be thrown.
year - the year to represent, from MIN_YEAR to MAX_YEARmonth - the month-of-year to represent, from 1 (January) to 12 (December)dayOfMonth - the day-of-month to represent, from 1 to 31DateTimeException - if the value of any field is out of rangeDateTimeException - if the day-of-month is invalid for the month-yearpublic static LocalDate ofYearDay(int year, int dayOfYear)
LocalDate from a year and day-of-year.
The day-of-year must be valid for the year, otherwise an exception will be thrown.
year - the year to represent, from MIN_YEAR to MAX_YEARdayOfYear - the day-of-year to represent, from 1 to 366DateTimeException - if the value of any field is out of rangeDateTimeException - if the day-of-year is invalid for the month-yearpublic static LocalDate ofEpochDay(long epochDay)
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.
epochDay - the Epoch Day to convert, based on the epoch 1970-01-01DateTimeException - if the epoch days exceeds the supported date rangepublic static LocalDate from(TemporalAccessor temporal)
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 extracts 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.
temporal - the temporal object to convert, not nullDateTimeException - if unable to convert to a LocalDatepublic static LocalDate parse(CharSequence text)
LocalDate from a text string such as 2007-12-03.
The string must represent a valid date and is parsed using
DateTimeFormatters.isoLocalDate().
text - the text to parse such as "2007-12-03", not nullDateTimeParseException - if the text cannot be parsedpublic static LocalDate parse(CharSequence text, DateTimeFormatter formatter)
LocalDate from a text string using a specific formatter.
The text is parsed using the formatter, returning a date.
text - the text to parse, not nullformatter - the formatter to use, not nullDateTimeParseException - if the text cannot be parsedpublic boolean isSupported(TemporalField field)
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
ChronoField instances will return false.
If the field is not a ChronoField, then the result of this method
is obtained by invoking TemporalField.doIsSupported(TemporalAccessor)
passing this as the argument.
Whether the field is supported is determined by the field.
isSupported in interface TemporalAccessorisSupported in class DefaultInterfaceChronoLocalDate<ISOChrono>field - the field to check, null returns falsepublic ValueRange range(TemporalField 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.doRange(TemporalAccessor)
passing this as the argument.
Whether the range can be obtained is determined by the field.
range in interface TemporalAccessorrange in class DefaultInterfaceTemporalAccessorfield - the field to query the range for, not nullDateTimeException - if the range for the field cannot be obtainedpublic int get(TemporalField field)
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.doGet(TemporalAccessor)
passing this as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
get in interface TemporalAccessorget in class DefaultInterfaceTemporalAccessorfield - the field to get, not nullDateTimeException - if a value for the field cannot be obtainedArithmeticException - if numeric overflow occurspublic long getLong(TemporalField field)
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.doGet(TemporalAccessor)
passing this as the argument. Whether the value can be obtained,
and what the value represents, is determined by the field.
getLong in interface TemporalAccessorfield - the field to get, not nullDateTimeException - if a value for the field cannot be obtainedArithmeticException - if numeric overflow occurspublic ISOChrono getChrono()
The Chrono 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.
getChrono in interface ChronoLocalDate<ISOChrono>public Era<ISOChrono> getEra()
The official ISO-8601 standard does not define eras, however ISOChrono 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 ISOChrono using the == operator.
getEra in interface ChronoLocalDate<ISOChrono>getEra in class DefaultInterfaceChronoLocalDate<ISOChrono>ISOChrono era constant applicable at this date, not nullpublic int getYear()
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.
public int getMonthValue()
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().
getMonth()public Month getMonth()
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.
getMonthValue()public int getDayOfMonth()
This method returns the primitive int value for the day-of-month.
public int getDayOfYear()
This method returns the primitive int value for the day-of-year.
public DayOfWeek getDayOfWeek()
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.
public boolean isLeapYear()
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.
isLeapYear in interface ChronoLocalDate<ISOChrono>isLeapYear in class DefaultInterfaceChronoLocalDate<ISOChrono>public int lengthOfMonth()
This returns the length of the month in days. For example, a date in January would return 31.
lengthOfMonth in interface ChronoLocalDate<ISOChrono>public int lengthOfYear()
This returns the length of the year in days, either 365 or 366.
lengthOfYear in interface ChronoLocalDate<ISOChrono>lengthOfYear in class DefaultInterfaceChronoLocalDate<ISOChrono>public LocalDate with(TemporalAdjuster adjuster)
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.
with in interface ChronoLocalDate<ISOChrono>with in interface Temporalwith in class DefaultInterfaceChronoLocalDate<ISOChrono>adjuster - the adjuster to use, not nullLocalDate based on this with the adjustment made, not nullDateTimeException - if the adjustment cannot be madeArithmeticException - if numeric overflow occurspublic LocalDate with(TemporalField field, long newValue)
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.
EPOCH_MONTH -
Returns a LocalDate with the specified epoch-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.doWith(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.
with in interface ChronoLocalDate<ISOChrono>with in interface Temporalfield - the field to set in the result, not nullnewValue - the new value of the field in the resultLocalDate based on this with the specified field set, not nullDateTimeException - if the field cannot be setArithmeticException - if numeric overflow occurspublic LocalDate withYear(int year)
This instance is immutable and unaffected by this method call.
year - the year to set in the result, from MIN_YEAR to MAX_YEARLocalDate based on this date with the requested year, not nullDateTimeException - if the year value is invalidpublic LocalDate withMonth(int month)
This instance is immutable and unaffected by this method call.
month - the month-of-year to set in the result, from 1 (January) to 12 (December)LocalDate based on this date with the requested month, not nullDateTimeException - if the month-of-year value is invalidpublic LocalDate withDayOfMonth(int dayOfMonth)
This instance is immutable and unaffected by this method call.
dayOfMonth - the day-of-month to set in the result, from 1 to 28-31LocalDate based on this date with the requested day, not nullDateTimeException - if the day-of-month value is invalidDateTimeException - if the day-of-month is invalid for the month-yearpublic LocalDate withDayOfYear(int dayOfYear)
This instance is immutable and unaffected by this method call.
dayOfYear - the day-of-year to set in the result, from 1 to 365-366LocalDate based on this date with the requested day, not nullDateTimeException - if the day-of-year value is invalidDateTimeException - if the day-of-year is invalid for the yearpublic LocalDate plus(TemporalAdder adder)
This method returns a new date based on this date with the specified period added.
The adder is typically Period but may be any other type implementing
the TemporalAdder 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.
plus in interface ChronoLocalDate<ISOChrono>plus in interface Temporalplus in class DefaultInterfaceChronoLocalDate<ISOChrono>adder - the adder to use, not nullLocalDate based on this date with the addition made, not nullDateTimeException - if the addition cannot be madeArithmeticException - if numeric overflow occurspublic LocalDate plus(long amountToAdd, TemporalUnit unit)
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.
plus in interface ChronoLocalDate<ISOChrono>plus in interface TemporalamountToAdd - the amount of the unit to add to the result, may be negativeunit - the unit of the period to add, not nullLocalDate based on this date with the specified period added, not nullDateTimeException - if the unit cannot be added to this typepublic LocalDate plusYears(long yearsToAdd)
LocalDate with the specified period in years added.
This method adds the specified amount to the years field in three steps:
For example, 2008-02-29 (leap year) plus one year would result in the invalid date 2009-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2009-02-28, is selected instead.
This instance is immutable and unaffected by this method call.
yearsToAdd - the years to add, may be negativeLocalDate based on this date with the years added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDate plusMonths(long monthsToAdd)
LocalDate with the specified period in months added.
This method adds the specified amount to the months field in three steps:
For example, 2007-03-31 plus one month would result in the invalid date 2007-04-31. Instead of returning an invalid result, the last valid day of the month, 2007-04-30, is selected instead.
This instance is immutable and unaffected by this method call.
monthsToAdd - the months to add, may be negativeLocalDate based on this date with the months added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDate plusWeeks(long weeksToAdd)
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.
weeksToAdd - the weeks to add, may be negativeLocalDate based on this date with the weeks added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDate plusDays(long daysToAdd)
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.
daysToAdd - the days to add, may be negativeLocalDate based on this date with the days added, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDate minus(TemporalSubtractor subtractor)
This method returns a new date based on this date with the specified period subtracted.
The subtractor is typically Period but may be any other type implementing
the TemporalSubtractor 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.
minus in interface ChronoLocalDate<ISOChrono>minus in interface Temporalminus in class DefaultInterfaceChronoLocalDate<ISOChrono>subtractor - the subtractor to use, not nullLocalDate based on this date with the subtraction made, not nullDateTimeException - if the subtraction cannot be madeArithmeticException - if numeric overflow occurspublic LocalDate minus(long amountToSubtract, TemporalUnit unit)
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.
minus in interface ChronoLocalDate<ISOChrono>minus in interface Temporalminus in class DefaultInterfaceChronoLocalDate<ISOChrono>amountToSubtract - the amount of the unit to subtract from the result, may be negativeunit - the unit of the period to subtract, not nullLocalDate based on this date with the specified period subtracted, not nullDateTimeException - if the unit cannot be added to this typepublic LocalDate minusYears(long yearsToSubtract)
LocalDate with the specified period in years subtracted.
This method subtracts the specified amount from the years field in three steps:
For example, 2008-02-29 (leap year) minus one year would result in the invalid date 2007-02-29 (standard year). Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead.
This instance is immutable and unaffected by this method call.
yearsToSubtract - the years to subtract, may be negativeLocalDate based on this date with the years subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDate minusMonths(long monthsToSubtract)
LocalDate with the specified period in months subtracted.
This method subtracts the specified amount from the months field in three steps:
For example, 2007-03-31 minus one month would result in the invalid date 2007-02-31. Instead of returning an invalid result, the last valid day of the month, 2007-02-28, is selected instead.
This instance is immutable and unaffected by this method call.
monthsToSubtract - the months to subtract, may be negativeLocalDate based on this date with the months subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDate minusWeeks(long weeksToSubtract)
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.
weeksToSubtract - the weeks to subtract, may be negativeLocalDate based on this date with the weeks subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic LocalDate minusDays(long daysToSubtract)
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.
daysToSubtract - the days to subtract, may be negativeLocalDate based on this date with the days subtracted, not nullDateTimeException - if the result exceeds the supported date rangepublic <R> R query(TemporalQuery<R> 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.
query in interface TemporalAccessorquery in class DefaultInterfaceChronoLocalDate<ISOChrono>R - the type of the resultquery - the query to invoke, not nullDateTimeException - if unable to query (defined by the query)ArithmeticException - if numeric overflow occurs (defined by the query)public Temporal adjustInto(Temporal temporal)
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.
adjustInto in interface TemporalAdjusteradjustInto in class DefaultInterfaceChronoLocalDate<ISOChrono>temporal - the target object to be adjusted, not nullDateTimeException - if unable to make the adjustmentArithmeticException - if numeric overflow occurspublic long periodUntil(Temporal endDate, TemporalUnit 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.periodUntil(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(R, R).
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.periodUntil(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.
periodUntil in interface TemporalendDate - the end date, which must be a LocalDate, not nullunit - the unit to measure the period in, not nullDateTimeException - if the period cannot be calculatedArithmeticException - if numeric overflow occurspublic LocalDateTime atTime(LocalTime time)
This combines this date with the specified time to form a LocalDateTime.
All possible combinations of date and time are valid.
This instance is immutable and unaffected by this method call.
atTime in interface ChronoLocalDate<ISOChrono>atTime in class DefaultInterfaceChronoLocalDate<ISOChrono>time - the time to combine with, not nullpublic LocalDateTime atTime(int hour, int minute)
This combines this date with the specified time to form a LocalDateTime.
The individual time fields must be within their valid range.
All possible combinations of date and time are valid.
This instance is immutable and unaffected by this method call.
hour - the hour-of-day to use, from 0 to 23minute - the minute-of-hour to use, from 0 to 59DateTimeException - if the value of any field is out of rangepublic LocalDateTime atTime(int hour, int minute, int second)
This combines this date with the specified time to form a LocalDateTime.
The individual time fields must be within their valid range.
All possible combinations of date and time are valid.
This instance is immutable and unaffected by this method call.
hour - the hour-of-day to use, from 0 to 23minute - the minute-of-hour to use, from 0 to 59second - the second-of-minute to represent, from 0 to 59DateTimeException - if the value of any field is out of rangepublic LocalDateTime atTime(int hour, int minute, int second, int nanoOfSecond)
This combines this date with the specified time to form a LocalDateTime.
The individual time fields must be within their valid range.
All possible combinations of date and time are valid.
This instance is immutable and unaffected by this method call.
hour - the hour-of-day to use, from 0 to 23minute - the minute-of-hour to use, from 0 to 59second - the second-of-minute to represent, from 0 to 59nanoOfSecond - the nano-of-second to represent, from 0 to 999,999,999DateTimeException - if the value of any field is out of rangepublic OffsetDate atOffset(ZoneOffset offset)
This combines this date with the specified offset to form an OffsetDate.
All possible combinations of date and offset are valid.
This instance is immutable and unaffected by this method call.
offset - the offset to combine with, not nullpublic ZonedDateTime atStartOfDay(ZoneId 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).
This instance is immutable and unaffected by this method call.
zone - the zone ID to use, not nullpublic long toEpochDay()
ChronoLocalDate
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.
toEpochDay in interface ChronoLocalDate<ISOChrono>toEpochDay in class DefaultInterfaceChronoLocalDate<ISOChrono>public int compareTo(ChronoLocalDate<?> other)
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.temporal.ChronoLocalDate<?>).
compareTo in interface Comparable<ChronoLocalDate<?>>compareTo in interface ChronoLocalDate<ISOChrono>compareTo in class DefaultInterfaceChronoLocalDate<ISOChrono>other - the other date to compare to, not nullpublic boolean isAfter(ChronoLocalDate<?> other)
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.
isAfter in interface ChronoLocalDate<ISOChrono>isAfter in class DefaultInterfaceChronoLocalDate<ISOChrono>other - the other date to compare to, not nullpublic boolean isBefore(ChronoLocalDate<?> other)
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.
isBefore in interface ChronoLocalDate<ISOChrono>isBefore in class DefaultInterfaceChronoLocalDate<ISOChrono>other - the other date to compare to, not nullpublic boolean isEqual(ChronoLocalDate<?> other)
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.
isEqual in interface ChronoLocalDate<ISOChrono>isEqual in class DefaultInterfaceChronoLocalDate<ISOChrono>other - the other date to compare to, not nullpublic boolean equals(Object obj)
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.
equals in interface ChronoLocalDate<ISOChrono>equals in class DefaultInterfaceChronoLocalDate<ISOChrono>obj - the object to check, null returns falsepublic int hashCode()
hashCode in interface ChronoLocalDate<ISOChrono>hashCode in class DefaultInterfaceChronoLocalDate<ISOChrono>public String toString()
String, such as 2007-12-03.
The output will be in the ISO-8601 format yyyy-MM-dd.
toString in interface ChronoLocalDate<ISOChrono>toString in class DefaultInterfaceChronoLocalDate<ISOChrono>public String toString(DateTimeFormatter formatter)
String using the formatter.
This date will be passed to the formatter
print method.
toString in interface ChronoLocalDate<ISOChrono>toString in class DefaultInterfaceChronoLocalDate<ISOChrono>formatter - the formatter to use, not nullDateTimeException - if an error occurs during printingCopyright © 2007-2013 ThreeTen.org. All Rights Reserved.