Enum JobFileType
- java.lang.Object
-
- java.lang.Enum<JobFileType>
-
- com.redwood.scheduler.api.model.enumeration.JobFileType
-
- All Implemented Interfaces:
BaseSchedulerEnumeration<JobFileType,Character>
,SchedulerEnumeration<JobFileType>
,Serializable
,Comparable<JobFileType>
public enum JobFileType extends Enum<JobFileType> implements SchedulerEnumeration<JobFileType>
-
-
Field Summary
Fields Modifier and Type Field Description static char
InputCode
The char returned from Input.getCodeEx().static char
LogCode
The char returned from Log.getCodeEx().static char
OutputCode
The char returned from Output.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
getDefaultExtension()
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 JobFileType
safeValueOf(String value)
Helper function to return the JobFileType represented byvalue
.static JobFileType
valueOf(char code)
Helper function to return the JobFileType represented by code.static JobFileType
valueOf(Character code)
Helper function to return the JobFileType represented by code.static JobFileType
valueOf(String name)
Returns the enum constant of this type with the specified name.static JobFileType
valueOfCode(String code)
Helper function to return the JobFileType represented by code.static JobFileType[]
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
-
Input
public static final JobFileType Input
An input stream from a process. This is typically an archive file
-
Output
public static final JobFileType Output
An output stream from a process. This is typically a text stream. This file is created from the Process itself.
-
Log
public static final JobFileType Log
A log file created from running a process. This is a text stream. This file is created by the Service that is running the Process.
-
-
Field Detail
-
InputCode
public static final char InputCode
The char returned from Input.getCodeEx().- See Also:
Input
, Constant Field Values
-
OutputCode
public static final char OutputCode
The char returned from Output.getCodeEx().- See Also:
Output
, Constant Field Values
-
LogCode
public static final char LogCode
The char returned from Log.getCodeEx().- See Also:
Log
, Constant Field Values
-
-
Method Detail
-
values
public static JobFileType[] 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 (JobFileType c : JobFileType.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static JobFileType 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
-
getDefaultExtension
public String getDefaultExtension()
-
valueOfCode
public static JobFileType valueOfCode(String code)
Helper function to return the JobFileType 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 JobFileType- Returns:
- The JobFileType corresponding to code, or null, if code is null, longer than one character, or not a valid code
-
safeValueOf
public static JobFileType safeValueOf(String value)
Helper function to return the JobFileType represented byvalue
. Ifvalue
is null, or not a valid JobFileType 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 JobFileType corresponding to
value
, or null, ifvalue
is null, or not a valid enumeration - See Also:
valueOf(String)
-
valueOf
public static JobFileType valueOf(Character code)
Helper function to return the JobFileType represented by code. If code is null, or not a valid JobFileType code then this method will return null.- Parameters:
code
- Character that is one of the codes for HandlerAction- Returns:
- The JobFileType corresponding to code, or null, if code is null, or not a valid code
-
valueOf
public static JobFileType valueOf(char code)
Helper function to return the JobFileType represented by code. If code is not a valid JobFileType code then this method will return null.- Parameters:
code
- char that is one of the codes for HandlerAction- Returns:
- The JobFileType 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<JobFileType>
- 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<JobFileType,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<JobFileType>
- 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<JobFileType,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<JobFileType,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<JobFileType,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<JobFileType>
- Returns:
- the database code for the enumeration
-
-