Package nz.ac.vuw.ecs.swen225.gp22.domain

Enum Class Entity.Direction

java.lang.Object

java.lang.Enum<Entity.Direction>

nz.ac.vuw.ecs.swen225.gp22.domain.Entity.Direction

All Implemented Interfaces:

Serializable, Comparable<Entity.Direction>, Constable

Enclosing class:

Entity<S extends Observable<S>>

public static enum Entity.Direction
extends Enum<Entity.Direction>

Enum with values for each direction, which each have a point representing the change in position.

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	Represents an downwards vector.
Left	Represents a vector going left.
Right	Represents a vector going right.
Up	Represents an upwards vector.

Method Summary

Modifier and Type	Method	Description
abstract Entity.Direction	opposite()
static Entity.Direction	valueOf(String name)	Returns the enum constant of this class with the specified name.
static Entity.Direction[]	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

Up

public static final Entity.Direction Up

Represents an upwards vector.

Down

public static final Entity.Direction Down

Represents an downwards vector.

Left

public static final Entity.Direction Left

Represents a vector going left.

Right

public static final Entity.Direction Right

Represents a vector going right.

Method Details

values

public static Entity.Direction[] 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 Entity.Direction 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 abstract Entity.Direction opposite()

Returns:

The opposite direction.