Enum Position

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Position>

    public enum Position
    extends java.lang.Enum<Position>
    This class represents a position on the board with a string value that defines the position id.
    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      BOTTOM_LEFT
      The position id for the bottom left corner.
      BOTTOM_RIGHT
      The position id for the bottom right corner.
      GENERAL
      The position id for the top left corner.
      MIDDLE_LEFT
      The position id for the bottom left corner.
      MIDDLE_RIGHT
      The position id for the bottom right corner.
      TOP_LEFT
      The position id for the top right corner.
      TOP_RIGHT
      The position id for the top left corner.
    • Method Summary

      All Methods Static Methods Concrete Methods 
      Modifier and Type Method Description
      static Position valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Position[] 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

      • TOP_RIGHT

        public static final Position TOP_RIGHT
        The position id for the top left corner.
      • TOP_LEFT

        public static final Position TOP_LEFT
        The position id for the top right corner.
      • MIDDLE_LEFT

        public static final Position MIDDLE_LEFT
        The position id for the bottom left corner.
      • MIDDLE_RIGHT

        public static final Position MIDDLE_RIGHT
        The position id for the bottom right corner.
      • BOTTOM_LEFT

        public static final Position BOTTOM_LEFT
        The position id for the bottom left corner.
      • BOTTOM_RIGHT

        public static final Position BOTTOM_RIGHT
        The position id for the bottom right corner.
      • GENERAL

        public static final Position GENERAL
        The position id for the top left corner.
    • Method Detail

      • values

        public static Position[] 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 (Position c : Position.values())
            System.out.println(c);
        
        Returns:
        an array containing the constants of this enum type, in the order they are declared
      • valueOf

        public static Position 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