Package org.jppf.client

Enum Class JPPFClientConnectionStatus

java.lang.Object

java.lang.Enum<JPPFClientConnectionStatus>

org.jppf.client.JPPFClientConnectionStatus

All Implemented Interfaces:

Serializable, Comparable<JPPFClientConnectionStatus>, Constable

public enum JPPFClientConnectionStatus
extends Enum<JPPFClientConnectionStatus>

Status of the connection between a client and a driver.

Author:

Laurent Cohen

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
ACTIVE	The connection is successfully connected to the driver.
CLOSED	The connection was closed by the application.
CONNECTING	The connection is currently attempting to connect to the driver.
DISCONNECTED	The connection was disconnected from the driver.
EXECUTING	The connection is currently executing a job.
FAILED	The connection failed to (re)connect to the driver and no further attempt will be made.
NEW	The connection was just created.

Method Summary

Modifier and Type	Method	Description
boolean	isOneOf(List<JPPFClientConnectionStatus> statuses)	Determine whether this status is one of those specified as input.
boolean	isTerminatedStatus()	Determine whether this status a working status, that is if it is either FAILED or CLOSED.
boolean	isWorkingStatus()	Determine whether this status a working status, that is if it is either ACTIVE or EXECUTING.
static JPPFClientConnectionStatus[]	terminatedStatuses()	Get the statuses indicating that a connection is in a terminated state.
static JPPFClientConnectionStatus	valueOf(String name)	Returns the enum constant of this class with the specified name.
static JPPFClientConnectionStatus[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.
static JPPFClientConnectionStatus[]	workingStatuses()	Get the statuses indicating that a connection is in a working state.

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

NEW

public static final JPPFClientConnectionStatus NEW

The connection was just created.

DISCONNECTED

public static final JPPFClientConnectionStatus DISCONNECTED

The connection was disconnected from the driver.

CONNECTING

public static final JPPFClientConnectionStatus CONNECTING

The connection is currently attempting to connect to the driver.

ACTIVE

public static final JPPFClientConnectionStatus ACTIVE

The connection is successfully connected to the driver.

EXECUTING

public static final JPPFClientConnectionStatus EXECUTING

The connection is currently executing a job.

FAILED

public static final JPPFClientConnectionStatus FAILED

The connection failed to (re)connect to the driver and no further attempt will be made.

CLOSED

public static final JPPFClientConnectionStatus CLOSED

The connection was closed by the application.

Method Details

values

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

isOneOf

public boolean isOneOf(List<JPPFClientConnectionStatus> statuses)

Determine whether this status is one of those specified as input.

Parameters:

statuses - the statuses to check against.

Returns:

true if this status is one of those specified as input, false otherwise.

isWorkingStatus

public boolean isWorkingStatus()

Determine whether this status a working status, that is if it is either ACTIVE or EXECUTING.

Returns:

true if this status is a working status, false otherwise.

isTerminatedStatus

public boolean isTerminatedStatus()

Determine whether this status a working status, that is if it is either FAILED or CLOSED.

Returns:

true if this status is a working status, false otherwise.

workingStatuses

public static JPPFClientConnectionStatus[] workingStatuses()

Get the statuses indicating that a connection is in a working state.

Returns:

an array of JPPFClientConnectionStatus enum values.

terminatedStatuses

public static JPPFClientConnectionStatus[] terminatedStatuses()

Get the statuses indicating that a connection is in a terminated state.

Returns:

an array of JPPFClientConnectionStatus enum values.