gov.nasa.gsfc.spdf.ssc
Enum PolarMapOrientation

java.lang.Object
  java.lang.Enum<PolarMapOrientation>
      gov.nasa.gsfc.spdf.ssc.PolarMapOrientation

All Implemented Interfaces:

java.io.Serializable, java.lang.Comparable<PolarMapOrientation>

public enum PolarMapOrientation
extends java.lang.Enum<PolarMapOrientation>

This class represents the polar map orientations 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

EQUATORIAL
Equatorial orientation.

NORTH_POLE
North pole orientation.

SOUTH_POLE
South pole orientation.

Method Summary

static PolarMapOrientation	fromValue(int value) Provides the PolarMapOrientation corresponding to the given integer value.
java.lang.String	toString() Provides a string representation of this orientation.
int	value() Provides the integer value corresponding to this orientation.
static PolarMapOrientation	valueOf(java.lang.String name) Returns the enum constant of this type with the specified name.
static PolarMapOrientation[]	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

EQUATORIAL

public static final PolarMapOrientation EQUATORIAL

Equatorial orientation.

NORTH_POLE

public static final PolarMapOrientation NORTH_POLE

North pole orientation.

SOUTH_POLE

public static final PolarMapOrientation SOUTH_POLE

South pole orientation.

Method Detail

values

public static PolarMapOrientation[] 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 (PolarMapOrientation c : PolarMapOrientation.values())
    System.out.println(c);

Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf

public static PolarMapOrientation 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 orientation.

Returns:

integer value corrsponding to this orientation.

fromValue

public static PolarMapOrientation fromValue(int value)

Provides the PolarMapOrientation corresponding to the given integer value.

Parameters:

value - integer value corresponding to an orientation

Returns:

PolarMapOrientation corresponding to the given value

Throws:

java.lang.IllegalArgumentException - if the given value does not correspond to any orientation

toString

public java.lang.String toString()

Provides a string representation of this orientation.

Overrides:

toString in class java.lang.Enum<PolarMapOrientation>

Returns:

a string representation of this orientation