org.josef.science.physics

Enum Phase

java.lang.Object

java.lang.Enum<Phase>

org.josef.science.physics.Phase

All Implemented Interfaces:

Serializable, Comparable<Phase>

@Status(stage=DEVELOPMENT,
        unitTests=ABSENT)
 @Review(by="Kees Schotanus",
        at="2009-11-08",
        reason="Initial review")
public enum Phase
extends Enum<Phase>

Enumeration of the different phases and their possible transitions.
A Phase uses a nested EnumMap to associate data with enum pairs.

Version:

1.0 $Revision: 5460 $

Author:

Joshua Bloch, Effective Java 2nd edition, item 33., Kees Schotanus

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	Phase.Transition Transition from one Phase to another.

Enum Constant Summary

Enum Constants

Enum Constant and Description
GAS Gas state.
LIQUID Liquid state.
PLASMA Plasma.
SOLID Solid state.

Method Summary

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

SOLID

public static final Phase SOLID

Solid state.

LIQUID

public static final Phase LIQUID

Liquid state.

GAS

public static final Phase GAS

Gas state.

PLASMA

public static final Phase PLASMA

Plasma.

Method Detail

values

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

Returns:

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

valueOf

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