Package org.jenkins.plugins.lockableresources.remote

Enum Class RemoteLockState

java.lang.Object

java.lang.Enum<RemoteLockState>

org.jenkins.plugins.lockableresources.remote.RemoteLockState

All Implemented Interfaces:

Serializable, Comparable<RemoteLockState>, Constable

public enum RemoteLockState
extends Enum<RemoteLockState>

Server-side state of a remote lock record. Distinct from the client-facing RemoteAcquireState.

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
ACQUIRED	Resource is locked; client must send periodic heartbeats.
FAILED	Acquire failed (e.g.
QUEUED	Waiting to acquire the resource (resource is currently busy).
SKIPPED	Resource was already locked and skipIfLocked=true was requested.
STALE	Heartbeat timed out; resource is held pending admin review.

Method Summary

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

QUEUED

public static final RemoteLockState QUEUED

Waiting to acquire the resource (resource is currently busy).

ACQUIRED

public static final RemoteLockState ACQUIRED

Resource is locked; client must send periodic heartbeats.

SKIPPED

public static final RemoteLockState SKIPPED

Resource was already locked and skipIfLocked=true was requested.

FAILED

public static final RemoteLockState FAILED

Acquire failed (e.g. resource not found).

STALE

public static final RemoteLockState STALE

Heartbeat timed out; resource is held pending admin review.

Method Details

values

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