Interface Timeouts

@Incubating
public interface Timeouts

Helpers for dealing with timeout values, including some "magic values".

Since:

7.0

API Note:

The NO_WAIT and SKIP_LOCKED magic values each have a corresponding LockMode (LockMode.UPGRADE_NOWAIT and LockMode.UPGRADE_SKIPLOCKED, respectively).

Field Summary

Fields

Modifier and Type	Field	Description
static final Timeout	NO_WAIT	Indicates that the database should not wait at all to acquire a pessimistic lock which is not immediately available.
static final int	NO_WAIT_MILLI	Raw magic millisecond value for NO_WAIT
static final Timeout	ONE_SECOND	Timeout of 1 second.
static final Timeout	SKIP_LOCKED	Indicates that rows which are already locked should be skipped.
static final int	SKIP_LOCKED_MILLI	Raw magic millisecond value for SKIP_LOCKED
static final Timeout	WAIT_FOREVER	Indicates that there is no timeout for the lock acquisition, that is, that the database should in principle wait forever to obtain the lock.
static final int	WAIT_FOREVER_MILLI	Raw magic millisecond value for WAIT_FOREVER

Method Summary

Static Methods

Modifier and Type	Method	Description
static Timeout	fromHibernateHint(Object value)
static Timeout	fromHints(Map<String,Object> properties)
static Timeout	fromHintTimeout(Object factoryHint)
static Timeout	fromJpaHint(Object value)
static Integer	getEffectiveTimeoutInSeconds(Timeout timeout)
static int	getTimeoutInSeconds(int timeoutInMilliseconds)	Get the number of (whole) seconds represented by the given timeout.
static int	getTimeoutInSeconds(Timeout timeout)	Get the number of (whole) seconds represented by the given timeout.
static Timeout	inSeconds(int timeout)
static Timeout	interpretMilliSeconds(int timeoutInMilliseconds)	Similar to simply calling Timeout.milliseconds(int), but accounting for the "magic values".
static boolean	isMagicValue(int millis)	Whether the given value is one of the magic values - NO_WAIT_MILLI WAIT_FOREVER_MILLI SKIP_LOCKED_MILLI
static boolean	isMagicValue(Timeout timeout)	Whether the given timeout is one of the magic values - NO_WAIT WAIT_FOREVER SKIP_LOCKED
static boolean	isRealTimeout(int timeoutInMilliseconds)	Whether the timeout value is a real value, as opposed to one of the "magic values".
static boolean	isRealTimeout(Timeout timeout)	Whether the timeout value is a real value, as opposed to one of the "magic values".
static Timeout	lockTimeoutFromHints(Map<String,Object> properties)
static Timeout	statementTimeoutFromHints(Map<String,Object> properties)

Field Details

ONE_SECOND

static final Timeout ONE_SECOND

Timeout of 1 second.

NO_WAIT_MILLI

static final int NO_WAIT_MILLI

Raw magic millisecond value for NO_WAIT

See Also:

• Constant Field Values

WAIT_FOREVER_MILLI

static final int WAIT_FOREVER_MILLI

Raw magic millisecond value for WAIT_FOREVER

See Also:

• Constant Field Values

SKIP_LOCKED_MILLI

static final int SKIP_LOCKED_MILLI

Raw magic millisecond value for SKIP_LOCKED

See Also:

• Constant Field Values

NO_WAIT

static final Timeout NO_WAIT

Indicates that the database should not wait at all to acquire a pessimistic lock which is not immediately available.

See Also:

• NO_WAIT_MILLI
• LockMode.UPGRADE_NOWAIT

WAIT_FOREVER

static final Timeout WAIT_FOREVER

Indicates that there is no timeout for the lock acquisition, that is, that the database should in principle wait forever to obtain the lock.

See Also:

• WAIT_FOREVER_MILLI

SKIP_LOCKED

static final Timeout SKIP_LOCKED

Indicates that rows which are already locked should be skipped.

See Also:

• SKIP_LOCKED_MILLI
• LockMode.UPGRADE_SKIPLOCKED

Method Details

interpretMilliSeconds

static Timeout interpretMilliSeconds(int timeoutInMilliseconds)

Similar to simply calling Timeout.milliseconds(int), but accounting for the "magic values".

isMagicValue

static boolean isMagicValue(Timeout timeout)

Whether the given timeout is one of the magic values -

• NO_WAIT
• WAIT_FOREVER
• SKIP_LOCKED

See Also:

• isMagicValue(int)

isMagicValue

static boolean isMagicValue(int millis)

Whether the given value is one of the magic values -

• NO_WAIT_MILLI
• WAIT_FOREVER_MILLI
• SKIP_LOCKED_MILLI

See Also:

• isRealTimeout(int)

isRealTimeout

static boolean isRealTimeout(Timeout timeout)

Whether the timeout value is a real value, as opposed to one of the "magic values". Functionally, returns whether the value is greater than zero.

isRealTimeout

static boolean isRealTimeout(int timeoutInMilliseconds)

Whether the timeout value is a real value, as opposed to one of the "magic values". Functionally, returns whether the value is greater than zero.

getTimeoutInSeconds

static int getTimeoutInSeconds(Timeout timeout)

Get the number of (whole) seconds represented by the given timeout.

getEffectiveTimeoutInSeconds

static Integer getEffectiveTimeoutInSeconds(Timeout timeout)

getTimeoutInSeconds

static int getTimeoutInSeconds(int timeoutInMilliseconds)

Get the number of (whole) seconds represented by the given timeout.

fromHints

static Timeout fromHints(Map<String,Object> properties)

lockTimeoutFromHints

static Timeout lockTimeoutFromHints(Map<String,Object> properties)

statementTimeoutFromHints

static Timeout statementTimeoutFromHints(Map<String,Object> properties)

fromHintTimeout

static Timeout fromHintTimeout(Object factoryHint)

fromHibernateHint

static Timeout fromHibernateHint(Object value)

See Also:

• HibernateHints.HINT_TIMEOUT

fromJpaHint

static Timeout fromJpaHint(Object value)

See Also:

• SpecHints.HINT_SPEC_QUERY_TIMEOUT
• SpecHints.HINT_SPEC_LOCK_TIMEOUT

inSeconds

static Timeout inSeconds(int timeout)