me.lihq.game.people

Enum AbstractPerson.Direction

java.lang.Object

java.lang.Enum<AbstractPerson.Direction>

me.lihq.game.people.AbstractPerson.Direction

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<AbstractPerson.Direction>

Enclosing class:

AbstractPerson

public static enum AbstractPerson.Direction
extends java.lang.Enum<AbstractPerson.Direction>

This is used to describe the direction the person is currently facing or moving in.

• NORTH
• SOUTH
• EAST
• WEST

Enum Constant Summary

Enum Constants

Enum Constant and Description
EAST person is facing east
NORTH person is facing north
SOUTH person is facing south
WEST person is facing west

Field Summary

Fields

Modifier and Type	Field and Description
private int	dx
private int	dy

Method Summary

Modifier and Type	Method and Description
int	getDx() Getter for dx.
int	getDy() Getter for dy.
AbstractPerson.Direction	getOpposite() This method takes the current direction and gets the opposite direction
static AbstractPerson.Direction	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static AbstractPerson.Direction[]	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

NORTH

public static final AbstractPerson.Direction NORTH

person is facing north

SOUTH

public static final AbstractPerson.Direction SOUTH

person is facing south

EAST

public static final AbstractPerson.Direction EAST

person is facing east

WEST

public static final AbstractPerson.Direction WEST

person is facing west

Field Detail

dx

private int dx

dy

private int dy

Method Detail

values

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

Returns:

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

valueOf

public static AbstractPerson.Direction 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

getDx

public int getDx()

Getter for dx.

Returns:

returns the value of dx.

getDy

public int getDy()

Getter for dy.

Returns:

returns the value of dy.

getOpposite

public AbstractPerson.Direction getOpposite()

This method takes the current direction and gets the opposite direction

Returns:

(Direction) the opposite direction to this