Package megamek.client.bot.princess

Enum Class CardinalEdge

java.lang.Object

java.lang.Enum<CardinalEdge>

megamek.client.bot.princess.CardinalEdge

All Implemented Interfaces:

Serializable, Comparable<CardinalEdge>, Constable

public enum CardinalEdge
extends Enum<CardinalEdge>

Since:

8/17/13 10:37 PM

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
EAST
NEAREST
NONE
NORTH
SOUTH
WEST

Method Summary

Modifier and Type	Method	Description
static CardinalEdge	getCardinalEdge(int index)	Given an index, attempt to return a cardinal edge.
static CardinalEdge	getCardinalEdge(OffBoardDirection direction)	Convert an OffBoardDirection to a cardinal edge
int	getIndex()
static CardinalEdge	getOppositeEdge(CardinalEdge edge)	Attempt to determine the opposite edge, given another cardinal edge
static CardinalEdge	parseFromString(String source)	Given a string, attempt to figure out if it corresponds to a cardinal edge
String	toString()
static CardinalEdge	valueOf(String name)	Returns the enum constant of this class with the specified name.
static CardinalEdge[]	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, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Details

NORTH

public static final CardinalEdge NORTH

SOUTH

public static final CardinalEdge SOUTH

WEST

public static final CardinalEdge WEST

EAST

public static final CardinalEdge EAST

NEAREST

public static final CardinalEdge NEAREST

NONE

public static final CardinalEdge NONE

Method Details

values

public static CardinalEdge[] 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 CardinalEdge 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

getIndex

public int getIndex()

toString

public String toString()

Overrides:

toString in class Enum<CardinalEdge>

getCardinalEdge

public static CardinalEdge getCardinalEdge(int index)

Given an index, attempt to return a cardinal edge.

parseFromString

public static CardinalEdge parseFromString(String source)

Given a string, attempt to figure out if it corresponds to a cardinal edge

getCardinalEdge

public static CardinalEdge getCardinalEdge(OffBoardDirection direction)

Convert an OffBoardDirection to a cardinal edge

getOppositeEdge

public static CardinalEdge getOppositeEdge(CardinalEdge edge)

Attempt to determine the opposite edge, given another cardinal edge