Enum ModelTypes
- java.lang.Object
-
- java.lang.Enum<ModelTypes>
-
- com.redwood.scheduler.api.model.enumeration.ModelTypes
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ModelTypes,Character>
,SchedulerEnumeration<ModelTypes>
,Serializable
,Comparable<ModelTypes>
public enum ModelTypes extends Enum<ModelTypes> implements SchedulerEnumeration<ModelTypes>
All types that are allowed in the model (Character Enumeration)
-
-
Field Summary
Fields Modifier and Type Field Description static char
BlobCode
The char returned from Blob.getCodeEx().static char
BoolCode
The char returned from Bool.getCodeEx().static char
CharCode
The char returned from Char.getCodeEx().static char
DateCode
The char returned from Date.getCodeEx().static char
EnumCode
The char returned from Enum.getCodeEx().static char
IntegerCode
The char returned from Integer.getCodeEx().static char
IntEnumCode
The char returned from IntEnum.getCodeEx().static char
NumberCode
The char returned from Number.getCodeEx().static char
ObjectCode
The char returned from Object.getCodeEx().static char
StringCode
The char returned from String.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 ModelTypes
safeValueOf(String value)
Helper function to return the ModelTypes represented byvalue
.static ModelTypes
valueOf(char code)
Helper function to return the ModelTypes represented by code.static ModelTypes
valueOf(Character code)
Helper function to return the ModelTypes represented by code.static ModelTypes
valueOf(String name)
Returns the enum constant of this type with the specified name.static ModelTypes
valueOfCode(String code)
Helper function to return the ModelTypes represented by code.static ModelTypes[]
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
-
Bool
public static final ModelTypes Bool
Boolean value
-
Char
public static final ModelTypes Char
Character value
-
Date
public static final ModelTypes Date
Date and Timezone value
-
Enum
public static final ModelTypes Enum
Enumeration
-
Integer
public static final ModelTypes Integer
Long value
-
Number
public static final ModelTypes Number
Number value
-
Object
public static final ModelTypes Object
Modelobject value
-
String
public static final ModelTypes String
String value
-
IntEnum
public static final ModelTypes IntEnum
Enumeration
-
Blob
public static final ModelTypes Blob
Blob
-
-
Field Detail
-
BoolCode
public static final char BoolCode
The char returned from Bool.getCodeEx().- See Also:
Bool
, Constant Field Values
-
CharCode
public static final char CharCode
The char returned from Char.getCodeEx().- See Also:
Char
, Constant Field Values
-
DateCode
public static final char DateCode
The char returned from Date.getCodeEx().- See Also:
Date
, Constant Field Values
-
EnumCode
public static final char EnumCode
The char returned from Enum.getCodeEx().- See Also:
Enum
, Constant Field Values
-
IntegerCode
public static final char IntegerCode
The char returned from Integer.getCodeEx().- See Also:
Integer
, Constant Field Values
-
NumberCode
public static final char NumberCode
The char returned from Number.getCodeEx().- See Also:
Number
, Constant Field Values
-
ObjectCode
public static final char ObjectCode
The char returned from Object.getCodeEx().- See Also:
Object
, Constant Field Values
-
StringCode
public static final char StringCode
The char returned from String.getCodeEx().- See Also:
String
, Constant Field Values
-
IntEnumCode
public static final char IntEnumCode
The char returned from IntEnum.getCodeEx().- See Also:
IntEnum
, Constant Field Values
-
BlobCode
public static final char BlobCode
The char returned from Blob.getCodeEx().- See Also:
Blob
, Constant Field Values
-
-
Method Detail
-
values
public static ModelTypes[] 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 (ModelTypes c : ModelTypes.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ModelTypes 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 ModelTypes valueOfCode(String code)
Helper function to return the ModelTypes 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 ModelTypes- Returns:
- The ModelTypes corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ModelTypes safeValueOf(String value)
Helper function to return the ModelTypes represented byvalue
. Ifvalue
is null, or not a valid ModelTypes 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 ModelTypes corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ModelTypes valueOf(Character code)
Helper function to return the ModelTypes represented by code. If code is null, or not a valid ModelTypes code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ModelTypes corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ModelTypes valueOf(char code)
Helper function to return the ModelTypes represented by code. If code is not a valid ModelTypes code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ModelTypes 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<ModelTypes>
- 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<ModelTypes,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<ModelTypes>
- 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<ModelTypes,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<ModelTypes,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<ModelTypes,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<ModelTypes>
- Returns:
- the database code for the enumeration
-
-