Package pacman.constant

Enum Direction

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Direction>
    public enum Direction
extends java.lang.Enum<Direction>

    Direction

    A Direction is an enum object to store constant names of direction.

    Since:
    1.0
    Version:
    1.0
    Author:
    Song Zhang
    See Also:
    MovableGrid, Ghost, Pacman

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      DOWN  
      LEFT  
      RIGHT  
      UP  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Direction getOpposite​(Direction direction)
      Returns the opposite direction of the given one.
      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

        clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • 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

      • getOpposite

        public static Direction getOpposite​(Direction direction)
        Returns the opposite direction of the given one.
        Parameters:
        direction - a direction
        Returns:
        the opposite direction of the given one