Class StaticDeadline
- java.lang.Object
-
- org.hibernate.search.engine.common.timing.spi.StaticDeadline
-
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description long
checkRemainingTimeMillis()
void
forceTimeout(Exception cause)
SearchTimeoutException
forceTimeoutAndCreateException(Exception cause)
static Deadline
ofMilliseconds(long milliseconds)
-
-
-
Method Detail
-
ofMilliseconds
public static Deadline ofMilliseconds(long milliseconds)
- Parameters:
milliseconds
- The number of milliseconds until the deadline.- Returns:
- An immutable
Deadline
which does not track the passing time.checkRemainingTimeMillis()
will always return the same value and will never throw an exception.
-
checkRemainingTimeMillis
public long checkRemainingTimeMillis()
- Specified by:
checkRemainingTimeMillis
in interfaceDeadline
- Returns:
- The remaining time to the deadline in milliseconds.
-
forceTimeout
public void forceTimeout(Exception cause)
- Specified by:
forceTimeout
in interfaceDeadline
- Parameters:
cause
- The cause of the timeout, ornull
.
-
forceTimeoutAndCreateException
public SearchTimeoutException forceTimeoutAndCreateException(Exception cause)
- Specified by:
forceTimeoutAndCreateException
in interfaceDeadline
- Parameters:
cause
- The cause of the timeout, ornull
.- Returns:
- An exception to be thrown on timeout.
-
-