org.jrebirth.af.api.wave

Enum Wave.Status

java.lang.Object

java.lang.Enum<Wave.Status>

org.jrebirth.af.api.wave.Wave.Status

All Implemented Interfaces:

Serializable, Comparable<Wave.Status>

Enclosing interface:

Wave

public static enum Wave.Status
extends Enum<Wave.Status>

The enumeration Status.

Author:

Sébastien Bordes

Enum Constant Summary

Enum Constants

Enum Constant and Description
Cancelled The wave has just been cancelled.
Consumed The wave is being consumed.
Created The wave has just been created, it's the default status.
Destroyed The wave has just been destroyed.
Failed The wave processing has failed.
Handled The wave has been performed by all handlers.
Processing The wave is being processing.
Sent The wave has just been sent.

Method Summary

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

Created

public static final Wave.Status Created

The wave has just been created, it's the default status.

Sent

public static final Wave.Status Sent

The wave has just been sent.

Processing

public static final Wave.Status Processing

The wave is being processing.

Cancelled

public static final Wave.Status Cancelled

The wave has just been cancelled.

Consumed

public static final Wave.Status Consumed

The wave is being consumed.

Handled

public static final Wave.Status Handled

The wave has been performed by all handlers.

Failed

public static final Wave.Status Failed

The wave processing has failed.

Destroyed

public static final Wave.Status Destroyed

The wave has just been destroyed.

Method Detail

values

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

Returns:

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

valueOf

public static Wave.Status 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