Enum Class Neighbor

Object
Enum<Neighbor>
Neighbor
All Implemented Interfaces:
Serializable, Comparable<Neighbor>, Constable

public enum Neighbor extends Enum<Neighbor>
Constants for neighbor positions used when bulding polygonal grids.
Since:
2.7
Author:
mbedward
  • Enum Constant Details

    • UPPER

      public static final Neighbor UPPER
    • UPPER_LEFT

      public static final Neighbor UPPER_LEFT
    • UPPER_RIGHT

      public static final Neighbor UPPER_RIGHT
    • LOWER

      public static final Neighbor LOWER
    • LOWER_LEFT

      public static final Neighbor LOWER_LEFT
    • LOWER_RIGHT

      public static final Neighbor LOWER_RIGHT
    • LEFT

      public static final Neighbor LEFT
  • Method Details

    • values

      public static Neighbor[] values()
      Returns an array containing the constants of this enum class, in the order they are declared.
      Returns:
      an array containing the constants of this enum class, in the order they are declared
    • valueOf

      public static Neighbor valueOf(String name)
      Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (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:
      IllegalArgumentException - if this enum class has no constant with the specified name
      NullPointerException - if the argument is null