Package bridges.game

Enum Direction

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Direction>
    public enum Direction
extends java.lang.Enum<Direction>
    Represents a geographic direction on the board, using coordinate system of the specification (that is: North is negative y).

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      EAST  
      NORTH  
      SOUTH  
      WEST  

    • Field Summary

      Fields 
      Modifier and Type Field Description
      int dx  
      int dy  

    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Direction nearest​(int dx, int dy)
      Returns the direction which is nearest to (dx, dy).
      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

    • Field Detail

      • dx

        public final int dx

      • dy

        public final int dy

    • 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

      • nearest

        public static Direction nearest​(int dx,
                                int dy)
        Returns the direction which is nearest to (dx, dy). E.g. (2, -3) lies more to the north, so we return Direction.NORTH.
        Parameters:
        dx - - the x direction of the geographic direction.
        dy - - the y direction of the geographic direction.
        Returns:
        A direction, which best matches the given deltas.