ucar.nc2.time

Enum CalendarPeriod.Field

java.lang.Object

java.lang.Enum<CalendarPeriod.Field>

ucar.nc2.time.CalendarPeriod.Field

All Implemented Interfaces:

Serializable, Comparable<CalendarPeriod.Field>

Enclosing class:

CalendarPeriod

public static enum CalendarPeriod.Field
extends Enum<CalendarPeriod.Field>

Fields that can be set on a CalendarPeriod, used to prevent exposure of underlying implementation.

Enum Constant Summary

Enum Constants

Enum Constant and Description
Day
Hour
Millisec
Minute
Month
Second
Year

Method Summary

Modifier and Type	Method and Description
static CalendarPeriod.Field	valueOf(String name) Returns the enum constant of this type with the specified name.
static CalendarPeriod.Field[]	values() Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum

compareTo, equals, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

Day

public static final CalendarPeriod.Field Day

Hour

public static final CalendarPeriod.Field Hour

Millisec

public static final CalendarPeriod.Field Millisec

Minute

public static final CalendarPeriod.Field Minute

Month

public static final CalendarPeriod.Field Month

Second

public static final CalendarPeriod.Field Second

Year

public static final CalendarPeriod.Field Year

Method Detail

valueOf

public static CalendarPeriod.Field valueOf(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:

IllegalArgumentException - if this enum type has no constant with the specified name

NullPointerException - if the argument is null

values

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

Returns:

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