public interface TemporalAccessor
Most date and time information can be represented as a number.
These are modeled using
TemporalField with the number held using
long to handle large values. Year, month and day-of-month are
simple examples of fields, but they also include instant and offsets.
ChronoField for the standard set of fields.
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
There are many reasons for this, part of which is that implementations
of this interface may be in calendar systems other than ISO.
ChronoLocalDate for a fuller discussion of the issues.
|Modifier and Type||Method and Description|
Gets the value of the specified field as an
Gets the value of the specified field as a
Checks if the specified field is supported.
Queries this date-time.
Gets the range of valid values for the specified field.
boolean isSupported(TemporalField field)
field- the field to check, null returns false
default ValueRange range(TemporalField field)
All fields can be expressed as a
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.
default int get(TemporalField field)
This queries the date-time for the value of 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.
field- the field to get, not null
DateTimeException- if a value for the field cannot be obtained or the value is outside the range of valid values for the field
UnsupportedTemporalTypeException- if the field is not supported or the range of values exceeds an
ArithmeticException- if numeric overflow occurs
long getLong(TemporalField field)
This queries the date-time for the value of 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.
default <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
Additional implementations are provided as static methods on