Package io.permazen.kv.simple

Enum Class LockManager.LockResult

java.lang.Object

java.lang.Enum<LockManager.LockResult>

io.permazen.kv.simple.LockManager.LockResult

All Implemented Interfaces:

Serializable, Comparable<LockManager.LockResult>, Constable

Enclosing class:

LockManager

public static enum LockManager.LockResult
extends Enum<LockManager.LockResult>

Possible return values from LockManager.lock().

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
HOLD_TIMEOUT_EXPIRED	The owner's hold timeout expired.
SUCCESS	The lock was successfully acquired.
WAIT_TIMEOUT_EXPIRED	The timeout expired while waiting to acquire the lock.

Method Summary

Modifier and Type	Method	Description
static LockManager.LockResult	valueOf(String name)	Returns the enum constant of this class with the specified name.
static LockManager.LockResult[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

SUCCESS

public static final LockManager.LockResult SUCCESS

The lock was successfully acquired.

WAIT_TIMEOUT_EXPIRED

public static final LockManager.LockResult WAIT_TIMEOUT_EXPIRED

The timeout expired while waiting to acquire the lock.

HOLD_TIMEOUT_EXPIRED

public static final LockManager.LockResult HOLD_TIMEOUT_EXPIRED

The owner's hold timeout expired.

Method Details

values

public static LockManager.LockResult[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

an array containing the constants of this enum class, in the order they are declared

valueOf

public static LockManager.LockResult valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)

Parameters:

name - the name of the enum constant to be returned.

Returns:

the enum constant with the specified name

Throws:

IllegalArgumentException - if this enum class has no constant with the specified name

NullPointerException - if the argument is null