Package com.redwood.scheduler.api.model.enumeration

Enum HTTPRequestSubstitutionLocation

java.lang.Object

java.lang.Enum<HTTPRequestSubstitutionLocation>

com.redwood.scheduler.api.model.enumeration.HTTPRequestSubstitutionLocation

All Implemented Interfaces:

BaseSchedulerEnumeration<HTTPRequestSubstitutionLocation,Character>, SchedulerEnumeration<HTTPRequestSubstitutionLocation>, Serializable, Comparable<HTTPRequestSubstitutionLocation>

public enum HTTPRequestSubstitutionLocation
extends Enum<HTTPRequestSubstitutionLocation>
implements SchedulerEnumeration<HTTPRequestSubstitutionLocation>

Substitution locations for R2W requests. (Character Enumeration)

Enum Constant Summary

Enum Constants

Enum Constant	Description
AuthorizationHeader	HTTP Header Authorization
Body	Request body.

Field Summary

Fields

Modifier and Type	Field	Description
static char	AuthorizationHeaderCode	The char returned from AuthorizationHeader.getCodeEx().
static char	BodyCode	The char returned from Body.getCodeEx().

Method Summary

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 HTTPRequestSubstitutionLocation	safeValueOf(String value)	Helper function to return the HTTPRequestSubstitutionLocation represented by value.
static HTTPRequestSubstitutionLocation	valueOf(char code)	Helper function to return the HTTPRequestSubstitutionLocation represented by code.
static HTTPRequestSubstitutionLocation	valueOf(Character code)	Helper function to return the HTTPRequestSubstitutionLocation represented by code.
static HTTPRequestSubstitutionLocation	valueOf(String name)	Returns the enum constant of this type with the specified name.
static HTTPRequestSubstitutionLocation	valueOfCode(String code)	Helper function to return the HTTPRequestSubstitutionLocation represented by code.
static HTTPRequestSubstitutionLocation[]	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 class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface com.redwood.scheduler.api.model.enumeration.BaseSchedulerEnumeration

name, ordinal

Methods inherited from interface java.lang.Comparable

compareTo

Enum Constant Detail

Body

public static final HTTPRequestSubstitutionLocation Body

Request body.

AuthorizationHeader

public static final HTTPRequestSubstitutionLocation AuthorizationHeader

HTTP Header Authorization

Field Detail

BodyCode

public static final char BodyCode

The char returned from Body.getCodeEx().

See Also:

Body, Constant Field Values

AuthorizationHeaderCode

public static final char AuthorizationHeaderCode

The char returned from AuthorizationHeader.getCodeEx().

See Also:

AuthorizationHeader, Constant Field Values

Method Detail

values

public static HTTPRequestSubstitutionLocation[] 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 (HTTPRequestSubstitutionLocation c : HTTPRequestSubstitutionLocation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static HTTPRequestSubstitutionLocation 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 name

NullPointerException - if the argument is null

valueOfCode

public static HTTPRequestSubstitutionLocation valueOfCode(String code)

Helper function to return the HTTPRequestSubstitutionLocation 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 HTTPRequestSubstitutionLocation

Returns:

The HTTPRequestSubstitutionLocation corresponding to code, or null, if code is null, longer than one character, or not a valid code

safeValueOf

public static HTTPRequestSubstitutionLocation safeValueOf(String value)

Helper function to return the HTTPRequestSubstitutionLocation represented by value. If value is null, or not a valid HTTPRequestSubstitutionLocation 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 invalid value, valueOf(String) will throw an IllegalArgumentException.

Parameters:

value - The string value that corresponds to the requested enumeration value

Returns:

The HTTPRequestSubstitutionLocation corresponding to value, or null, if value is null, or not a valid enumeration

See Also:

valueOf(String)

valueOf

public static HTTPRequestSubstitutionLocation valueOf(Character code)

Helper function to return the HTTPRequestSubstitutionLocation represented by code. If code is null, or not a valid HTTPRequestSubstitutionLocation code then this method will return null.

Parameters:

code - Character that is one of the codes for HandlerAction

Returns:

The HTTPRequestSubstitutionLocation corresponding to code, or null, if code is null, or not a valid code

valueOf

public static HTTPRequestSubstitutionLocation valueOf(char code)

Helper function to return the HTTPRequestSubstitutionLocation represented by code. If code is not a valid HTTPRequestSubstitutionLocation code then this method will return null.

Parameters:

code - char that is one of the codes for HandlerAction

Returns:

The HTTPRequestSubstitutionLocation 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 interface SchedulerEnumeration<HTTPRequestSubstitutionLocation>

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 interface BaseSchedulerEnumeration<HTTPRequestSubstitutionLocation,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 interface SchedulerEnumeration<HTTPRequestSubstitutionLocation>

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 interface BaseSchedulerEnumeration<HTTPRequestSubstitutionLocation,Character>

Returns:

the key.

getTranslationEN

public String getTranslationEN()

Description copied from interface: BaseSchedulerEnumeration

Get the English name of this enumeration.

Specified by:

getTranslationEN in interface BaseSchedulerEnumeration<HTTPRequestSubstitutionLocation,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 interface BaseSchedulerEnumeration<HTTPRequestSubstitutionLocation,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 interface SchedulerEnumeration<HTTPRequestSubstitutionLocation>

Returns:

the database code for the enumeration