com.fs.starfarer.api.combat

Enum ShipAPI.HullSize

java.lang.Object

java.lang.Enum<ShipAPI.HullSize>

com.fs.starfarer.api.combat.ShipAPI.HullSize

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<ShipAPI.HullSize>

Enclosing interface:

ShipAPI

public static enum ShipAPI.HullSize
extends java.lang.Enum<ShipAPI.HullSize>

Enum Constant Summary

Enum Constants

Enum Constant and Description
CAPITAL_SHIP
CRUISER
DEFAULT
DESTROYER
FIGHTER
FRIGATE

Method Summary

Modifier and Type	Method and Description
ShipAPI.HullSize	larger()
ShipAPI.HullSize	smaller(boolean allowFighter)
static ShipAPI.HullSize	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static ShipAPI.HullSize[]	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

DEFAULT

public static final ShipAPI.HullSize DEFAULT

FIGHTER

public static final ShipAPI.HullSize FIGHTER

FRIGATE

public static final ShipAPI.HullSize FRIGATE

DESTROYER

public static final ShipAPI.HullSize DESTROYER

CRUISER

public static final ShipAPI.HullSize CRUISER

CAPITAL_SHIP

public static final ShipAPI.HullSize CAPITAL_SHIP

Method Detail

values

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

Returns:

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

valueOf

public static ShipAPI.HullSize 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

smaller

public ShipAPI.HullSize smaller(boolean allowFighter)

larger

public ShipAPI.HullSize larger()