Package com.planet_ink.coffee_mud.Common.interfaces

Enum TimeClock.TidePhase

java.lang.Object

java.lang.Enum<TimeClock.TidePhase>

com.planet_ink.coffee_mud.Common.interfaces.TimeClock.TidePhase

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<TimeClock.TidePhase>

Enclosing interface:

TimeClock

public static enum TimeClock.TidePhase
extends java.lang.Enum<TimeClock.TidePhase>

The phases of the tides

Enum Constant Summary

Enum Constants

Enum Constant	Description
NEAP_HIGH
NEAP_LOW
NO_TIDE
NORMAL_HIGH
NORMAL_LOW
SPRING_HIGH
SPRING_LOW

Method Summary

Modifier and Type	Method	Description
java.lang.String	getDesc()
double	getFactor()
static TimeClock.TidePhase	valueOf(java.lang.String name)	Returns the enum constant of this type with the specified name.
static TimeClock.TidePhase[]	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

SPRING_HIGH

public static final TimeClock.TidePhase SPRING_HIGH

SPRING_LOW

public static final TimeClock.TidePhase SPRING_LOW

NORMAL_HIGH

public static final TimeClock.TidePhase NORMAL_HIGH

NORMAL_LOW

public static final TimeClock.TidePhase NORMAL_LOW

NEAP_HIGH

public static final TimeClock.TidePhase NEAP_HIGH

NEAP_LOW

public static final TimeClock.TidePhase NEAP_LOW

NO_TIDE

public static final TimeClock.TidePhase NO_TIDE

Method Detail

values

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

Returns:

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

valueOf

public static TimeClock.TidePhase 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

getDesc

public java.lang.String getDesc()

getFactor

public double getFactor()