Interface TemporalQuery<R>
Queries are a key tool for extracting information from temporal objects. They exist 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 TemporalField interface provides another mechanism for querying temporal objects. That interface is limited to returning a long. By contrast, queries can return any type.
There are two equivalent ways of using a TemporalQuery. The first is to invoke the method on this interface directly. The second is to use TemporalAccessor.query(TemporalQuery): // these two lines are equivalent, but the second approach is recommended temporal = thisQuery.queryFrom(temporal); temporal = temporal.query(thisQuery); It is recommended to use the second approach, query(TemporalQuery), as it is a lot clearer to read in code.
The most common implementations are method references, such as LocalDate::from and ZoneId::from. Additional common queries are provided as static methods in TemporalQueries.
-
Method Summary
All MethodsInstance MethodsAbstract MethodsModifier and TypeMethodDescriptionqueryFrom(TemporalAccessor temporal)Queries the specified temporal object.
-
Method Details
-
queryFrom
Queries the specified temporal object.Implementation Requirements: The implementation must take the input object and query it. The implementation defines the logic of the query and is responsible for documenting that logic. It may use any method on TemporalAccessor to determine the result. The input object must not be altered.This queries the specified temporal object to return an object using the logic encapsulated in the implementing class. 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.
There are two equivalent ways of using this method. The first is to invoke this method directly. The second is to use TemporalAccessor.query(TemporalQuery): // these two lines are equivalent, but the second approach is recommended temporal = thisQuery.queryFrom(temporal); temporal = temporal.query(thisQuery); It is recommended to use the second approach, query(TemporalQuery), as it is a lot clearer to read in code.
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 querying the chronology.
This method may be called from multiple threads in parallel. It must be thread-safe when invoked.
Parameters: temporal - the temporal object to query, not null Returns: the queried value, may return null to indicate not found Throws: DateTimeException - if unable to query ArithmeticException - if numeric overflow occurs
-
Report a bug or suggest an enhancement
For further API reference and developer documentation see the Java SE Documentation, which contains more detailed, developer-targeted descriptions with conceptual overviews, definitions of terms, workarounds, and working code examples. Other versions.
Java is a trademark or registered trademark of Oracle and/or its affiliates in the US and other countries.
Copyright © 1993, 2026, Oracle and/or its affiliates, 500 Oracle Parkway, Redwood Shores, CA 94065 USA.
All rights reserved. Use is subject to license terms and the documentation redistribution policy.