Package com.redwood.scheduler.api.model.enumeration

Enum SharedExclusiveLockValuesType

java.lang.Object

java.lang.Enum<SharedExclusiveLockValuesType>

com.redwood.scheduler.api.model.enumeration.SharedExclusiveLockValuesType

All Implemented Interfaces:

BaseSchedulerEnumeration<SharedExclusiveLockValuesType,Integer>, SchedulerIntegerEnumeration<SharedExclusiveLockValuesType>, Serializable, Comparable<SharedExclusiveLockValuesType>

public enum SharedExclusiveLockValuesType
extends Enum<SharedExclusiveLockValuesType>
implements SchedulerIntegerEnumeration<SharedExclusiveLockValuesType>

The values for LockType shared/exclusive. (Integer Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
Exclusive	Only one process can run
Shared	Maximum number of processes allowed to run in parallel

Field Summary

Fields

Modifier and Type	Field	Description
static int	ExclusiveCode	The int returned from Exclusive.getCodeEx().
static int	SharedCode	The int returned from Shared.getCodeEx().

Method Summary

Modifier and Type	Method	Description
int	getCodeEx()	Get the code that is used to represent this enumeration in the database.
Integer	getCodeExInteger()	Get the code that is used to represent this enumeration in the database.
Integer	getCodeExValue()	Return the code for the enumeration item as the database type of this enumeration.
String	getDescriptionKey()	Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.
String	getStringValue()
String	getTranslationEN()	Get the English name of this enumeration.
String	getTranslationKey()	Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.
static SharedExclusiveLockValuesType	safeValueOf(String value)	Helper function to return the SharedExclusiveLockValuesType represented by value.
static SharedExclusiveLockValuesType	valueOf(int code)	Helper function to return the SharedExclusiveLockValuesType represented by code.
static SharedExclusiveLockValuesType	valueOf(Integer code)	Helper function to return the SharedExclusiveLockValuesType represented by code.
static SharedExclusiveLockValuesType	valueOf(String name)	Returns the enum constant of this type with the specified name.
static SharedExclusiveLockValuesType	valueOfCode(String code)	Helper function to return the SharedExclusiveLockValuesType represented by code.
static SharedExclusiveLockValuesType[]	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

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

name, ordinal

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

Shared

public static final SharedExclusiveLockValuesType Shared

Maximum number of processes allowed to run in parallel

Exclusive

public static final SharedExclusiveLockValuesType Exclusive

Only one process can run

Field Detail

SharedCode

public static final int SharedCode

The int returned from Shared.getCodeEx().

See Also:

Shared, Constant Field Values

ExclusiveCode

public static final int ExclusiveCode

The int returned from Exclusive.getCodeEx().

See Also:

Exclusive, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getStringValue

public String getStringValue()

valueOfCode

public static SharedExclusiveLockValuesType valueOfCode(String code)

Helper function to return the SharedExclusiveLockValuesType represented by code. If code is null, empty, or not a valid code then this method will return null.

Parameters:

code - A string that is one of the codes for SharedExclusiveLockValuesType

Returns:

The SharedExclusiveLockValuesType corresponding to code, or null.

safeValueOf

public static SharedExclusiveLockValuesType safeValueOf(String value)

Helper function to return the SharedExclusiveLockValuesType represented by value. If value is null, or not a valid SharedExclusiveLockValuesType enumeration then this method will return null.

The main difference between this method and valueOf(String), is that this method will return null when passed an invalid value, valueOf(String) will throw an IllegalArgumentException.

Parameters:

value - The string value that corresponds to the requested enumeration value

Returns:

The SharedExclusiveLockValuesType corresponding to value, or null, if value is null, or not a valid enumeration

See Also:

valueOf(String)

valueOf

public static SharedExclusiveLockValuesType valueOf(Integer code)

Helper function to return the SharedExclusiveLockValuesType represented by code. If code is null, or not a valid SharedExclusiveLockValuesType code then this method will return null.

Parameters:

code - Integer that is one of the codes for HandlerAction

Returns:

The SharedExclusiveLockValuesType corresponding to code, or null, if code is null, or not a valid code

valueOf

public static SharedExclusiveLockValuesType valueOf(int code)

Helper function to return the SharedExclusiveLockValuesType represented by code. If code is not a valid SharedExclusiveLockValuesType code then this method will return null.

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

The SharedExclusiveLockValuesType corresponding to code, or null, if code is not a valid code

getCodeEx

public int getCodeEx()

Description copied from interface: SchedulerIntegerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeEx in interface SchedulerIntegerEnumeration<SharedExclusiveLockValuesType>

Returns:

the database code for the enumeration

getCodeExValue

public Integer getCodeExValue()

Description copied from interface: BaseSchedulerEnumeration

Return the code for the enumeration item as the database type of this enumeration.

Specified by:

getCodeExValue in interface BaseSchedulerEnumeration<SharedExclusiveLockValuesType,Integer>

Returns:

the enumeration code

getCodeExInteger

public Integer getCodeExInteger()

Description copied from interface: SchedulerIntegerEnumeration

Get the code that is used to represent this enumeration in the database.

Specified by:

getCodeExInteger in interface SchedulerIntegerEnumeration<SharedExclusiveLockValuesType>

Returns:

the database code for the enumeration

getTranslationKey

public String getTranslationKey()

Description copied from interface: BaseSchedulerEnumeration

Get the translation-key that must be used to retrieve the locale-specific name of this enumeration.

Specified by:

getTranslationKey in interface BaseSchedulerEnumeration<SharedExclusiveLockValuesType,Integer>

Returns:

the key.

getTranslationEN

public String getTranslationEN()

Description copied from interface: BaseSchedulerEnumeration

Get the English name of this enumeration.

Specified by:

getTranslationEN in interface BaseSchedulerEnumeration<SharedExclusiveLockValuesType,Integer>

Returns:

the English name of this enumeration.

getDescriptionKey

public String getDescriptionKey()

Description copied from interface: BaseSchedulerEnumeration

Get the translation-key for the description that must be used to retrieve the locale-specific description of this enumeration.

Specified by:

getDescriptionKey in interface BaseSchedulerEnumeration<SharedExclusiveLockValuesType,Integer>

Returns:

the key that can be passed to SchedulerSession.translateField(String) to retrieve the translated description.