Package gov.nasa.gsfc.spdf.ssc

Enum CoordinateComponent

  • All Implemented Interfaces:
    java.io.Serializable, java.lang.Comparable<CoordinateComponent>
    public enum CoordinateComponent
extends java.lang.Enum<CoordinateComponent>
    This class represents the different coordinate components supported by SSC.
    Version:
    $Revison: $
    Author:
    B. Harris

    • Enum Constant Summary

      Enum Constants 
      Enum Constant Description
      LAT
      Latitude coordinate component.
      LOCAL_TIME
      Local time coordinate component.
      LON
      Longitude coordinate component.
      X
      X or first coordinate component.
      Y
      Y or second coordinate component.
      Z
      Z or thrid coordinate component.

    • Method Summary

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

    • Method Detail

      • values

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

      • valueOf

        public static CoordinateComponent 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 java.lang.String value()
        Provides a String value corresponding to this coordinate component.
        Returns:
        String value corresponding to this coordinate component

      • fromValue

        public static CoordinateComponent fromValue​(java.lang.String name)
        Provides the CoordinateComponent corresponding to the given String value.
        Parameters:
        name - String value corresponding to a CoordinateComponent
        Returns:
        CoordinateComponent corresponding to the given name
        Throws:
        java.lang.IllegalArgumentException - if the given name does not correspond to any CoordinateComponent