Gets the chronology of this date.
Gets the chronology of this date.
The Chronology represents the calendar system in use.
The era and other fields in ChronoField are defined by the chronology.
the chronology, not null
Gets the value of the specified field as a long.
Gets the value of the specified field as a long.
This queries the date-time for the value for the specified field. The returned value may be outside the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.
Implementations must check and handle all fields defined in ChronoField.
If the field is supported, then the value of the field must be returned.
If unsupported, then a DateTimeException must be thrown.
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.
Implementations must not alter either this object.
the field to get, not null
the value for the field
if numeric overflow occurs
DateTimeExceptionif a value for the field cannot be obtained
Returns the length of the month represented by this date, as defined by the calendar system.
Returns the length of the month represented by this date, as defined by the calendar system.
This returns the length of the month in days.
the length of the month in days
Returns an object of the same type as this object with the specified field altered.
Returns an object of the same type as this object with the specified field altered.
This returns a new object based on this one with the value for the specified field changed.
For example, on a LocalDate, this could be used to set the year, month or day-of-month.
The returned object will have the same observable type as this object.
In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then changing the month to February would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
Implementations must check and handle all fields defined in ChronoField.
If the field is supported, then the adjustment must be performed.
If unsupported, then a DateTimeException must be thrown.
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 first argument.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
the field to set in the result, not null
the new value of the field in the result
an object of the same type with the specified field set, not null
if numeric overflow occurs
DateTimeExceptionif the field cannot be set
Adjusts the specified temporal object.
Adjusts the specified temporal object.
This adjusts the specified temporal object using the logic encapsulated in the implementing class. Examples might be an adjuster that sets the date avoiding weekends, or one that sets the date to the last day of the month.
There are two equivalent ways of using this method.
The first is to invoke this method directly.
The second is to use Temporal#with(TemporalAdjuster):
// these two lines are equivalent, but the second approach is recommended temporal = thisAdjuster.adjustInto(temporal); temporal = temporal.with(thisAdjuster);It is recommended to use the second approach,
with(TemporalAdjuster),
as it is a lot clearer to read in code.The implementation must take the input object and adjust it.
The implementation defines the logic of the adjustment and is responsible for
documenting that logic. It may use any method on Temporal to
query the temporal object and perform the adjustment.
The returned object must have the same observable type as the input object
The input object must not be altered. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable temporal objects.
The input temporal object may be in a calendar system other than ISO.
Implementations may choose to document compatibility with other calendar systems,
or reject non-ISO temporal objects by TemporalQueries#chronology() querying the chronology.
This method may be called from multiple threads in parallel. It must be thread-safe when invoked.
the temporal object to adjust, not null
an object of the same observable type with the adjustment made, not null
if numeric overflow occurs
DateTimeExceptionif unable to make the adjustment
Combines this date with a time to create a ChronoLocalDateTime.
Combines this date with a time to create a ChronoLocalDateTime.
This returns a ChronoLocalDateTime formed from this date at the specified time.
All possible combinations of date and time are valid.
the local time to use, not null
the local date-time formed from this date and the specified time, not null
Compares this date to another date, including the chronology.
Compares this date to another date, including the chronology.
The comparison is based first on the underlying time-line date, then
on the chronology.
It is "consistent with equals", as defined by Comparable.
For example, the following is the comparator order:
2012-12-03 (ISO) 2012-12-04 (ISO) 2555-12-04 (ThaiBuddhist) 2012-12-05 (ISO)Values #2 and #3 represent the same date on the time-line. When two values represent the same date, the chronology ID is compared to distinguish them. This step is needed to make the ordering "consistent with equals".
If all the date objects being compared are in the same chronology, then the
additional chronology stage is not required and only the local date is used.
To compare the dates of two TemporalAccessor instances, including dates
in two different chronologies, use ChronoField#EPOCH_DAY as a comparator.
the other date to compare to, not null
the comparator value, negative if less, positive if greater
Checks if this date is equal to another date, including the chronology.
Checks if this date is equal to another date, including the chronology.
Compares this date with another ensuring that the date and chronology are the same.
To compare the dates of two TemporalAccessor instances, including dates
in two different chronologies, use ChronoField#EPOCH_DAY as a comparator.
the object to check, null returns false
true if this is equal to the other date
Formats this date using the specified formatter.
Formats this date using the specified formatter.
This date will be passed to the formatter to produce a string.
The default implementation must behave as follows:
return formatter.format(this);
the formatter to use, not null
the formatted date string, not null
if an error occurs during printing
Gets the value of the specified field as an int.
Gets the value of the specified field as an int.
This queries the date-time for the value for the specified field. The returned value will always be within the valid range of values for the field. If the date-time cannot return the value, because the field is unsupported or for some other reason, an exception will be thrown.
Implementations must check and handle all fields defined in ChronoField.
If the field is supported and has an int range, then the value of
the field must be returned.
If unsupported, then a DateTimeException must be thrown.
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.
Implementations must not alter either this object.
the field to get, not null
the value for the field, within the valid range of values
if numeric overflow occurs
DateTimeExceptionif the value is outside the range of valid values for the field
Gets the era, as defined by the chronology.
Gets the era, as defined by the chronology.
The era is, conceptually, the largest division of the time-line.
Most calendar systems have a single epoch dividing the time-line into two eras.
However, some have multiple eras, such as one for the reign of each leader.
The exact meaning is determined by the Chronology.
All correctly implemented Era classes are singletons, thus it
is valid code to write date.getEra() == SomeEra.NAME).
the chronology specific era constant applicable at this date, not null
A hash code for this date.
A hash code for this date.
a suitable hash code
Checks if this date is after the specified date ignoring the chronology.
Checks if this date is after the specified date ignoring the chronology.
This method differs from the comparison in #compareTo in that it
only compares the underlying date and not the chronology.
This allows dates in different calendar systems to be compared based
on the time-line position.
This is equivalent to using date1.toEpochDay() > date2.toEpochDay().
the other date to compare to, not null
true if this is after the specified date
Checks if this date is before the specified date ignoring the chronology.
Checks if this date is before the specified date ignoring the chronology.
This method differs from the comparison in #compareTo in that it
only compares the underlying date and not the chronology.
This allows dates in different calendar systems to be compared based
on the time-line position.
This is equivalent to using date1.toEpochDay() < date2.toEpochDay().
the other date to compare to, not null
true if this is before the specified date
Checks if this date is equal to the specified date ignoring the chronology.
Checks if this date is equal to the specified date ignoring the chronology.
This method differs from the comparison in #compareTo in that it
only compares the underlying date and not the chronology.
This allows dates in different calendar systems to be compared based
on the time-line position.
This is equivalent to using date1.toEpochDay() == date2.toEpochDay().
the other date to compare to, not null
true if the underlying date is equal to the specified date
Checks if the year is a leap year, as defined by the calendar system.
Checks if the year is a leap year, as defined by the calendar system.
A leap-year is a year of a longer length than normal. The exact meaning is determined by the chronology with the constraint that a leap-year must imply a year-length longer than a non leap-year.
The default implementation uses Chronology#isLeapYear(long).
true if this date is in a leap year, false otherwise
Checks if the specified unit is supported.
Checks if the specified unit is supported.
This checks if the date-time can be queried for the specified unit.
If false, then calling the #plus(TemporalAmount) plus and #minus(TemporalAmount) minus
methods will throw an exception.
Implementations must check and handle all fields defined in ChronoUnit.
If the field is supported, then true is returned, otherwise false
If the field is not a ChronoUnit, then the result of this method
is obtained by invoking TemporalUnit.isSupportedBy(Temporal)
passing this as the argument.
Implementations must not alter this object.
the unit to check, null returns false
true if this date-time can be queried for the unit, false if not
Checks if the specified field is supported.
Checks if the specified field is supported.
This checks if the date-time can be queried for the specified field.
If false, then calling the #range(TemporalField) range and #get(TemporalField) get
methods will throw an exception.
Implementations must check and handle all fields defined in ChronoField.
If the field is supported, then true is returned, otherwise 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.
Implementations must not alter this object.
the field to check, null returns false
true if this date-time can be queried for the field, false if not
Returns the length of the year represented by this date, as defined by the calendar system.
Returns the length of the year represented by this date, as defined by the calendar system.
This returns the length of the year in days.
The default implementation uses #isLeapYear() and returns 365 or 366.
the length of the year in days
Returns an object of the same type as this object with the specified period subtracted.
Returns an object of the same type as this object with the specified period subtracted.
This method returns a new object based on this one with the specified period subtracted.
For example, on a LocalDate, this could be used to subtract a number of years, months or days.
The returned object will have the same observable type as this object.
In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st March, then subtracting one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
If the implementation represents a date-time that has boundaries, such as LocalTime,
then the permitted units must include the boundary unit, but no multiples of the boundary unit.
For example, LocalTime must accept DAYS but not WEEKS or MONTHS.
Implementations must behave in a manor equivalent to the default method behavior.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
the amount of the specified unit to subtract, may be negative
the unit of the period to subtract, not null
an object of the same type with the specified period subtracted, not null
if numeric overflow occurs
DateTimeExceptionif the unit cannot be subtracted
Returns an object of the same type as this object with an amount subtracted.
Returns an object of the same type as this object with an amount subtracted.
This adjusts this temporal, subtracting according to the rules of the specified amount.
The amount is typically a Period but may be any other type implementing
the TemporalAmount interface, such as Duration.
Some example code indicating how and why this method is used:
date = date.minus(period); // subtract a Period instance date = date.minus(duration); // subtract a Duration instance date = date.minus(workingDays(6)); // example user-written workingDays method
Note that calling plus followed by minus is not guaranteed to
return the same date-time.
Implementations must not alter either this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
the amount to subtract, not null
an object of the same type with the specified adjustment made, not null
if numeric overflow occurs
DateTimeExceptionif the subtraction cannot be made
Returns an object of the same type as this object with the specified period added.
Returns an object of the same type as this object with the specified period added.
This method returns a new object based on this one with the specified period added.
For example, on a LocalDate, this could be used to add a number of years, months or days.
The returned object will have the same observable type as this object.
In some cases, changing a field is not fully defined. For example, if the target object is a date representing the 31st January, then adding one month would be unclear. In cases like this, the field is responsible for resolving the result. Typically it will choose the previous valid date, which would be the last valid day of February in this example.
If the implementation represents a date-time that has boundaries, such as LocalTime,
then the permitted units must include the boundary unit, but no multiples of the boundary unit.
For example, LocalTime must accept DAYS but not WEEKS or MONTHS.
Implementations must check and handle all units defined in ChronoUnit.
If the unit is supported, then the addition must be performed.
If unsupported, then a DateTimeException must be thrown.
If the unit is not a ChronoUnit, then the result of this method
is obtained by invoking TemporalUnit.addTo(Temporal, long)
passing this as the first argument.
Implementations must not alter either this object or the specified temporal object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
the amount of the specified unit to add, may be negative
the unit of the period to add, not null
an object of the same type with the specified period added, not null
if numeric overflow occurs
DateTimeExceptionif the unit cannot be added
Returns an object of the same type as this object with an amount added.
Returns an object of the same type as this object with an amount added.
This adjusts this temporal, adding according to the rules of the specified amount.
The amount is typically a Period but may be any other type implementing
the TemporalAmount interface, such as Duration.
Some example code indicating how and why this method is used:
date = date.plus(period); // add a Period instance date = date.plus(duration); // add a Duration instance date = date.plus(workingDays(6)); // example user-written workingDays method
Note that calling plus followed by minus is not guaranteed to
return the same date-time.
Implementations must not alter either this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
the amount to add, not null
an object of the same type with the specified adjustment made, not null
if numeric overflow occurs
DateTimeExceptionif the addition cannot be made
Queries this date-time.
Queries this date-time.
This queries this date-time using the specified query strategy object.
Queries are a key tool for extracting information from date-times. They exists to externalize the process of querying, permitting different approaches, as per the strategy design pattern. Examples might be a query that checks if the date is the day before February 29th in a leap year, or calculates the number of days to your next birthday.
The most common query implementations are method references, such as
LocalDate::from and ZoneId::from.
Further implementations are on TemporalQueries.
Queries may also be defined by applications.
Implementations of this method must behave as follows:
public <R> R query(TemporalQuery<R> type) {
// only include an if statement if the implementation can return it
if (query == TemporalQueries.zoneId()) return // the ZoneId
if (query == TemporalQueries.chronology()) return // the Chrono
if (query == TemporalQueries.precision()) return // the precision
// call default method
return super.query(query);
}
the type of the result
the query to invoke, not null
the query result, null may be returned (defined by the query)
if numeric overflow occurs
DateTimeExceptionif unable to query
Gets the range of valid values for the specified field.
Gets the range of valid values for the specified field.
All fields can be expressed as a long integer.
This method returns an object that describes the valid range for that value.
The value of this temporal object is used to enhance the accuracy of the returned range.
If the date-time cannot return the range, because the field is unsupported or for
some other reason, an exception will be thrown.
Note that the result only describes the minimum and maximum valid values and it is important not to read too much into them. For example, there could be values within the range that are invalid for the field.
Implementations must check and handle all fields defined in ChronoField.
If the field is supported, then the range of the field must be returned.
If unsupported, then a DateTimeException must be thrown.
If the field is not a ChronoField, then the result of this method
is obtained by invoking TemporalField.rangeRefinedBy(TemporalAccessorl)
passing this as the argument.
Implementations must not alter either this object.
the field to query the range for, not null
the range of valid values for the field, not null
if the range for the field cannot be obtained
Converts this date to the Epoch Day.
Converts this date to the Epoch Day.
The ChronoField#EPOCH_DAY 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.
the Epoch Day equivalent to this date
Outputs this date as a String.
Outputs this date as a String.
The output will include the full local date and the chronology ID.
the formatted date, not null
Calculates the period between this date and another date as a ChronoPeriod.
Calculates the period between this date and another date as a ChronoPeriod.
This calculates the period between two dates. All supplied chronologies
calculate the period using years, months and days, however the
ChronoPeriod API allows the period to be represented using other units.
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 chronology of this date. If necessary, the input date will be converted to match.
This instance is immutable and unaffected by this method call.
the period between this date and the end date, not null
if numeric overflow occurs
DateTimeExceptionif the period cannot be calculated
Calculates the period between this temporal and another temporal in terms of the specified unit.
Calculates the period between this temporal and another temporal in terms of the specified unit.
This calculates the period between two temporals in terms of a single unit.
The start and end points are this and the specified temporal.
The result will be negative if the end is before the start.
For example, the period in hours between two temporal objects can be
calculated using startTime.until(endTime, HOURS).
The calculation returns a whole number, representing the number of complete units between the two temporals. For example, the period in hours between the times 11:30 and 13:29 will only be one hour as it is one minute short of two hours.
There are two equivalent ways of using this method.
The first is to invoke this method directly.
The second is to use TemporalUnit#between(Temporal, Temporal):
// these two lines are equivalent between = thisUnit.between(start, end); between = start.until(end, thisUnit);The choice should be made based on which makes the code more readable.
For example, this method allows the number of days between two dates to be calculated:
val daysBetween: Long = DAYS.between(start, end); // or alternatively val daysBetween: Long = start.until(end, DAYS);
Implementations must begin by checking to ensure that the input temporal
object is of the same observable type as the implementation.
They must then perform the calculation for all instances of ChronoUnit.
A DateTimeException must be thrown for ChronoUnit
instances that are unsupported.
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.
In summary, implementations must behave in a manner equivalent to this code:
// check input temporal is the same type as this class
if (unit instanceof ChronoUnit) {
// if unit is supported, then calculate and return result
// else throw DateTimeException for unsupported units
}
return unit.between(this, endTemporal);
The target object must not be altered by this method.
the unit to measure the period in, not null
the amount of the period between this and the end
if numeric overflow occurs
DateTimeExceptionif the period cannot be calculated
Returns an adjusted object of the same type as this object with the adjustment made.
Returns an adjusted object of the same type as this object with the adjustment made.
This adjusts this date-time according to the rules of the specified adjuster.
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".
The adjuster is responsible for handling special cases, such as the varying
lengths of month and leap years.
Some example code indicating how and why this method is used:
date = date.with(Month.JULY); // most key classes implement TemporalAdjuster date = date.with(lastDayOfMonth()); // static import from TemporalAdjusters date = date.with(next(WEDNESDAY)); // static import from TemporalAdjusters and DayOfWeek
Implementations must not alter either this object. Instead, an adjusted copy of the original must be returned. This provides equivalent, safe behavior for immutable and mutable implementations.
the adjuster to use, not null
an object of the same type with the specified adjustment made, not null
if numeric overflow occurs
DateTimeExceptionif unable to make the adjustment
A date expressed in terms of a standard year-month-day calendar system.
This class is used by applications seeking to handle dates in non-ISO calendar systems. For example, the Japanese, Minguo, Thai Buddhist and others.
ChronoLocalDateis built on the generic concepts of year, month and day. The calendar system, represented by aChronology, expresses the relationship between the fields and this class allows the resulting date to be manipulated.Note that not all calendar systems are suitable for use with this class. For example, the Mayan calendar uses a system that bears no relation to years, months and days.
The API design encourages the use of
LocalDatefor the majority of the application. This includes code to read and write from a persistent data store, such as a database, and to send dates and times across a network. TheChronoLocalDateinstance is then used at the user interface level to deal with localized input/output.Example:
System.out.printf("Example()%n"); // Enumerate the list of available calendars and print today for each Set<Chrono> chronos = Chrono.getAvailableChronologies(); for (Chrono chrono : chronos) { ChronoLocalDate date = chrono.dateNow(); System.out.printf(" %20s: %s%n", chrono.getID(), date.toString()); } // Print the Hijrah date and calendar ChronoLocalDate date = Chrono.of("Hijrah").dateNow(); int day = date.get(ChronoField.DAY_OF_MONTH); int dow = date.get(ChronoField.DAY_OF_WEEK); int month = date.get(ChronoField.MONTH_OF_YEAR); int year = date.get(ChronoField.YEAR); System.out.printf(" Today is %s %s %d-%s-%d%n", date.getChrono().getID(), dow, day, month, year); // Print today's date and the last day of the year ChronoLocalDate now1 = Chrono.of("Hijrah").dateNow(); ChronoLocalDate first = now1.with(ChronoField.DAY_OF_MONTH, 1) .with(ChronoField.MONTH_OF_YEAR, 1); ChronoLocalDate last = first.plus(1, ChronoUnit.YEARS) .minus(1, ChronoUnit.DAYS); System.out.printf(" Today is %s: start: %s; end: %s%n", last.getChrono().getID(), first, last);Adding Calendars
The set of calendars is extensible by defining a subclass of
ChronoLocalDateto represent a date instance and an implementation ofChronologyto be the factory for the ChronoLocalDate subclass.To permit the discovery of the additional calendar types the implementation of
Chronologymust be registered as a Service implementing theChronologyinterface in theMETA-INF/Servicesfile as per the specification ofjava.util.ServiceLoader. The subclass must function according to theChronologyclass description and must provide itsChronology#getID calendar nameandChronology#getCalendarType() calendar type.Specification for implementors
This abstract class must be implemented with care to ensure other classes operate correctly. All implementations that can be instantiated must be final, immutable and thread-safe. Subclasses should be Serializable wherever possible.
the date type