Package gov.nasa.gsfc.spdf.ssc

Enum Hemisphere

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<Hemisphere>
    public enum Hemisphere
extends java.lang.Enum<Hemisphere>
    This class represents the hemisphere regions supported by SSC.

    Note: The integer values for this enumeration cannot be arbitrarily assigned. They must match the values expected by other parts of the SSC software.

    Version:
    $Revison: $
    Author:
    B. Harris

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      NORTH
      Northern hemispere.
      SOUTH
      Southern hemisphere.

    • Method Summary

      All Methods Static Methods Instance Methods Concrete Methods 
      Modifier and Type Method Description
      static Hemisphere fromValue​(int value)
      Provides the Hemisphere corresponding to the given integer value.
      java.lang.String toString()
      Provides a string representation of this region.
      int value()
      Provides the integer value corresponding to this hemisphere.
      static Hemisphere valueOf​(java.lang.String name)
      Returns the enum constant of this type with the specified name.
      static Hemisphere[] 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, valueOf

      • Methods inherited from class java.lang.Object

        getClass, notify, notifyAll, wait, wait, wait

    • Enum Constant Detail

      • SOUTH

        public static final Hemisphere SOUTH
        Southern hemisphere.

      • NORTH

        public static final Hemisphere NORTH
        Northern hemispere.

    • Method Detail

      • values

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

      • valueOf

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

      • value

        public int value()
        Provides the integer value corresponding to this hemisphere.
        Returns:
        integer value corrsponding to this hemisphere.

      • fromValue

        public static Hemisphere fromValue​(int value)
        Provides the Hemisphere corresponding to the given integer value.
        Parameters:
        value - integer value corresponding to a hemisphere
        Returns:
        Hemisphere corresponding to the given value
        Throws:
        java.lang.IllegalArgumentException - if the given value does not correspond to any hemisphere

      • toString

        public java.lang.String toString()
        Provides a string representation of this region.
        Overrides:
        toString in class java.lang.Enum<Hemisphere>
        Returns:
        a string representation of this region