Package org.apache.lucene.index
Class QueryTimeoutImpl
- java.lang.Object
-
- org.apache.lucene.index.QueryTimeoutImpl
-
- All Implemented Interfaces:
QueryTimeout
public class QueryTimeoutImpl extends Object implements QueryTimeout
An implementation ofQueryTimeoutthat can be used by theExitableDirectoryReaderclass to time out and exit out when a query takes a long time to rewrite.
-
-
Constructor Summary
Constructors Constructor Description QueryTimeoutImpl(long timeAllowed)Sets the time at which to time out by adding the given timeAllowed to the current time.
-
Method Summary
All Methods Instance Methods Concrete Methods Modifier and Type Method Description LonggetTimeoutAt()Returns time at which to time out, in nanoseconds relative to the (JVM-specific) epoch forSystem.nanoTime(), to compare with the value returned bynanoTime().voidreset()Reset the timeout value.booleanshouldExit()Return true ifreset()has not been called and the elapsed time has exceeded the time allowed.StringtoString()
-
-
-
Method Detail
-
getTimeoutAt
public Long getTimeoutAt()
Returns time at which to time out, in nanoseconds relative to the (JVM-specific) epoch forSystem.nanoTime(), to compare with the value returned bynanoTime().
-
shouldExit
public boolean shouldExit()
Return true ifreset()has not been called and the elapsed time has exceeded the time allowed.- Specified by:
shouldExitin interfaceQueryTimeout- Returns:
- true if the query should stop, false otherwise
-
reset
public void reset()
Reset the timeout value.
-
-