Serializable
, Comparable<ChronoLocalDate>
, ChronoLocalDate
, Temporal
, TemporalAccessor
, TemporalAdjuster
public final class LocalDate extends Object implements Temporal, TemporalAdjuster, ChronoLocalDate, 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.
This is a value-based class; programmers should treat instances that are equal as interchangeable and should not use instances for synchronization, or unpredictable behavior may occur. For example, in a future release, synchronization may fail. The equals
method should be used for comparisons.
Modifier and Type | Field | Description |
---|---|---|
static final LocalDate |
EPOCH |
The epoch year LocalDate , '1970-01-01'. |
static final LocalDate |
MAX |
The maximum supported LocalDate , '+999999999-12-31'. |
static final LocalDate |
MIN |
The minimum supported LocalDate , '-999999999-01-01'. |
Modifier and Type | Method | Description |
---|---|---|
Temporal |
adjustInto |
Adjusts the specified temporal object to have the same date as this object. |
LocalDateTime |
atStartOfDay() |
Combines this date with the time of midnight to create a LocalDateTime at the start of this date. |
ZonedDateTime |
atStartOfDay |
Returns a zoned date-time from this date at the earliest valid time according to the rules in the time-zone. |
LocalDateTime |
atTime |
Combines this date with a time to create a LocalDateTime . |
LocalDateTime |
atTime |
Combines this date with a time to create a LocalDateTime . |
LocalDateTime |
atTime |
Combines this date with a time to create a LocalDateTime . |
LocalDateTime |
atTime |
Combines this date with a time to create a LocalDateTime . |
OffsetDateTime |
atTime |
Combines this date with an offset time to create an OffsetDateTime . |
int |
compareTo |
Compares this date to another date. |
Stream |
datesUntil |
Returns a sequential ordered stream of dates. |
Stream |
datesUntil |
Returns a sequential ordered stream of dates by given incremental step. |
boolean |
equals |
Checks if this date is equal to another date. |
String |
format |
Formats this date using the specified formatter. |
static LocalDate |
from |
Obtains an instance of LocalDate from a temporal object. |
int |
get |
Gets the value of the specified field from this date as an int . |
IsoChronology |
getChronology() |
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. |
IsoEra |
getEra() |
Gets the era applicable at this date. |
long |
getLong |
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 |
Checks if this date is after the specified date. |
boolean |
isBefore |
Checks if this date is before the specified date. |
boolean |
isEqual |
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 |
Checks if the specified field is supported. |
boolean |
isSupported |
Checks if the specified unit 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 |
Returns a copy of this date with the specified amount subtracted. |
LocalDate |
minus |
Returns a copy of this date with the specified amount subtracted. |
LocalDate |
minusDays |
Returns a copy of this LocalDate with the specified number of days subtracted. |
LocalDate |
minusMonths |
Returns a copy of this LocalDate with the specified number of months subtracted. |
LocalDate |
minusWeeks |
Returns a copy of this LocalDate with the specified number of weeks subtracted. |
LocalDate |
minusYears |
Returns a copy of this LocalDate with the specified number of years subtracted. |
static LocalDate |
now() |
Obtains the current date from the system clock in the default time-zone. |
static LocalDate |
now |
Obtains the current date from the specified clock. |
static LocalDate |
now |
Obtains the current date from the system clock in the specified time-zone. |
static LocalDate |
of |
Obtains an instance of LocalDate from a year, month and day. |
static LocalDate |
of |
Obtains an instance of LocalDate from a year, month and day. |
static LocalDate |
ofEpochDay |
Obtains an instance of LocalDate from the epoch day count. |
static LocalDate |
ofInstant |
Obtains an instance of LocalDate from an Instant and zone ID. |
static LocalDate |
ofYearDay |
Obtains an instance of LocalDate from a year and day-of-year. |
static LocalDate |
parse |
Obtains an instance of LocalDate from a text string such as 2007-12-03 . |
static LocalDate |
parse |
Obtains an instance of LocalDate from a text string using a specific formatter. |
LocalDate |
plus |
Returns a copy of this date with the specified amount added. |
LocalDate |
plus |
Returns a copy of this date with the specified amount added. |
LocalDate |
plusDays |
Returns a copy of this LocalDate with the specified number of days added. |
LocalDate |
plusMonths |
Returns a copy of this LocalDate with the specified number of months added. |
LocalDate |
plusWeeks |
Returns a copy of this LocalDate with the specified number of weeks added. |
LocalDate |
plusYears |
Returns a copy of this LocalDate with the specified number of years added. |
<R> R |
query |
Queries this date using the specified query. |
ValueRange |
range |
Gets the range of valid values for the specified field. |
long |
toEpochSecond |
Converts this LocalDate to the number of seconds since the epoch of 1970-01-01T00:00:00Z. |
String |
toString() |
Outputs this date as a String , such as 2007-12-03 . |
Period |
until |
Calculates the period between this date and another date as a Period . |
long |
until |
Calculates the amount of time until another date in terms of the specified unit. |
LocalDate |
with |
Returns an adjusted copy of this date. |
LocalDate |
with |
Returns a copy of this date with the specified field set to a new value. |
LocalDate |
withDayOfMonth |
Returns a copy of this LocalDate with the day-of-month altered. |
LocalDate |
withDayOfYear |
Returns a copy of this LocalDate with the day-of-year altered. |
LocalDate |
withMonth |
Returns a copy of this LocalDate with the month-of-year altered. |
LocalDate |
withYear |
Returns a copy of this LocalDate with the year altered. |
clone, finalize, getClass, notify, notifyAll, wait, wait, wait
toEpochDay
public static final LocalDate MIN
LocalDate
, '-999999999-01-01'. This could be used by an application as a "far past" date.public static final LocalDate MAX
LocalDate
, '+999999999-12-31'. This could be used by an application as a "far future" date.public static final LocalDate EPOCH
LocalDate
, '1970-01-01'.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. This returns a LocalDate
with the specified year, month and day-of-month. The day must be valid for the year and month, otherwise an exception will be thrown.
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 range, or 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. This returns a LocalDate
with the specified year, month and day-of-month. The day must be valid for the year and month, otherwise an exception will be thrown.
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 range, or 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. This returns a LocalDate
with the specified year and day-of-year. The day-of-year must be valid for the year, otherwise an exception will be thrown.
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 range, or if the day-of-year is invalid for the yearpublic static LocalDate ofInstant(Instant instant, ZoneId zone)
LocalDate
from an Instant
and zone ID. This creates a local date based on the specified instant. First, the offset from UTC/Greenwich is obtained using the zone ID and instant, which is simple as there is only one valid offset for each instant. Then, the instant and offset are used to calculate the local date.
instant
- the instant to create the date from, not nullzone
- the time-zone, which may be an offset, not nullDateTimeException
- if the result exceeds the supported rangepublic static LocalDate ofEpochDay(long epochDay)
LocalDate
from the epoch day count. This returns a LocalDate
with the specified epoch-day. The EPOCH_DAY
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 day exceeds the supported date rangepublic static LocalDate from(TemporalAccessor temporal)
LocalDate
from a temporal object. This obtains a local date based on the specified temporal. A TemporalAccessor
represents an arbitrary set of date and time information, which this factory converts 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
.
temporal
- the temporal object to convert, not nullDateTimeException
- if unable to convert to a LocalDate
public 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 DateTimeFormatter.ISO_LOCAL_DATE
.
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
, 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.
isSupported
in interface ChronoLocalDate
isSupported
in interface TemporalAccessor
field
- the field to check, null returns falsepublic boolean isSupported(TemporalUnit unit)
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.
isSupported
in interface ChronoLocalDate
isSupported
in interface Temporal
unit
- the unit 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 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.
range
in interface TemporalAccessor
field
- the field to query the range for, not nullDateTimeException
- if the range for the field cannot be obtainedUnsupportedTemporalTypeException
- if the field is not supportedpublic int get(TemporalField field)
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.
get
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtained or the value is outside the range of valid values for the fieldUnsupportedTemporalTypeException
- if the field is not supported or the range of values exceeds an int
ArithmeticException
- if numeric overflow occurspublic long getLong(TemporalField field)
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.
getLong
in interface TemporalAccessor
field
- the field to get, not nullDateTimeException
- if a value for the field cannot be obtainedUnsupportedTemporalTypeException
- if the field is not supportedArithmeticException
- if numeric overflow occurspublic IsoChronology getChronology()
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.
getChronology
in interface ChronoLocalDate
public IsoEra getEra()
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.
getEra
in interface ChronoLocalDate
public 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()
.
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
.
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
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
public int lengthOfYear()
This returns the length of the year in days, either 365 or 366.
lengthOfYear
in interface ChronoLocalDate
public LocalDate with(TemporalAdjuster adjuster)
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.
with
in interface ChronoLocalDate
with
in interface Temporal
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 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.
with
in interface ChronoLocalDate
with
in interface Temporal
field
- 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 setUnsupportedTemporalTypeException
- if the field is not supportedArithmeticException
- if numeric overflow occurspublic LocalDate withYear(int year)
LocalDate
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.
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)
LocalDate
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.
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)
LocalDate
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.
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 invalid, or if the day-of-month is invalid for the month-yearpublic LocalDate withDayOfYear(int dayOfYear)
LocalDate
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.
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 invalid, or if the day-of-year is invalid for the yearpublic LocalDate plus(TemporalAmount amountToAdd)
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.
plus
in interface ChronoLocalDate
plus
in interface Temporal
amountToAdd
- the amount to add, 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 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.
plus
in interface ChronoLocalDate
plus
in interface Temporal
amountToAdd
- the amount of the unit to add to the result, may be negativeunit
- the unit of the amount to add, not nullLocalDate
based on this date with the specified amount added, not nullDateTimeException
- if the addition cannot be madeUnsupportedTemporalTypeException
- if the unit is not supportedArithmeticException
- if numeric overflow occurspublic LocalDate plusYears(long yearsToAdd)
LocalDate
with the specified number of 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 number of 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 number of 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(TemporalAmount amountToSubtract)
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.
minus
in interface ChronoLocalDate
minus
in interface Temporal
amountToSubtract
- the amount to subtract, 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 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.
minus
in interface ChronoLocalDate
minus
in interface Temporal
amountToSubtract
- the amount of the unit to subtract from the result, may be negativeunit
- the unit of the amount to subtract, not nullLocalDate
based on this date with the specified amount subtracted, not nullDateTimeException
- if the subtraction cannot be madeUnsupportedTemporalTypeException
- if the unit is not supportedArithmeticException
- if numeric overflow occurspublic LocalDate minusYears(long yearsToSubtract)
LocalDate
with the specified number of 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 number of 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 number of 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 ChronoLocalDate
query
in interface TemporalAccessor
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 ChronoLocalDate
adjustInto
in interface TemporalAdjuster
temporal
- the target object to be adjusted, not nullDateTimeException
- if unable to make the adjustmentArithmeticException
- if numeric overflow occurspublic long until(Temporal endExclusive, TemporalUnit 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.
until
in interface ChronoLocalDate
until
in interface Temporal
endExclusive
- the end date, exclusive, which is converted to a LocalDate
, not nullunit
- the unit to measure the amount in, not nullDateTimeException
- if the amount cannot be calculated, or the end temporal cannot be converted to a LocalDate
UnsupportedTemporalTypeException
- if the unit is not supportedArithmeticException
- if numeric overflow occurspublic Period until(ChronoLocalDate endDateExclusive)
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.
until
in interface ChronoLocalDate
endDateExclusive
- the end date, exclusive, which may be in any chronology, not nullpublic Stream<LocalDate> datesUntil(LocalDate endExclusive)
endExclusive
(exclusive) by an incremental step of 1 day. This method is equivalent to datesUntil(endExclusive, Period.ofDays(1))
.
endExclusive
- the end date, exclusive, not nullStream
for the range of LocalDate
valuesIllegalArgumentException
- if end date is before this datepublic Stream<LocalDate> datesUntil(LocalDate endExclusive, Period step)
endExclusive
(exclusive). The n-th date which appears in the stream is equal to this.plus(step.multipliedBy(n))
(but the result of step multiplication never overflows). For example, if this date is 2015-01-31
, the end date is 2015-05-01
and the step is 1 month, then the stream contains 2015-01-31
, 2015-02-28
, 2015-03-31
, and 2015-04-30
.
endExclusive
- the end date, exclusive, not nullstep
- the non-zero, non-negative Period
which represents the step.Stream
for the range of LocalDate
valuesIllegalArgumentException
- if step is zero, or step.getDays()
and step.toTotalMonths()
have opposite sign, or end date is before this date and step is positive, or end date is after this date and step is negativepublic String format(DateTimeFormatter formatter)
This date will be passed to the formatter to produce a string.
format
in interface ChronoLocalDate
formatter
- the formatter to use, not nullDateTimeException
- if an error occurs during printingpublic LocalDateTime atTime(LocalTime time)
LocalDateTime
. This returns a LocalDateTime
formed from this date at the specified time. All possible combinations of date and time are valid.
atTime
in interface ChronoLocalDate
time
- the time to combine with, not nullpublic LocalDateTime atTime(int hour, int minute)
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.
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)
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.
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)
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.
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 OffsetDateTime atTime(OffsetTime time)
OffsetDateTime
. This returns an OffsetDateTime
formed from this date at the specified time. All possible combinations of date and time are valid.
time
- the time to combine with, not nullpublic LocalDateTime atStartOfDay()
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.
public 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)
.
zone
- the zone ID to use, not nullpublic long toEpochSecond(LocalTime time, ZoneOffset offset)
LocalDate
to the number of seconds since the epoch of 1970-01-01T00:00:00Z. This combines this local date with the specified time and offset to calculate the epoch-second value, which is the number of elapsed seconds from 1970-01-01T00:00:00Z. Instants on the time-line after the epoch are positive, earlier are negative.
time
- the local time, not nulloffset
- the zone offset, not nullpublic 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(java.time.chrono.ChronoLocalDate)
.
compareTo
in interface ChronoLocalDate
compareTo
in interface Comparable<ChronoLocalDate>
other
- the other date to compare to, not nullother
local date and this chronology with the other
chronology, in order, returning the first non-zero result, and otherwise returning zeropublic 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.timeLineOrder()
.
isAfter
in interface ChronoLocalDate
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.timeLineOrder()
.
isBefore
in interface ChronoLocalDate
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.timeLineOrder()
.
isEqual
in interface ChronoLocalDate
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
equals
in class Object
obj
- the object to check, null returns falsepublic int hashCode()
hashCode
in interface ChronoLocalDate
hashCode
in class Object
public String toString()
String
, such as 2007-12-03
. The output will be in the ISO-8601 format uuuu-MM-dd
.
toString
in interface ChronoLocalDate
toString
in class Object
© 1993, 2023, Oracle and/or its affiliates. All rights reserved.
Documentation extracted from Debian's OpenJDK Development Kit package.
Licensed under the GNU General Public License, version 2, with the Classpath Exception.
Various third party code in OpenJDK is licensed under different licenses (see Debian package).
Java and OpenJDK are trademarks or registered trademarks of Oracle and/or its affiliates.
https://docs.oracle.com/en/java/javase/21/docs/api/java.base/java/time/LocalDate.html