org.azyva.dragom.jenkins

Enum JenkinsClient.BuildState

java.lang.Object

java.lang.Enum<JenkinsClient.BuildState>

org.azyva.dragom.jenkins.JenkinsClient.BuildState

All Implemented Interfaces:

Serializable, Comparable<JenkinsClient.BuildState>

Enclosing interface:

JenkinsClient

public static enum JenkinsClient.BuildState
extends Enum<JenkinsClient.BuildState>

Build states.

Enum Constant Summary

Enum Constants

Enum Constant and Description
ABORTED Build has been aborted while it was running.
CANCELLED Build has been cancelled while it was queued.
FAILED Build is completed and is FAILED.
QUEUED Build is queued and not running yet.
RUNNING Build is running.
SUCCESS Build completed with SUCCESS.
UNSTABLE Build is completed and is UNSTABLE.

Method Summary

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

QUEUED

public static final JenkinsClient.BuildState QUEUED

Build is queued and not running yet.

CANCELLED

public static final JenkinsClient.BuildState CANCELLED

Build has been cancelled while it was queued.

This is similar to ABORTED, except that the build was never RUNNING.

RUNNING

public static final JenkinsClient.BuildState RUNNING

Build is running.

ABORTED

public static final JenkinsClient.BuildState ABORTED

Build has been aborted while it was running.

This is similar to CANCELLED, except that the build was RUNNING.

FAILED

public static final JenkinsClient.BuildState FAILED

Build is completed and is FAILED.

UNSTABLE

public static final JenkinsClient.BuildState UNSTABLE

Build is completed and is UNSTABLE.

SUCCESS

public static final JenkinsClient.BuildState SUCCESS

Build completed with SUCCESS.

Method Detail

values

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

Returns:

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

valueOf

public static JenkinsClient.BuildState 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

isOutOfQueue

public boolean isOutOfQueue()

Returns:

Indicates if the build is out of the queue (is running or completed).

isCompleted

public boolean isCompleted()

Returns:

Indicates if the build is completed.