com.ibm.mqlight.api

Enum ClientState

java.lang.Object

java.lang.Enum<ClientState>

com.ibm.mqlight.api.ClientState

All Implemented Interfaces:

Serializable, Comparable<ClientState>

public enum ClientState
extends Enum<ClientState>

An enumeration used to describe the state of the MQ Light client. This is the state machine backing the client:

Enum Constant Summary

Enum Constants

Enum Constant and Description
RETRYING
STARTED
STARTING
STOPPED
STOPPING

Method Summary

Methods

Modifier and Type	Method and Description
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

STARTING

public static final ClientState STARTING

STARTED

public static final ClientState STARTED

STOPPING

public static final ClientState STOPPING

STOPPED

public static final ClientState STOPPED

RETRYING

public static final ClientState RETRYING

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