Enum FileParameterType
- java.lang.Object
-
- java.lang.Enum<FileParameterType>
-
- com.redwood.scheduler.api.model.enumeration.FileParameterType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<FileParameterType,Character>
,SchedulerEnumeration<FileParameterType>
,Serializable
,Comparable<FileParameterType>
public enum FileParameterType extends Enum<FileParameterType> implements SchedulerEnumeration<FileParameterType>
The type of the FileParameter. (Character Enumeration)
-
-
Enum Constant Summary
Enum Constants Enum Constant Description Document
The FileParameter data is retrieved from a Document object.JobFile
The FileParameter data is retrieved from a Process File.RelativeFile
The FileParameter data is retrieved from a Process File.
-
Field Summary
Fields Modifier and Type Field Description static char
DocumentCode
The char returned from Document.getCodeEx().static char
JobFileCode
The char returned from JobFile.getCodeEx().static char
RelativeFileCode
The char returned from RelativeFile.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 FileParameterType
safeValueOf(String value)
Helper function to return the FileParameterType represented byvalue
.static FileParameterType
valueOf(char code)
Helper function to return the FileParameterType represented by code.static FileParameterType
valueOf(Character code)
Helper function to return the FileParameterType represented by code.static FileParameterType
valueOf(String name)
Returns the enum constant of this type with the specified name.static FileParameterType
valueOfCode(String code)
Helper function to return the FileParameterType represented by code.static FileParameterType[]
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
-
JobFile
public static final FileParameterType JobFile
The FileParameter data is retrieved from a Process File.
-
RelativeFile
public static final FileParameterType RelativeFile
The FileParameter data is retrieved from a Process File.
-
Document
public static final FileParameterType Document
The FileParameter data is retrieved from a Document object.
-
-
Field Detail
-
JobFileCode
public static final char JobFileCode
The char returned from JobFile.getCodeEx().- See Also:
JobFile
, Constant Field Values
-
RelativeFileCode
public static final char RelativeFileCode
The char returned from RelativeFile.getCodeEx().- See Also:
RelativeFile
, Constant Field Values
-
DocumentCode
public static final char DocumentCode
The char returned from Document.getCodeEx().- See Also:
Document
, Constant Field Values
-
-
Method Detail
-
values
public static FileParameterType[] 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 (FileParameterType c : FileParameterType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static FileParameterType 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 FileParameterType valueOfCode(String code)
Helper function to return the FileParameterType 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 FileParameterType- Returns:
- The FileParameterType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static FileParameterType safeValueOf(String value)
Helper function to return the FileParameterType represented byvalue
. Ifvalue
is null, or not a valid FileParameterType 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 FileParameterType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static FileParameterType valueOf(Character code)
Helper function to return the FileParameterType represented by code. If code is null, or not a valid FileParameterType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The FileParameterType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static FileParameterType valueOf(char code)
Helper function to return the FileParameterType represented by code. If code is not a valid FileParameterType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The FileParameterType 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<FileParameterType>
- 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<FileParameterType,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<FileParameterType>
- 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<FileParameterType,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<FileParameterType,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<FileParameterType,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<FileParameterType>
- Returns:
- the database code for the enumeration
-
-