Package cds.healpix

Enum Class CompassPoint.Cardinal

java.lang.Object
java.lang.Enum<CompassPoint.Cardinal>
cds.healpix.CompassPoint.Cardinal
All Implemented Interfaces:
Serializable, Comparable<CompassPoint.Cardinal>, Constable
Enclosing class:
CompassPoint

public static enum CompassPoint.Cardinal extends Enum<CompassPoint.Cardinal>
Enum defining the compass cardinal points.
Author:
F.-X. Pineau
  • Enum Constant Details

  • Method Details

    • values

      public static CompassPoint.Cardinal[] 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 CompassPoint.Cardinal 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
    • nextClockwise

      public CompassPoint.Cardinal nextClockwise()
      Returns the next cardinal point in the clockwise direction.
      Returns:
      the next cardinal point in the clockwise direction.
    • nextCounterClockwise

      public CompassPoint.Cardinal nextCounterClockwise()
      Returns the next cardinal point in the counter-clockwise direction.
      Returns:
      the next cardinal point in the counter-clockwise direction.