Enum AutoCommitStyle
- java.lang.Object
-
- java.lang.Enum<AutoCommitStyle>
-
- com.redwood.scheduler.api.model.enumeration.AutoCommitStyle
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<AutoCommitStyle,Character>
,SchedulerEnumeration<AutoCommitStyle>
,Serializable
,Comparable<AutoCommitStyle>
public enum AutoCommitStyle extends Enum<AutoCommitStyle> implements SchedulerEnumeration<AutoCommitStyle>
What auto commit style should be used for this database connection (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description AutoCommitOff
Auto Commit OffAutoCommitOn
Auto Commit OnTransactionBased
Auto commit is off, but when the transaction/JDBC process is completed successfully, a commit is done.
-
Field Summary
Fields Modifier and Type Field Description static char
AutoCommitOffCode
The char returned from AutoCommitOff.getCodeEx().static char
AutoCommitOnCode
The char returned from AutoCommitOn.getCodeEx().static char
TransactionBasedCode
The char returned from TransactionBased.getCodeEx().
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description char
getCodeEx()
Get the code that is used to represent this enumeration in the database.Character
getCodeExCharacter()
Get the code that is used to represent this enumeration in the database.String
getCodeExString()
Get the code that is used to represent this enumeration in the database.Character
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
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 AutoCommitStyle
safeValueOf(String value)
Helper function to return the AutoCommitStyle represented byvalue
.static AutoCommitStyle
valueOf(char code)
Helper function to return the AutoCommitStyle represented by code.static AutoCommitStyle
valueOf(Character code)
Helper function to return the AutoCommitStyle represented by code.static AutoCommitStyle
valueOf(String name)
Returns the enum constant of this type with the specified name.static AutoCommitStyle
valueOfCode(String code)
Helper function to return the AutoCommitStyle represented by code.static AutoCommitStyle[]
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 interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration
name, ordinal
-
Methods inherited from interface java.lang.Comparable
compareTo
-
-
-
-
Enum Constant Detail
-
AutoCommitOn
public static final AutoCommitStyle AutoCommitOn
Auto Commit On
-
AutoCommitOff
public static final AutoCommitStyle AutoCommitOff
Auto Commit Off
-
TransactionBased
public static final AutoCommitStyle TransactionBased
Auto commit is off, but when the transaction/JDBC process is completed successfully, a commit is done.
-
-
Field Detail
-
AutoCommitOnCode
public static final char AutoCommitOnCode
The char returned from AutoCommitOn.getCodeEx().- See Also:
AutoCommitOn
, Constant Field Values
-
AutoCommitOffCode
public static final char AutoCommitOffCode
The char returned from AutoCommitOff.getCodeEx().- See Also:
AutoCommitOff
, Constant Field Values
-
TransactionBasedCode
public static final char TransactionBasedCode
The char returned from TransactionBased.getCodeEx().- See Also:
TransactionBased
, Constant Field Values
-
-
Method Detail
-
values
public static AutoCommitStyle[] 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 (AutoCommitStyle c : AutoCommitStyle.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AutoCommitStyle 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 nameNullPointerException
- if the argument is null
-
valueOfCode
public static AutoCommitStyle valueOfCode(String code)
Helper function to return the AutoCommitStyle represented by code. code must be a single character. If code is null, longer than one character, empty, or not a valid code then this method will return null.- Parameters:
code
- A string with one character that is one of the codes for AutoCommitStyle- Returns:
- The AutoCommitStyle corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static AutoCommitStyle safeValueOf(String value)
Helper function to return the AutoCommitStyle represented byvalue
. Ifvalue
is null, or not a valid AutoCommitStyle 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 invalidvalue
,valueOf(String)
will throw anIllegalArgumentException
.- Parameters:
value
- The string value that corresponds to the requested enumeration value- Returns:
- The AutoCommitStyle corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static AutoCommitStyle valueOf(Character code)
Helper function to return the AutoCommitStyle represented by code. If code is null, or not a valid AutoCommitStyle code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The AutoCommitStyle corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static AutoCommitStyle valueOf(char code)
Helper function to return the AutoCommitStyle represented by code. If code is not a valid AutoCommitStyle code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The AutoCommitStyle corresponding to code, or null, if code is not a valid code
-
getCodeEx
public char getCodeEx()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeEx
in interfaceSchedulerEnumeration<AutoCommitStyle>
- Returns:
- the database code for the enumeration
-
getCodeExValue
public Character getCodeExValue()
Description copied from interface:BaseSchedulerEnumeration
Return the code for the enumeration item as the database type of this enumeration.- Specified by:
getCodeExValue
in interfaceBaseSchedulerEnumeration<AutoCommitStyle,Character>
- Returns:
- the enumeration code
-
getCodeExCharacter
public Character getCodeExCharacter()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExCharacter
in interfaceSchedulerEnumeration<AutoCommitStyle>
- 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 interfaceBaseSchedulerEnumeration<AutoCommitStyle,Character>
- Returns:
- the key.
-
getTranslationEN
public String getTranslationEN()
Description copied from interface:BaseSchedulerEnumeration
Get the English name of this enumeration.- Specified by:
getTranslationEN
in interfaceBaseSchedulerEnumeration<AutoCommitStyle,Character>
- 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 interfaceBaseSchedulerEnumeration<AutoCommitStyle,Character>
- Returns:
- the key that can be passed to
SchedulerSession.translateField(String)
to retrieve the translated description.
-
getCodeExString
public String getCodeExString()
Description copied from interface:SchedulerEnumeration
Get the code that is used to represent this enumeration in the database.- Specified by:
getCodeExString
in interfaceSchedulerEnumeration<AutoCommitStyle>
- Returns:
- the database code for the enumeration
-
-