brahms.communication
Enum RunState

java.lang.Object
  java.lang.Enum<RunState>
      brahms.communication.RunState

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<RunState>

public enum RunState
extends java.lang.Enum<RunState>

The possible RunStates of a communication agent.

Version:

$Revision: 1.1 $ $Date: 2007/10/10 14:03:00 $ $Author: rvhoof $

Author:

Ron van Hoof

Enum Constant Summary

PAUSED

STARTED

STOPPED

Method Summary

static RunState	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static RunState[]	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

STARTED

public static final RunState STARTED

PAUSED

public static final RunState PAUSED

STOPPED

public static final RunState STOPPED

Method Detail

values

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

Returns:

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

valueOf

public static RunState valueOf(java.lang.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:

java.lang.IllegalArgumentException - if this enum type has no constant with the specified name

java.lang.NullPointerException - if the argument is null