edu.rice.hj.api

Enum HjPhaserMode

java.lang.Object

java.lang.Enum<HjPhaserMode>

edu.rice.hj.api.HjPhaserMode

All Implemented Interfaces:

Serializable, Comparable<HjPhaserMode>

public enum HjPhaserMode
extends Enum<HjPhaserMode>

The allowed phaser modes.

Author:

Shams Imam (shams@rice.edu)

Enum Constant Summary

Enum Constants

Enum Constant and Description
SIG SIGNAL mode for phaser registration.
SIG_WAIT SIGNAL_WAIT mode for phaser registration.
SIG_WAIT_SINGLE SIGNAL_WAIT_SINGLE mode for phaser registration.
WAIT WAIT mode for phaser registration.

Field Summary

Fields

Modifier and Type	Field and Description
static HjPhaserMode	DEFAULT_MODE The default phaser registration mode.

Method Summary

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

SIG

public static final HjPhaserMode SIG

SIGNAL mode for phaser registration.

WAIT

public static final HjPhaserMode WAIT

WAIT mode for phaser registration.

SIG_WAIT

public static final HjPhaserMode SIG_WAIT

SIGNAL_WAIT mode for phaser registration.

SIG_WAIT_SINGLE

public static final HjPhaserMode SIG_WAIT_SINGLE

SIGNAL_WAIT_SINGLE mode for phaser registration.

Field Detail

DEFAULT_MODE

public static final HjPhaserMode DEFAULT_MODE

The default phaser registration mode. Equivalent to SIG_WAIT_SINGLE.

Method Detail

values

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

Returns:

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

valueOf

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