com.ibm.rational.test.lt.recorder.core.session

Enum ClientState

java.lang.Object

java.lang.Enum<ClientState>

com.ibm.rational.test.lt.recorder.core.session.ClientState

All Implemented Interfaces:

com.ibm.rational.test.lt.recorder.core.internal.session.IRecorderComponentState, Serializable, Comparable<ClientState>

public enum ClientState
extends Enum<ClientState>
implements com.ibm.rational.test.lt.recorder.core.internal.session.IRecorderComponentState

The states of a IClient.

Enum Constant Summary

Enum Constants

Enum Constant and Description
INITIAL The client has not been started yet.
RUNNING The client is running and initiating traffic.
STARTING The client has been started but is not ready yet.
STOPPING The client has been asked to stop, but has not terminated yet.
TERMINATED The client is terminated.

Method Summary

Methods

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

INITIAL

public static final ClientState INITIAL

The client has not been started yet. This is the initial state of a client. A client cannot go back to this state once it has been started.

STARTING

public static final ClientState STARTING

The client has been started but is not ready yet.

RUNNING

public static final ClientState RUNNING

The client is running and initiating traffic.

STOPPING

public static final ClientState STOPPING

The client has been asked to stop, but has not terminated yet.

TERMINATED

public static final ClientState TERMINATED

The client is terminated. This is the final state.

Method Detail

values

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

Returns:

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

valueOf

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

getLabel

public String getLabel()