public interface TemporalAccessor
This is the base interface type for date, time and offset objects. It is implemented by those classes that can provide information as fields or queries.
Most date and time information can be represented as a number.
These are modeled using TemporalField with the number held using
a long to handle large values. Year, month and day-of-month are
simple examples of fields, but they also include instant and offsets.
See ChronoField for the standard set of fields.
Two pieces of date/time information cannot be represented by numbers,
the chronology and the time-zone.
These can be accessed via queries using
the static methods defined on Queries.
A sub-interface, Temporal, extends this definition to one that also
supports adjustment and manipulation on more complete temporal objects.
This interface is a framework-level interface that should not be widely
used in application code. Instead, applications should create and pass
around instances of concrete types, such as LocalDate.
There are many reasons for this, part of which is that implementations
of this interface may be in calendar systems other than ISO.
See ChronoLocalDate for a fuller discussion of the issues.
| Modifier and Type | Method and Description |
|---|---|
default int |
get(TemporalField field)
Gets the value of the specified field as an
int. |
long |
getLong(TemporalField field)
Gets the value of the specified field as a
long. |
boolean |
isSupported(TemporalField field)
Checks if the specified field is supported.
|
default <R> R |
query(TemporalQuery<R> query)
Queries this date-time.
|
default ValueRange |
range(TemporalField field)
Gets the range of valid values for the specified field.
|
boolean isSupported(TemporalField field)
This checks if the date-time can be queried for the specified field.
If false, then calling the range and get
methods will throw an exception.
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.doIsSupported(TemporalAccessor)
passing this as the argument.
Implementations must not alter either this object.
field - the field to check, null returns falsedefault ValueRange range(TemporalField 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.
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.doRange(TemporalAccessorl)
passing this as the argument.
Implementations must not alter either this object.
The default implementation must behave equivalent to this code:
if (field instanceof ChronoField) {
if (isSupported(field)) {
return field.range();
}
throw new DateTimeException("Unsupported field: " + field.getName());
}
return field.doRange(this);
field - the field to query the range for, not nullDateTimeException - if the range for the field cannot be obtaineddefault int get(TemporalField field)
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.
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.doGet(TemporalAccessor)
passing this as the argument.
Implementations must not alter either this object.
The default implementation must behave equivalent to this code:
return range(field).checkValidIntValue(getLong(field), field);
field - the field to get, not nullDateTimeException - if a value for the field cannot be obtainedDateTimeException - if the range of valid values for the field exceeds an intDateTimeException - if the value is outside the range of valid values for the fieldjava.lang.ArithmeticException - if numeric overflow occurslong getLong(TemporalField field)
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.
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.doGet(TemporalAccessor)
passing this as the argument.
Implementations must not alter either this object.
field - the field to get, not nullDateTimeException - if a value for the field cannot be obtainedjava.lang.ArithmeticException - if numeric overflow occursdefault <R> R query(TemporalQuery<R> query)
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 Queries.
Queries may also be defined by applications.
if (query == Queries.zoneId() || query == Queries.chrono() || query == Queries.precision()) {
return null;
}
return query.queryFrom(this);
Future versions are permitted to add further queries to the if statement.
All classes implementing this interface and overriding this method must call
TemporalAccessor.super.query(query). JDK classes may avoid calling
super if they provide behavior equivalent to the default behaviour, however
non-JDK classes may not utilize this optimization and must call super.
If the implementation can supply a value for one of the queries listed in the
if statement of the default implementation, then it must do so.
For example, an application-defined HourMin class storing the hour
and minute must override this method as follows:
if (query == Queries.precision()) {
return MINUTES;
}
return TemporalAccessor.super.query(query);
R - the type of the resultquery - the query to invoke, not nullDateTimeException - if unable to queryjava.lang.ArithmeticException - if numeric overflow occurs