Enum AuditNameMatchType
- java.lang.Object
-
- java.lang.Enum<AuditNameMatchType>
-
- com.redwood.scheduler.api.model.enumeration.AuditNameMatchType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<AuditNameMatchType,Character>
,SchedulerEnumeration<AuditNameMatchType>
,Serializable
,Comparable<AuditNameMatchType>
public enum AuditNameMatchType extends Enum<AuditNameMatchType> implements SchedulerEnumeration<AuditNameMatchType>
The type of matching to use. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description ExactCaseInsensitive
Use an exact case insensitive match.ExactCaseSensitive
Use an exact case sensitive match.GlobCaseInsensitive
Match using a case insensitive Glob expression.GlobCaseSensitive
Match using a case sensitive Glob expression.RegExCaseInsensitive
Match using a case insensitive regular expressionRegExCaseSensitive
Match using a regular expression
-
Field Summary
Fields Modifier and Type Field Description static char
ExactCaseInsensitiveCode
The char returned from ExactCaseInsensitive.getCodeEx().static char
ExactCaseSensitiveCode
The char returned from ExactCaseSensitive.getCodeEx().static char
GlobCaseInsensitiveCode
The char returned from GlobCaseInsensitive.getCodeEx().static char
GlobCaseSensitiveCode
The char returned from GlobCaseSensitive.getCodeEx().static char
RegExCaseInsensitiveCode
The char returned from RegExCaseInsensitive.getCodeEx().static char
RegExCaseSensitiveCode
The char returned from RegExCaseSensitive.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.BiPredicate<String,String>
getNameMatches()
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 AuditNameMatchType
safeValueOf(String value)
Helper function to return the AuditNameMatchType represented byvalue
.static AuditNameMatchType
valueOf(char code)
Helper function to return the AuditNameMatchType represented by code.static AuditNameMatchType
valueOf(Character code)
Helper function to return the AuditNameMatchType represented by code.static AuditNameMatchType
valueOf(String name)
Returns the enum constant of this type with the specified name.static AuditNameMatchType
valueOfCode(String code)
Helper function to return the AuditNameMatchType represented by code.static AuditNameMatchType[]
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
-
RegExCaseSensitive
public static final AuditNameMatchType RegExCaseSensitive
Match using a regular expression
-
RegExCaseInsensitive
public static final AuditNameMatchType RegExCaseInsensitive
Match using a case insensitive regular expression
-
GlobCaseSensitive
public static final AuditNameMatchType GlobCaseSensitive
Match using a case sensitive Glob expression.
-
GlobCaseInsensitive
public static final AuditNameMatchType GlobCaseInsensitive
Match using a case insensitive Glob expression.
-
ExactCaseSensitive
public static final AuditNameMatchType ExactCaseSensitive
Use an exact case sensitive match.
-
ExactCaseInsensitive
public static final AuditNameMatchType ExactCaseInsensitive
Use an exact case insensitive match.
-
-
Field Detail
-
RegExCaseSensitiveCode
public static final char RegExCaseSensitiveCode
The char returned from RegExCaseSensitive.getCodeEx().- See Also:
RegExCaseSensitive
, Constant Field Values
-
RegExCaseInsensitiveCode
public static final char RegExCaseInsensitiveCode
The char returned from RegExCaseInsensitive.getCodeEx().- See Also:
RegExCaseInsensitive
, Constant Field Values
-
GlobCaseSensitiveCode
public static final char GlobCaseSensitiveCode
The char returned from GlobCaseSensitive.getCodeEx().- See Also:
GlobCaseSensitive
, Constant Field Values
-
GlobCaseInsensitiveCode
public static final char GlobCaseInsensitiveCode
The char returned from GlobCaseInsensitive.getCodeEx().- See Also:
GlobCaseInsensitive
, Constant Field Values
-
ExactCaseSensitiveCode
public static final char ExactCaseSensitiveCode
The char returned from ExactCaseSensitive.getCodeEx().- See Also:
ExactCaseSensitive
, Constant Field Values
-
ExactCaseInsensitiveCode
public static final char ExactCaseInsensitiveCode
The char returned from ExactCaseInsensitive.getCodeEx().- See Also:
ExactCaseInsensitive
, Constant Field Values
-
-
Method Detail
-
values
public static AuditNameMatchType[] 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 (AuditNameMatchType c : AuditNameMatchType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static AuditNameMatchType 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
-
getNameMatches
public BiPredicate<String,String> getNameMatches()
-
valueOfCode
public static AuditNameMatchType valueOfCode(String code)
Helper function to return the AuditNameMatchType 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 AuditNameMatchType- Returns:
- The AuditNameMatchType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static AuditNameMatchType safeValueOf(String value)
Helper function to return the AuditNameMatchType represented byvalue
. Ifvalue
is null, or not a valid AuditNameMatchType 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 AuditNameMatchType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static AuditNameMatchType valueOf(Character code)
Helper function to return the AuditNameMatchType represented by code. If code is null, or not a valid AuditNameMatchType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The AuditNameMatchType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static AuditNameMatchType valueOf(char code)
Helper function to return the AuditNameMatchType represented by code. If code is not a valid AuditNameMatchType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The AuditNameMatchType 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<AuditNameMatchType>
- 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<AuditNameMatchType,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<AuditNameMatchType>
- 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<AuditNameMatchType,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<AuditNameMatchType,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<AuditNameMatchType,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<AuditNameMatchType>
- Returns:
- the database code for the enumeration
-
-