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.
temporal | the target object to be adjusted, not null |
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.
time | the time to combine with, not null |
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 java.time.chrono.ChronoLocalDate.compareTo.
other | the other date to compare to, not null |
Formats this date using the specified formatter.
This date will be passed to the formatter to produce a string.
formatter | the formatter to use, not null |
Gets the value of the specified field from this date as an int.
This queries this date for the value of 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 PROLEPTIC_MONTH
which are too large to fit in an int and throw an UnsupportedTemporalTypeException.
All other ChronoField instances will throw an UnsupportedTemporalTypeException.
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.
field | the field to get, not null |
Gets the chronology of this date, which is the ISO calendar system.
The Chronology represents the calendar system in use.
The ISO-8601 calendar system is the modern civil calendar system used today
in most of the world. It is equivalent to the proleptic Gregorian calendar
system, in which today's rules for leap years are applied for all time.
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.
Gets the value of the specified field from this date as a long.
This queries this date for the value of 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 an UnsupportedTemporalTypeException.
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.
field | the field to get, not null |
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.timeLineOrder().
other | the other date to compare to, not null |
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.timeLineOrder().
other | the other date to compare to, not null |
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.timeLineOrder().
other | the other date to compare to, not null |
Checks if the year is a leap year, according to the ISO proleptic calendar system rules.
This method applies the current rules for leap years across the whole time-line. In general, a year is a leap year if it is divisible by four without remainder. However, years divisible by 100, are not leap years, with the exception of years divisible by 400 which are.
For example, 1904 is a leap year it is divisible by 4. 1900 was not a leap year as it is divisible by 100, however 2000 was a leap year as it is divisible by 400.
The calculation is proleptic - applying the same rules into the far future and far past. This is historically inaccurate, but is correct for the ISO-8601 standard.
Checks if the specified field is supported.
This checks if this date can be queried for the specified field.
If false, then calling the range,
get and with(TemporalField, long)
methods will throw an exception.
If the field is a ChronoField then the query is implemented here.
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
PROLEPTIC_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.isSupportedBy(TemporalAccessor)
passing this as the argument.
Whether the field is supported is determined by the field.
field | the field to check, null returns false |
Checks if the specified unit is supported.
This checks if the specified unit can be added to, or subtracted from, this date.
If false, then calling the plus(long, TemporalUnit) and
minus methods will throw an exception.
If the unit is a ChronoUnit then the query is implemented here.
The supported units are:
DAYS
WEEKS
MONTHS
YEARS
DECADES
CENTURIES
MILLENNIA
ERAS
ChronoUnit instances will return false.
If the unit is not a ChronoUnit, then the result of this method
is obtained by invoking TemporalUnit.isSupportedBy(Temporal)
passing this as the argument.
Whether the unit is supported is determined by the unit.
unit | the unit to check, null returns false |
Returns the length of the month represented by this date.
This returns the length of the month in days. For example, a date in January would return 31.
Returns the length of the year represented by this date.
This returns the length of the year in days, either 365 or 366.
Returns a copy of this date with the specified amount subtracted.
This returns a LocalDate, based on this one, with the specified amount subtracted.
The amount is typically Period but may be any other type implementing
the TemporalAmount interface.
The calculation is delegated to the amount object by calling
TemporalAmount.subtractFrom(Temporal). The amount implementation is free
to implement the subtraction in any way it wishes, however it typically
calls back to minus(long, TemporalUnit). Consult the documentation
of the amount implementation to determine if it can be successfully subtracted.
This instance is immutable and unaffected by this method call.
amountToSubtract | the amount to subtract, not null |
LocalDate based on this date with the subtraction made, not null
Returns a copy of this date with the specified amount subtracted.
This returns a LocalDate, based on this one, with the amount
in terms of the unit subtracted. If it is not possible to subtract the amount,
because the unit is not supported or for some other reason, an exception is thrown.
This method is equivalent to plus(long, TemporalUnit) with the amount negated.
See that method for a full description of how addition, and thus subtraction, works.
This instance is immutable and unaffected by this method call.
amountToSubtract | the amount of the unit to subtract from the result, may be negative | |
unit | the unit of the amount to subtract, not null |
LocalDate based on this date with the specified amount subtracted, not null
Returns a copy of this date with the specified amount added.
This returns a LocalDate, based on this one, with the specified amount added.
The amount is typically Period but may be any other type implementing
the TemporalAmount interface.
The calculation is delegated to the amount object by calling
TemporalAmount.addTo(Temporal). The amount implementation is free
to implement the addition in any way it wishes, however it typically
calls back to plus(long, TemporalUnit). Consult the documentation
of the amount implementation to determine if it can be successfully added.
This instance is immutable and unaffected by this method call.
amountToAdd | the amount to add, not null |
LocalDate based on this date with the addition made, not null
Returns a copy of this date with the specified amount added.
This returns a LocalDate, based on this one, with the amount
in terms of the unit added. If it is not possible to add the amount, because the
unit is not supported or for some other reason, an exception is thrown.
In some cases, adding the amount can cause the resulting date to become invalid. For example, adding one month to 31st January would result in 31st February. In cases like this, the unit 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 ChronoUnit then the addition is implemented here.
The supported fields behave as follows:
DAYS -
Returns a LocalDate with the specified number of days added.
This is equivalent to plusDays(long).
WEEKS -
Returns a LocalDate with the specified number of weeks added.
This is equivalent to plusWeeks(long) and uses a 7 day week.
MONTHS -
Returns a LocalDate with the specified number of months added.
This is equivalent to plusMonths(long).
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.
YEARS -
Returns a LocalDate with the specified number of years added.
This is equivalent to plusYears(long).
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.
DECADES -
Returns a LocalDate with the specified number of decades added.
This is equivalent to calling plusYears(long) with the amount
multiplied by 10.
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.
CENTURIES -
Returns a LocalDate with the specified number of centuries added.
This is equivalent to calling plusYears(long) with the amount
multiplied by 100.
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.
MILLENNIA -
Returns a LocalDate with the specified number of millennia added.
This is equivalent to calling plusYears(long) with the amount
multiplied by 1,000.
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.
ERAS -
Returns a LocalDate with the specified number of eras added.
Only two eras are supported so the amount must be one, zero or minus one.
If the amount is non-zero then the year is changed such that the year-of-era
is unchanged.
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.
All other ChronoUnit instances will throw an UnsupportedTemporalTypeException.
If the field is not a ChronoUnit, then the result of this method
is obtained by invoking TemporalUnit.addTo(Temporal, long)
passing this as the argument. In this case, the unit determines
whether and how to perform the addition.
This instance is immutable and unaffected by this method call.
amountToAdd | the amount of the unit to add to the result, may be negative | |
unit | the unit of the amount to add, not null |
LocalDate based on this date with the specified amount added, not null
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.
query | the query to invoke, not null |
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 an UnsupportedTemporalTypeException.
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.
field | the field to query the range for, not null |
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.
This default implementation queries the EPOCH_DAY field.
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 negative sign will be the same in each of year, month and day.
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".
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.
endDateExclusive | the end date, exclusive, which may be in any chronology, not null |
Calculates the amount of time until another date in terms of the specified unit.
This calculates the amount of time between two LocalDate
objects in terms of a single TemporalUnit.
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 is converted to a
LocalDate using from(TemporalAccessor).
For example, the amount 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 amount in months between 2012-06-15 and 2012-08-14 will only be one month as it is one day short of two months.
There are two equivalent ways of using this method.
The first is to invoke this method.
The second is to use TemporalUnit.between(Temporal, Temporal):
// these two lines are equivalent amount = start.until(end, MONTHS); amount = MONTHS.between(start, end);The choice should be made based on which makes the code more readable.
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 converted input temporal
as the second argument.
This instance is immutable and unaffected by this method call.
endExclusive | the end date, exclusive, which is converted to a LocalDate, not null | |
unit | the unit to measure the amount in, not null |
Returns an adjusted copy of this date.
This returns a 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 java.time.Month.*; import static java.time.temporal.TemporalAdjusters.*; 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.
adjuster | the adjuster to use, not null |
LocalDate based on this with the adjustment made, not null
Returns a copy of this date with the specified field set to a new value.
This returns a 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 an UnsupportedTemporalTypeException.
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.
field | the field to set in the result, not null | |
newValue | the new value of the field in the result |
LocalDate based on this with the specified field set, not null
Diagram: LocalDate