Package ch.epfl.cs107.play.math

Enum Class Orientation

java.lang.Object

java.lang.Enum<Orientation>

ch.epfl.cs107.play.math.Orientation

All Implemented Interfaces:

Serializable, Comparable<Orientation>, Constable

public enum Orientation
extends Enum<Orientation>

???

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
DOWN	???
LEFT	???
RIGHT	???
UP	???

Method Summary

Modifier and Type	Method	Description
static Orientation	fromInt(int index)	Convert an int into an orientation
static Orientation	fromVector(Vector v)	Convert a vector into an orientation
Orientation	hisLeft()
Orientation	hisRight()
Orientation	opposite()	Return the opposite Orientation
String	toString()
Vector	toVector()	Convert an orientation into vector
static Orientation	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Orientation[]	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

UP

public static final Orientation UP

???

RIGHT

public static final Orientation RIGHT

???

DOWN

public static final Orientation DOWN

???

LEFT

public static final Orientation LEFT

???

Method Details

values

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

opposite

public Orientation opposite()

Return the opposite Orientation

Returns:

(Orientation): the opposite orientation Down:Up, Right:Left

hisLeft

public Orientation hisLeft()

Returns:

(Orientation): the orientation on the left of this

hisRight

public Orientation hisRight()

Returns:

(Orientation): the orientation on the right of this

toVector

public Vector toVector()

Convert an orientation into vector

Returns:

(Vector)

fromInt

public static Orientation fromInt(int index)

Convert an int into an orientation

Parameters:

index - the integer representation

Returns:

the orientation

fromVector

public static Orientation fromVector(Vector v)

Convert a vector into an orientation

Parameters:

v - the vector representation

Returns:

the orientation

toString

public String toString()

Overrides:

toString in class Enum<Orientation>