gov.nasa.gsfc.spdf.ssc
Enum DateFormat

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

All Implemented Interfaces:

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

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

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

YY_MM_DD
A date format of yy/mm/dd.

YY_MMM_DD
A date format of yy-Mmm-dd.

YY_MMM_DD_2
A date format of yy-MMM-dd.

YYYY_DDD
A date format of yyyy ddd.

Method Summary

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

YYYY_DDD

public static final DateFormat YYYY_DDD

A date format of yyyy ddd.

YY_MM_DD

public static final DateFormat YY_MM_DD

A date format of yy/mm/dd.

YY_MMM_DD

public static final DateFormat YY_MMM_DD

A date format of yy-Mmm-dd.

YY_MMM_DD_2

public static final DateFormat YY_MMM_DD_2

A date format of yy-MMM-dd.

Method Detail

values

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

Returns:

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

valueOf

public static DateFormat 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 date format.

Returns:

integer value corrsponding to this date format.

fromValue

public static DateFormat fromValue(int value)

Provides the date format corresponding to the given integer value.

Parameters:

value - integer value corresponding to a date format

Returns:

DateFormat corresponding to the given value

Throws:

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

toString

public java.lang.String toString()

Provides a string representation of this date format.

Overrides:

toString in class java.lang.Enum<DateFormat>

Returns:

a string representation of this date format