TemporalAccessor

Framework-level interface defining read-only access to a temporal object, such as a date, time, offset or some combination of these. !(p) This is the base interface type for date, time and offset objects. It is implemented by those classes that can provide information as {@linkplain TemporalField fields} or {@linkplain TemporalQuery queries}. !(p) Most date and time information can be represented as a number. These are modeled using {@code TemporalField} with the number held using a {@code long} to handle large values. Year, month and day-of-month are simple examples of fields, but they also include instant and offsets. See {@link ChronoField} for the standard set of fields. !(p) Two pieces of date/time information cannot be represented by numbers, the {@linkplain hunt.time.chrono.Chronology chronology} and the {@linkplain hunt.time.ZoneId time-zone}. These can be accessed via {@linkplain #query(TemporalQuery) queries} using the static methods defined on {@link TemporalQuery}. !(p) A sub-interface, {@link Temporal}, extends this definition to one that also supports adjustment and manipulation on more complete temporal objects. !(p) 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 {@code 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 {@link hunt.time.chrono.ChronoLocalDate} for a fuller discussion of the issues.

@implSpec This interface places no restrictions on the mutability of implementations, however immutability is strongly recommended.

@since 1.8

Members

Functions

get
int get(TemporalField field)

Gets the value of the specified field as an {@code int}. !(p) 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.

getLong
long getLong(TemporalField field)

Gets the value of the specified field as a {@code long}. !(p) 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.

isSupported
bool isSupported(TemporalField field)

Checks if the specified field is supported. !(p) This checks if the date-time can be queried for the specified field. If false, then calling the {@link #range(TemporalField) range} and {@link #get(TemporalField) get} methods will throw an exception.

query
R query(TemporalQuery!(R) query)

Queries this date-time. !(p) This queries this date-time using the specified query strategy object. !(p) 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. !(p) The most common query implementations are method references, such as {@code LocalDate::from} and {@code ZoneId::from}. Additional implementations are provided as static methods on {@link TemporalQuery}.

range
ValueRange range(TemporalField field)

Gets the range of valid values for the specified field. !(p) All fields can be expressed as a {@code 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. !(p) 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.

toString
string toString()
Undocumented in source.

Meta