Enum ParameterType
- java.lang.Object
-
- java.lang.Enum<ParameterType>
-
- com.redwood.scheduler.api.model.enumeration.ParameterType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<ParameterType,Character>
,SchedulerEnumeration<ParameterType>
,Serializable
,Comparable<ParameterType>
public enum ParameterType extends Enum<ParameterType> implements SchedulerEnumeration<ParameterType>
The type of a parameter (Character Enumeration)
-
-
Field Summary
Fields Modifier and Type Field Description static char
CharacterCode
The char returned from Character.getCodeEx().static char
DateCode
The char returned from Date.getCodeEx().static char
DateTimeCode
The char returned from DateTime.getCodeEx().static char
DateTimeZoneCode
The char returned from DateTimeZone.getCodeEx().static char
FileCode
The char returned from File.getCodeEx().static char
NumberCode
The char returned from Number.getCodeEx().static char
StringCode
The char returned from String.getCodeEx().static char
TableCode
The char returned from Table.getCodeEx().static char
TimeCode
The char returned from Time.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 ParameterType
safeValueOf(String value)
Helper function to return the ParameterType represented byvalue
.static ParameterType
valueOf(char code)
Helper function to return the ParameterType represented by code.static ParameterType
valueOf(Character code)
Helper function to return the ParameterType represented by code.static ParameterType
valueOf(String name)
Returns the enum constant of this type with the specified name.static ParameterType
valueOfCode(String code)
Helper function to return the ParameterType represented by code.static ParameterType[]
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
-
Character
public static final ParameterType Character
Single Character value
-
Number
public static final ParameterType Number
Numeric value
-
DateTimeZone
public static final ParameterType DateTimeZone
Redwood DateTimeZone value
-
DateTime
public static final ParameterType DateTime
Redwood DateTime value
-
Date
public static final ParameterType Date
Redwood Date value
-
Time
public static final ParameterType Time
Redwood Time value
-
String
public static final ParameterType String
String value
-
File
public static final ParameterType File
File value
-
Table
public static final ParameterType Table
Table value
-
-
Field Detail
-
CharacterCode
public static final char CharacterCode
The char returned from Character.getCodeEx().- See Also:
Character
, Constant Field Values
-
NumberCode
public static final char NumberCode
The char returned from Number.getCodeEx().- See Also:
Number
, Constant Field Values
-
DateTimeZoneCode
public static final char DateTimeZoneCode
The char returned from DateTimeZone.getCodeEx().- See Also:
DateTimeZone
, Constant Field Values
-
DateTimeCode
public static final char DateTimeCode
The char returned from DateTime.getCodeEx().- See Also:
DateTime
, Constant Field Values
-
DateCode
public static final char DateCode
The char returned from Date.getCodeEx().- See Also:
Date
, Constant Field Values
-
TimeCode
public static final char TimeCode
The char returned from Time.getCodeEx().- See Also:
Time
, Constant Field Values
-
StringCode
public static final char StringCode
The char returned from String.getCodeEx().- See Also:
String
, Constant Field Values
-
FileCode
public static final char FileCode
The char returned from File.getCodeEx().- See Also:
File
, Constant Field Values
-
TableCode
public static final char TableCode
The char returned from Table.getCodeEx().- See Also:
Table
, Constant Field Values
-
-
Method Detail
-
values
public static ParameterType[] 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 (ParameterType c : ParameterType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static ParameterType 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 ParameterType valueOfCode(String code)
Helper function to return the ParameterType 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 ParameterType- Returns:
- The ParameterType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static ParameterType safeValueOf(String value)
Helper function to return the ParameterType represented byvalue
. Ifvalue
is null, or not a valid ParameterType 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 ParameterType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static ParameterType valueOf(Character code)
Helper function to return the ParameterType represented by code. If code is null, or not a valid ParameterType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The ParameterType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static ParameterType valueOf(char code)
Helper function to return the ParameterType represented by code. If code is not a valid ParameterType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The ParameterType 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<ParameterType>
- 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<ParameterType,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<ParameterType>
- 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<ParameterType,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<ParameterType,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<ParameterType,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<ParameterType>
- Returns:
- the database code for the enumeration
-
-