close
The Wayback Machine - https://web.archive.org/web/20180122090048/https://developer.android.com/reference/java/time/temporal/TemporalQuery.html
Skip to content

Most visited

Recently visited

navigation
added in API level 26

TemporalQuery

public interface TemporalQuery

java.time.temporal.TemporalQuery<R>


Strategy for querying a temporal object.

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 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.

Summary

Public methods

abstract R queryFrom(TemporalAccessor temporal)

Queries the specified temporal object.

Public methods

queryFrom

added in API level 26
R queryFrom (TemporalAccessor temporal)

Queries the specified temporal object.

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 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.

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.

    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 TemporalAccessor: the temporal object to query, not null

Returns
R the queried value, may return null to indicate not found

Throws
DateTimeException if unable to query
ArithmeticException if numeric overflow occurs
This site uses cookies to store your preferences for site-specific language and display options.

Get the latest Android developer news and tips that will help you find success on Google Play.

* Required Fields

Hooray!

Follow Google Developers on WeChat

BERJAYA

Browse this site in ?

You requested a page in , but your language preference for this site is .

Would you like to change your language preference and browse this site in ? If you want to change your language preference later, use the language menu at the bottom of each page.

This class requires API level or higher

This doc is hidden because your selected API level for the documentation is . You can change the documentation API level with the selector above the left navigation.

For more information about specifying the API level your app requires, read Supporting Different Platform Versions.

Take a short survey?
Help us improve the Android developer experience. (Dec 2017 Android Platform & Tools Survey)