edu.ou.pacman.util
Enum Direction

java.lang.Object
  extended by java.lang.Enum<Direction>
      extended by edu.ou.pacman.util.Direction
All Implemented Interfaces:
java.io.Serializable, java.lang.Comparable<Direction>

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

Directions used on the game board.

Author:
Derek Rushing

Enum Constant Summary
Down
           
Left
           
Right
           
Up
           
 
Method Summary
 Direction opposite()
          Return the opposite direction of this direction.
static Direction oppositeDirection(Direction direction)
          Return the opposite direction of the given one.
static Direction random()
          Delivers a random direction.
static Direction valueOf(java.lang.String name)
          Returns the enum constant of this type with the specified name.
static 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
compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf
 
Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait
 

Enum Constant Detail

Down

public static final Direction Down

Left

public static final Direction Left

Right

public static final Direction Right

Up

public static final Direction Up
Method Detail

values

public static 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 (Direction c : 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 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

opposite

public Direction opposite()
Return the opposite direction of this direction.


oppositeDirection

public static Direction oppositeDirection(Direction direction)
Return the opposite direction of the given one.


random

public static Direction random()
Delivers a random direction.

Returns:
A random cardinal direction. Doesn't error, but instead returns down if there are any issues.