ch.sahits.game.openpatrician.model.ship
Enum EShipSide

java.lang.Object
  java.lang.Enum<EShipSide>
      ch.sahits.game.openpatrician.model.ship.EShipSide

All Implemented Interfaces:

Serializable, Comparable<EShipSide>

public enum EShipSide
extends Enum<EShipSide>

Defining the sides of a ship

Author:

Andi Hotz, (c) Sahits GmbH, 2011 Created on Dec 23, 2011

Enum Constant Summary

BOW
Front of the ship

PORT
Left side of the ship, when facing the bow

STARBOARD
Right side of the ship, when facing the bow

STERN
Back of the ship

Method Summary

static EShipSide	valueOf(String name) Returns the enum constant of this type with the specified name.
static EShipSide[]	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

BOW

public static final EShipSide BOW

Front of the ship

STERN

public static final EShipSide STERN

Back of the ship

PORT

public static final EShipSide PORT

Left side of the ship, when facing the bow

STARBOARD

public static final EShipSide STARBOARD

Right side of the ship, when facing the bow

Method Detail

values

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

Returns:

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

valueOf

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