Package io.jenkins.plugins.gerritchecksapi

Enum Class StageForm

java.lang.Object

java.lang.Enum<StageForm>

io.jenkins.plugins.gerritchecksapi.StageForm

All Implemented Interfaces:

Serializable, Comparable<StageForm>, Constable

public enum StageForm
extends Enum<StageForm>

How the stages of a Pipeline build are reported to Gerrit.

Gerrit lists check runs as a flat list, so the stages of a build are reported as results of the run of the build: one row per build, and the stages inside it. A stage can also be reported as a check run of its own, which gives it a row and a status of its own, as it was before the results were introduced.

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
CHECK_RUNS	Report a stage as a check run of its own, nested below the run of its build.
INHERIT	Leave the setting to the enclosing folder and finally to the global configuration.
RESULTS	Report a stage as a result of the run of its build.

Method Summary

Modifier and Type	Method	Description
String	getDisplayName()	Label of the option in the configuration forms.
boolean	isSet()
static StageForm	valueOf(String name)	Returns the enum constant of this class with the specified name.
static StageForm[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

INHERIT

public static final StageForm INHERIT

Leave the setting to the enclosing folder and finally to the global configuration.

RESULTS

public static final StageForm RESULTS

Report a stage as a result of the run of its build.

CHECK_RUNS

public static final StageForm CHECK_RUNS

Report a stage as a check run of its own, nested below the run of its build.

Method Details

values

public static StageForm[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static StageForm valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

isSet

public boolean isSet()

getDisplayName

public String getDisplayName()

Label of the option in the configuration forms.