org.jboss.as.clustering.lock

Enum SharedLocalYieldingClusterLockManager.LockResult

java.lang.Object

java.lang.Enum<SharedLocalYieldingClusterLockManager.LockResult>

org.jboss.as.clustering.lock.SharedLocalYieldingClusterLockManager.LockResult

All Implemented Interfaces:

Serializable, Comparable<SharedLocalYieldingClusterLockManager.LockResult>

Enclosing class:

SharedLocalYieldingClusterLockManager

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

Result of a lock call

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACQUIRED_FROM_CLUSTER Indicates the lock was acquired after requesting it from the cluster
ALREADY_HELD Indicates this node already held the lock
NEW_LOCK Indicates the 'newLock' param passed to YieldingClusterLockManager#lock(Serializable, long, boolean) was true and the local node in fact was unaware of the lock.

Method Summary

Methods

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

Methods inherited from class java.lang.Enum

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

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

ACQUIRED_FROM_CLUSTER

public static final SharedLocalYieldingClusterLockManager.LockResult ACQUIRED_FROM_CLUSTER

Indicates the lock was acquired after requesting it from the cluster

ALREADY_HELD

public static final SharedLocalYieldingClusterLockManager.LockResult ALREADY_HELD

Indicates this node already held the lock

NEW_LOCK

public static final SharedLocalYieldingClusterLockManager.LockResult NEW_LOCK

Indicates the 'newLock' param passed to YieldingClusterLockManager#lock(Serializable, long, boolean) was true and the local node in fact was unaware of the lock. If in fact the local node was already aware of the lock (which would generally indicate a flaw in the application using this class) NEW_LOCK will not be returned; rather one of the other enum values will be returned.

Method Detail

values

public static SharedLocalYieldingClusterLockManager.LockResult[] values()

Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:

for (SharedLocalYieldingClusterLockManager.LockResult c : SharedLocalYieldingClusterLockManager.LockResult.values())
    System.out.println(c);

Returns:

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

valueOf

public static SharedLocalYieldingClusterLockManager.LockResult valueOf(String name)

Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null