Package org.apache.lucene.index
Interface QueryTimeout
- All Known Implementing Classes:
QueryTimeoutImpl
public interface QueryTimeout
Base for query timeout implementations, which will provide a
shouldExit() method, used
with ExitableDirectoryReader.-
Method Summary
Modifier and TypeMethodDescriptiondefault booleanReturns true if timeouts are enabled for this query (i.e.booleanCalled fromExitableDirectoryReader.ExitableTermsEnum.next()to determine whether to stop processing a query.
-
Method Details
-
shouldExit
boolean shouldExit()Called fromExitableDirectoryReader.ExitableTermsEnum.next()to determine whether to stop processing a query. -
isTimeoutEnabled
default boolean isTimeoutEnabled()Returns true if timeouts are enabled for this query (i.e. if shouldExit would ever return true)
-