Enum NumberComparisonType
- java.lang.Object
-
- java.lang.Enum<NumberComparisonType>
-
- com.redwood.scheduler.api.model.enumeration.NumberComparisonType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<NumberComparisonType,Character>
,SchedulerEnumeration<NumberComparisonType>
,Serializable
,Comparable<NumberComparisonType>
public enum NumberComparisonType extends Enum<NumberComparisonType> implements SchedulerEnumeration<NumberComparisonType>
The rule for matching a number (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Equals
The number must be equal to the valueGreaterThan
The number must be greater than the valueGreaterThanOrEquals
The number must be greater than or equal to the valueLessThan
The number must be less than the valueLessThanOrEquals
The number must be less than or equal to the valueNotEquals
The number must not be equal to the value
-
Field Summary
Fields Modifier and Type Field Description static char
EqualsCode
The char returned from Equals.getCodeEx().static char
GreaterThanCode
The char returned from GreaterThan.getCodeEx().static char
GreaterThanOrEqualsCode
The char returned from GreaterThanOrEquals.getCodeEx().static char
LessThanCode
The char returned from LessThan.getCodeEx().static char
LessThanOrEqualsCode
The char returned from LessThanOrEquals.getCodeEx().static char
NotEqualsCode
The char returned from NotEquals.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 NumberComparisonType
safeValueOf(String value)
Helper function to return the NumberComparisonType represented byvalue
.static NumberComparisonType
valueOf(char code)
Helper function to return the NumberComparisonType represented by code.static NumberComparisonType
valueOf(Character code)
Helper function to return the NumberComparisonType represented by code.static NumberComparisonType
valueOf(String name)
Returns the enum constant of this type with the specified name.static NumberComparisonType
valueOfCode(String code)
Helper function to return the NumberComparisonType represented by code.static NumberComparisonType[]
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
-
Equals
public static final NumberComparisonType Equals
The number must be equal to the value
-
NotEquals
public static final NumberComparisonType NotEquals
The number must not be equal to the value
-
LessThan
public static final NumberComparisonType LessThan
The number must be less than the value
-
LessThanOrEquals
public static final NumberComparisonType LessThanOrEquals
The number must be less than or equal to the value
-
GreaterThan
public static final NumberComparisonType GreaterThan
The number must be greater than the value
-
GreaterThanOrEquals
public static final NumberComparisonType GreaterThanOrEquals
The number must be greater than or equal to the value
-
-
Field Detail
-
EqualsCode
public static final char EqualsCode
The char returned from Equals.getCodeEx().- See Also:
Equals
, Constant Field Values
-
NotEqualsCode
public static final char NotEqualsCode
The char returned from NotEquals.getCodeEx().- See Also:
NotEquals
, Constant Field Values
-
LessThanCode
public static final char LessThanCode
The char returned from LessThan.getCodeEx().- See Also:
LessThan
, Constant Field Values
-
LessThanOrEqualsCode
public static final char LessThanOrEqualsCode
The char returned from LessThanOrEquals.getCodeEx().- See Also:
LessThanOrEquals
, Constant Field Values
-
GreaterThanCode
public static final char GreaterThanCode
The char returned from GreaterThan.getCodeEx().- See Also:
GreaterThan
, Constant Field Values
-
GreaterThanOrEqualsCode
public static final char GreaterThanOrEqualsCode
The char returned from GreaterThanOrEquals.getCodeEx().- See Also:
GreaterThanOrEquals
, Constant Field Values
-
-
Method Detail
-
values
public static NumberComparisonType[] 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 (NumberComparisonType c : NumberComparisonType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static NumberComparisonType 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 NumberComparisonType valueOfCode(String code)
Helper function to return the NumberComparisonType 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 NumberComparisonType- Returns:
- The NumberComparisonType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static NumberComparisonType safeValueOf(String value)
Helper function to return the NumberComparisonType represented byvalue
. Ifvalue
is null, or not a valid NumberComparisonType 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 NumberComparisonType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static NumberComparisonType valueOf(Character code)
Helper function to return the NumberComparisonType represented by code. If code is null, or not a valid NumberComparisonType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The NumberComparisonType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static NumberComparisonType valueOf(char code)
Helper function to return the NumberComparisonType represented by code. If code is not a valid NumberComparisonType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The NumberComparisonType 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<NumberComparisonType>
- 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<NumberComparisonType,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<NumberComparisonType>
- 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<NumberComparisonType,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<NumberComparisonType,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<NumberComparisonType,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<NumberComparisonType>
- Returns:
- the database code for the enumeration
-
-