org.ow2.proactive.resourcemanager.common

Enum NodeState

java.lang.Object

java.lang.Enum<NodeState>

org.ow2.proactive.resourcemanager.common.NodeState

All Implemented Interfaces:

Serializable, Comparable<NodeState>

@PublicAPI
public enum NodeState
extends Enum<NodeState>

Enumeration of all states of a RMNode :
-deploying : node deployment is on going.
-lost : node deployment failed.
-free : node is ready to perform a task.
-configuring: node has been added to the RM but is in configuring state, not ready to perform a task.
-busy : node is executing a task.
-to be removed : node is busy and have to be removed at the end of its current task.
-down : node is broken, and not anymore able to perform tasks.

Since:

ProActive Scheduling 0.9

Enum Constant Summary

Enum Constants

Enum Constant and Description
BUSY a node provided to a RM user.
CONFIGURING a node cannot be provided to a RM user, it is under configuration
DEPLOYING a node for which one the deployment process has been triggered but which is not registered yet.
DOWN a node that has been detected down.
FREE a node that can be provided to a RM user, and able to perform a task
LOST a node for which one the deployment process failed
TO_BE_REMOVED a busy node which must be removed from resource manager when the user will give back the node.

Method Summary

Modifier and Type	Method and Description
static NodeState	parse(String value) Returns the enum constant of the specified NodeState with the specified description.
String	toString() Returns a string representation of the state.
static NodeState	valueOf(String name) Returns the enum constant of this type with the specified name.
static NodeState[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

FREE

public static final NodeState FREE

a node that can be provided to a RM user, and able to perform a task

BUSY

public static final NodeState BUSY

a node provided to a RM user.

DOWN

public static final NodeState DOWN

a node that has been detected down.

TO_BE_REMOVED

public static final NodeState TO_BE_REMOVED

a busy node which must be removed from resource manager when the user will give back the node.

DEPLOYING

public static final NodeState DEPLOYING

a node for which one the deployment process has been triggered but which is not registered yet.

LOST

public static final NodeState LOST

a node for which one the deployment process failed

CONFIGURING

public static final NodeState CONFIGURING

a node cannot be provided to a RM user, it is under configuration

Method Detail

values

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

Returns:

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

valueOf

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

parse

public static NodeState parse(String value)

Returns the enum constant of the specified NodeState with the specified description.

Parameters:

value - the value returned by toString().

Returns:

enum instance corresponding the String representation provided.

Throws:

IllegalArgumentException - if the specified enum type has no constant with the specified name, or the specified class object does not represent an enum type.

NullPointerException - if enumType or name is null.

toString

public String toString()

Returns a string representation of the state.

Overrides:

toString in class Enum<NodeState>

Returns:

String representation of the state.