org.jboss.forge.furnace.lock

Enum LockMode

java.lang.Object

java.lang.Enum<LockMode>

org.jboss.forge.furnace.lock.LockMode

All Implemented Interfaces:

Serializable, Comparable<LockMode>

public enum LockMode
extends Enum<LockMode>

A type-safe differentiation between read and write Lock instances.

Author:

Lincoln Baxter, III

Enum Constant Summary

Enum Constants

Enum Constant and Description
READ Represents a read Lock.
WRITE Represents a write Lock.

Method Summary

Methods

Modifier and Type	Method and Description
static LockMode	valueOf(String name) Returns the enum constant of this type with the specified name.
static LockMode[]	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

READ

public static final LockMode READ

Represents a read Lock.

WRITE

public static final LockMode WRITE

Represents a write Lock.

Method Detail

values

public static LockMode[] 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 (LockMode c : LockMode.values())
    System.out.println(c);

Returns:

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

valueOf

public static LockMode 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