ch.sahits.game.openpatrician.model.ship

Enum EShipUpgrade

java.lang.Object

java.lang.Enum<EShipUpgrade>

ch.sahits.game.openpatrician.model.ship.EShipUpgrade

All Implemented Interfaces:

Serializable, Comparable<EShipUpgrade>

public enum EShipUpgrade
extends Enum<EShipUpgrade>

Define the upgrade levels for ships. An upgrade reduces the capacity to load ware but provides room for weapons on board.

Author:

Andi Hotz, (c) Sahits GmbH, 2011 Created on Nov 19, 2011

Enum Constant Summary

Enum Constants

Enum Constant and Description
LEVEL1 Upgraded once
LEVEL2 Final upgrade
NONE No upgrade

Method Summary

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

NONE

public static final EShipUpgrade NONE

No upgrade

LEVEL1

public static final EShipUpgrade LEVEL1

Upgraded once

LEVEL2

public static final EShipUpgrade LEVEL2

Final upgrade

Method Detail

values

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

Returns:

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

valueOf

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

nextLevel

public EShipUpgrade nextLevel()

Retrieve the next level. If this method is called upon the highest level an ArrayIndexOutOfBoundsException will be thrown.

Returns:

next level.