com.asakusafw.yaess.core

Enum ExecutionLock.Scope

java.lang.Object

java.lang.Enum<ExecutionLock.Scope>

com.asakusafw.yaess.core.ExecutionLock.Scope

All Implemented Interfaces:

Symbolic, Serializable, Comparable<ExecutionLock.Scope>

Enclosing class:

ExecutionLock

public static enum ExecutionLock.Scope
extends Enum<ExecutionLock.Scope>
implements Symbolic

Represents lock scope.

Since:

0.2.3

Enum Constant Summary

Enum Constants

Enum Constant and Description
BATCH Batch scope.
EXECUTION Execution scope.
FLOW Flow scope.
WORLD World scope.

Method Summary

Modifier and Type	Method and Description
static ExecutionLock.Scope	findFromSymbol(String symbol) Returns an ExecutionLock.Scope corresponded to the symbol.
static ExecutionLock.Scope	getDefault() Returns the default scope.
String	getSymbol() Returns the symbol of this scope.
String	toString()
static ExecutionLock.Scope	valueOf(String name) Returns the enum constant of this type with the specified name.
static ExecutionLock.Scope[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

WORLD

public static final ExecutionLock.Scope WORLD

World scope. Only single process can execute any batch.

BATCH

public static final ExecutionLock.Scope BATCH

Batch scope. Only single process can execute particular batch.

FLOW

public static final ExecutionLock.Scope FLOW

Flow scope. Only single process can execute particular flow.

EXECUTION

public static final ExecutionLock.Scope EXECUTION

Execution scope. Different processes can execute the same flow as long as these execution IDs are different.

Method Detail

values

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

Returns:

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

valueOf

public static ExecutionLock.Scope 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

getDefault

public static ExecutionLock.Scope getDefault()

Returns the default scope.

Returns:

the default scope

getSymbol

public String getSymbol()

Returns the symbol of this scope.

Specified by:

getSymbol in interface Symbolic

Returns:

the symbol of this scope

toString

public String toString()

Overrides:

toString in class Enum<ExecutionLock.Scope>

findFromSymbol

public static ExecutionLock.Scope findFromSymbol(String symbol)

Returns an ExecutionLock.Scope corresponded to the symbol.

Parameters:

symbol - target symbol

Returns:

the corresponding scope, or null if not found

Throws:

IllegalArgumentException - if some parameters were null