Enum MonitorValueAggregateEntryType
- java.lang.Object
-
- java.lang.Enum<MonitorValueAggregateEntryType>
-
- com.redwood.scheduler.api.model.enumeration.MonitorValueAggregateEntryType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<MonitorValueAggregateEntryType,Character>
,SchedulerEnumeration<MonitorValueAggregateEntryType>
,Serializable
,Comparable<MonitorValueAggregateEntryType>
public enum MonitorValueAggregateEntryType extends Enum<MonitorValueAggregateEntryType> implements SchedulerEnumeration<MonitorValueAggregateEntryType>
What type of aggregate entry (bucket) we are dealing with. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description MaximumEdge
Greatest bucket, all values greater than or equal to this value are in this bucketMinimumEdge
Smallest bucket, all values less than this value are in this bucketNormal
Normal valid bucketUnknown
All unknown data (no value) is in this bucket
-
Field Summary
Fields Modifier and Type Field Description static char
MaximumEdgeCode
The char returned from MaximumEdge.getCodeEx().static char
MinimumEdgeCode
The char returned from MinimumEdge.getCodeEx().static char
NormalCode
The char returned from Normal.getCodeEx().static char
UnknownCode
The char returned from Unknown.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 MonitorValueAggregateEntryType
safeValueOf(String value)
Helper function to return the MonitorValueAggregateEntryType represented byvalue
.static MonitorValueAggregateEntryType
valueOf(char code)
Helper function to return the MonitorValueAggregateEntryType represented by code.static MonitorValueAggregateEntryType
valueOf(Character code)
Helper function to return the MonitorValueAggregateEntryType represented by code.static MonitorValueAggregateEntryType
valueOf(String name)
Returns the enum constant of this type with the specified name.static MonitorValueAggregateEntryType
valueOfCode(String code)
Helper function to return the MonitorValueAggregateEntryType represented by code.static MonitorValueAggregateEntryType[]
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
-
MinimumEdge
public static final MonitorValueAggregateEntryType MinimumEdge
Smallest bucket, all values less than this value are in this bucket
-
MaximumEdge
public static final MonitorValueAggregateEntryType MaximumEdge
Greatest bucket, all values greater than or equal to this value are in this bucket
-
Normal
public static final MonitorValueAggregateEntryType Normal
Normal valid bucket
-
Unknown
public static final MonitorValueAggregateEntryType Unknown
All unknown data (no value) is in this bucket
-
-
Field Detail
-
MinimumEdgeCode
public static final char MinimumEdgeCode
The char returned from MinimumEdge.getCodeEx().- See Also:
MinimumEdge
, Constant Field Values
-
MaximumEdgeCode
public static final char MaximumEdgeCode
The char returned from MaximumEdge.getCodeEx().- See Also:
MaximumEdge
, Constant Field Values
-
NormalCode
public static final char NormalCode
The char returned from Normal.getCodeEx().- See Also:
Normal
, Constant Field Values
-
UnknownCode
public static final char UnknownCode
The char returned from Unknown.getCodeEx().- See Also:
Unknown
, Constant Field Values
-
-
Method Detail
-
values
public static MonitorValueAggregateEntryType[] 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 (MonitorValueAggregateEntryType c : MonitorValueAggregateEntryType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static MonitorValueAggregateEntryType 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 MonitorValueAggregateEntryType valueOfCode(String code)
Helper function to return the MonitorValueAggregateEntryType 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 MonitorValueAggregateEntryType- Returns:
- The MonitorValueAggregateEntryType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static MonitorValueAggregateEntryType safeValueOf(String value)
Helper function to return the MonitorValueAggregateEntryType represented byvalue
. Ifvalue
is null, or not a valid MonitorValueAggregateEntryType 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 MonitorValueAggregateEntryType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static MonitorValueAggregateEntryType valueOf(Character code)
Helper function to return the MonitorValueAggregateEntryType represented by code. If code is null, or not a valid MonitorValueAggregateEntryType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The MonitorValueAggregateEntryType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static MonitorValueAggregateEntryType valueOf(char code)
Helper function to return the MonitorValueAggregateEntryType represented by code. If code is not a valid MonitorValueAggregateEntryType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The MonitorValueAggregateEntryType 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<MonitorValueAggregateEntryType>
- 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<MonitorValueAggregateEntryType,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<MonitorValueAggregateEntryType>
- 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<MonitorValueAggregateEntryType,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<MonitorValueAggregateEntryType,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<MonitorValueAggregateEntryType,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<MonitorValueAggregateEntryType>
- Returns:
- the database code for the enumeration
-
-