Package com.fs.starfarer.api.fleet

Enum Class FleetGoal

java.lang.Object

java.lang.Enum<FleetGoal>

com.fs.starfarer.api.fleet.FleetGoal

All Implemented Interfaces:

Serializable, Comparable<FleetGoal>, Constable

public enum FleetGoal
extends Enum<FleetGoal>

Author:

Alex Mosolov Copyright 2012 Fractal Softworks, LLC

Nested Class Summary

Nested classes/interfaces inherited from class java.lang.Enum

Enum.EnumDesc<E extends Enum<E>>

Enum Constant Summary

Enum Constants

Enum Constant	Description
ATTACK
ESCAPE

Method Summary

Modifier and Type	Method	Description
String	getWarroomTooltipId()
static FleetGoal	valueOf(String name)	Returns the enum constant of this class with the specified name.
static FleetGoal[]	values()	Returns an array containing the constants of this enum class, in the order they are declared.

Methods inherited from class java.lang.Enum

clone, compareTo, describeConstable, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

ATTACK

public static final FleetGoal ATTACK

ESCAPE

public static final FleetGoal ESCAPE

Method Details

values

public static FleetGoal[] values()

Returns an array containing the constants of this enum class, in the order they are declared.

Returns:

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

valueOf

public static FleetGoal valueOf(String name)

Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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 class has no constant with the specified name

NullPointerException - if the argument is null

getWarroomTooltipId

public String getWarroomTooltipId()