Enum DegreeFormat

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

    public enum DegreeFormat
    extends java.lang.Enum<DegreeFormat>
    This class represents the degree formats 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
      DECIMAL
      A decimal degree format of dd.ddd....
      MINUTES
      A minutes degree format ddd dd'.
      MINUTES_SECONDS
      A minutes and seconds degree format of ddd dd' dd.
    • Method Summary

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

      • DECIMAL

        public static final DegreeFormat DECIMAL
        A decimal degree format of dd.ddd....
      • MINUTES

        public static final DegreeFormat MINUTES
        A minutes degree format ddd dd'.
      • MINUTES_SECONDS

        public static final DegreeFormat MINUTES_SECONDS
        A minutes and seconds degree format of ddd dd' dd.
    • Method Detail

      • values

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

        public static DegreeFormat 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 degree format.
        Returns:
        integer value corrsponding to this degree format.
      • fromValue

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

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