gov.nasa.gsfc.spdf.ssc
Enum TimeFormat

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

All Implemented Interfaces:

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

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

This class represents the time 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

HH_HHHH
A time format of hh.hhhh.

HH_MM
A time format of hh:mm.

HH_MM_SS
A time format of hh:mm:ss.

Method Summary

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

HH_MM

public static final TimeFormat HH_MM

A time format of hh:mm.

HH_MM_SS

public static final TimeFormat HH_MM_SS

A time format of hh:mm:ss.

HH_HHHH

public static final TimeFormat HH_HHHH

A time format of hh.hhhh.

Method Detail

values

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

Returns:

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

valueOf

public static TimeFormat 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 time format.

Returns:

integer value corrsponding to this time format.

fromValue

public static TimeFormat fromValue(int value)

Provides the time format corresponding to the given integer value.

Parameters:

value - integer value corresponding to a time format

Returns:

DateFormat corresponding to the given value

Throws:

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

toString

public java.lang.String toString()

Provides a string representation of this time format.

Overrides:

toString in class java.lang.Enum<TimeFormat>

Returns:

a string representation of this time format