Package io.jenkins.plugins.interactiveinput.model

Enum Class QuestionStatus

java.lang.Object

java.lang.Enum<QuestionStatus>

io.jenkins.plugins.interactiveinput.model.QuestionStatus

All Implemented Interfaces:

Serializable, Comparable<QuestionStatus>, Constable

public enum QuestionStatus
extends Enum<QuestionStatus>

Lifecycle state of a human-in-the-loop Question.

Transitions are strictly forward: WAITING -> (ANSWERED | ABORTED | EXPIRED). A question never leaves a terminal state.

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
ABORTED	A human (or the pipeline) aborted the input; the pipeline received an abort.
ANSWERED	A human submitted an answer (choice or free text); the pipeline has resumed.
EXPIRED	The SLA elapsed with no answer; the pipeline received a timeout.
WAITING	The pipeline is paused and waiting for a human to answer.

Method Summary

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

WAITING

public static final QuestionStatus WAITING

The pipeline is paused and waiting for a human to answer.

ANSWERED

public static final QuestionStatus ANSWERED

A human submitted an answer (choice or free text); the pipeline has resumed.

ABORTED

public static final QuestionStatus ABORTED

A human (or the pipeline) aborted the input; the pipeline received an abort.

EXPIRED

public static final QuestionStatus EXPIRED

The SLA elapsed with no answer; the pipeline received a timeout.

Method Details

values

public static QuestionStatus[] 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 QuestionStatus 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

isTerminal

public boolean isTerminal()

Returns:

true if this is a terminal state (no further transitions allowed).