Package com.planet_ink.coffee_mud.Items.interfaces

Enum ShipDirectional.ShipDir

java.lang.Object

java.lang.Enum<ShipDirectional.ShipDir>

com.planet_ink.coffee_mud.Items.interfaces.ShipDirectional.ShipDir

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ShipDirectional.ShipDir>

Enclosing interface:

ShipDirectional

public static enum ShipDirectional.ShipDir
extends java.lang.Enum<ShipDirectional.ShipDir>

/** The ShipDir enum is for the different ports, denoting the port, by its direction location.

Enum Constant Summary

Enum Constants

Enum Constant	Description
AFT
DORSEL
FORWARD
PORT
STARBOARD
VENTRAL

Method Summary

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

AFT

public static final ShipDirectional.ShipDir AFT

PORT

public static final ShipDirectional.ShipDir PORT

VENTRAL

public static final ShipDirectional.ShipDir VENTRAL

DORSEL

public static final ShipDirectional.ShipDir DORSEL

STARBOARD

public static final ShipDirectional.ShipDir STARBOARD

FORWARD

public static final ShipDirectional.ShipDir FORWARD

Method Detail

values

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

Returns:

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

valueOf

public static ShipDirectional.ShipDir 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

opposite

public final ShipDirectional.ShipDir opposite()