Enum EnvironmentNames
- java.lang.Object
-
- java.lang.Enum<EnvironmentNames>
-
- org.jenkinsci.plugins.pipeline.modeldefinition.when.utils.EnvironmentNames
-
- All Implemented Interfaces:
Serializable
,Comparable<EnvironmentNames>
public enum EnvironmentNames extends Enum<EnvironmentNames>
Easier way to refer to and extract known environment variables instead of copying strings back and forth.
-
-
Enum Constant Summary
Enum Constants Enum Constant Description CHANGE_AUTHOR
CHANGE_AUTHOR_DISPLAY_NAME
CHANGE_AUTHOR_EMAIL
CHANGE_BRANCH
CHANGE_FORK
CHANGE_ID
CHANGE_TARGET
CHANGE_TITLE
CHANGE_URL
-
Method Summary
All Methods Static Methods Instance Methods Concrete Methods Modifier and Type Method Description boolean
exists(EnvVars vars)
String
get(EnvVars vars)
boolean
isEmpty(EnvVars vars)
static EnvironmentNames
valueOf(String name)
Returns the enum constant of this type with the specified name.static EnvironmentNames[]
values()
Returns an array containing the constants of this enum type, in the order they are declared.
-
-
-
Enum Constant Detail
-
CHANGE_ID
public static final EnvironmentNames CHANGE_ID
-
CHANGE_TARGET
public static final EnvironmentNames CHANGE_TARGET
-
CHANGE_BRANCH
public static final EnvironmentNames CHANGE_BRANCH
-
CHANGE_FORK
public static final EnvironmentNames CHANGE_FORK
-
CHANGE_URL
public static final EnvironmentNames CHANGE_URL
-
CHANGE_TITLE
public static final EnvironmentNames CHANGE_TITLE
-
CHANGE_AUTHOR
public static final EnvironmentNames CHANGE_AUTHOR
-
CHANGE_AUTHOR_DISPLAY_NAME
public static final EnvironmentNames CHANGE_AUTHOR_DISPLAY_NAME
-
CHANGE_AUTHOR_EMAIL
public static final EnvironmentNames CHANGE_AUTHOR_EMAIL
-
-
Method Detail
-
values
public static EnvironmentNames[] 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 (EnvironmentNames c : EnvironmentNames.values()) System.out.println(c);
- Returns:
- an array containing the constants of this enum type, in the order they are declared
-
valueOf
public static EnvironmentNames 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
-
exists
public boolean exists(EnvVars vars)
-
isEmpty
public boolean isEmpty(EnvVars vars)
-
-