io.jenkins.plugins.checks.api

Enum ChecksConclusion

java.lang.Object

java.lang.Enum<ChecksConclusion>

io.jenkins.plugins.checks.api.ChecksConclusion

All Implemented Interfaces:

Serializable, Comparable<ChecksConclusion>

public enum ChecksConclusion
extends Enum<ChecksConclusion>

Conclusion for a specific check. One of the conclusions (except the NONE, which is used to represent "no conclusion yet") should be provided when the ChecksStatus of a check is set to ChecksStatus.COMPLETED.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ACTION_REQUIRED
CANCELED
FAILURE
NEUTRAL
NONE
SKIPPED
SUCCESS
TIME_OUT

Method Summary

Modifier and Type	Method and Description
static ChecksConclusion	valueOf(String name) Returns the enum constant of this type with the specified name.
static ChecksConclusion[]	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

Enum Constant Detail

NONE

public static final ChecksConclusion NONE

ACTION_REQUIRED

public static final ChecksConclusion ACTION_REQUIRED

SKIPPED

public static final ChecksConclusion SKIPPED

CANCELED

public static final ChecksConclusion CANCELED

TIME_OUT

public static final ChecksConclusion TIME_OUT

FAILURE

public static final ChecksConclusion FAILURE

NEUTRAL

public static final ChecksConclusion NEUTRAL

SUCCESS

public static final ChecksConclusion SUCCESS

Method Detail

values

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

Returns:

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

valueOf

public static ChecksConclusion 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