com.googlecode.jinahya.util

Enum CalendarPeriodOfDay

java.lang.Object

java.lang.Enum<CalendarPeriodOfDay>

com.googlecode.jinahya.util.CalendarPeriodOfDay

All Implemented Interfaces:

FieldEnum<CalendarPeriodOfDay,Integer>, CalendarFieldEnum<CalendarPeriodOfDay,Integer>, Serializable, Comparable<CalendarPeriodOfDay>

public enum CalendarPeriodOfDay
extends Enum<CalendarPeriodOfDay>
implements CalendarFieldEnum<CalendarPeriodOfDay,Integer>

Constants for Calendar.AM_PM.

Author:

Jin Kwon

Enum Constant Summary

Enum Constants

Enum Constant and Description
AM Constant for Calendar.AM.
PM Constant for Calendar.PM.

Field Summary

Fields

Modifier and Type	Field and Description
static int	CALENDAR_FIELD The target field of Calendar which this enum type is for.

Method Summary

Methods

Modifier and Type	Method and Description
Integer[]	fieldValues() Returns an array containing the field values of this enum type, in order they are declared.
static CalendarPeriodOfDay	fromCalendar(Calendar calendar) Returns the enum constant of this type with the specified calendar's field value.
static CalendarPeriodOfDay	fromFieldValue(int fieldValue) Returns the enum constant of this type with the specified field value.
Integer	getFieldValue() Returns field value.
void	set(Calendar calendar)
static CalendarPeriodOfDay	valueOf(String name) Returns the enum constant of this type with the specified name.
static CalendarPeriodOfDay[]	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

Enum Constant Detail

AM

public static final CalendarPeriodOfDay AM

Constant for Calendar.AM.

PM

public static final CalendarPeriodOfDay PM

Constant for Calendar.PM.

Field Detail

CALENDAR_FIELD

public static final int CALENDAR_FIELD

The target field of Calendar which this enum type is for.

See Also:

Calendar.AM_PM, Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

public static CalendarPeriodOfDay 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

fromFieldValue

public static CalendarPeriodOfDay fromFieldValue(int fieldValue)

Returns the enum constant of this type with the specified field value.

Parameters:

fieldValue - field value

Returns:

the enum constant with the specified field value.

Throws:

IllegalArgumentException - if this enum type has no constant with the specified field value.

fromCalendar

public static CalendarPeriodOfDay fromCalendar(Calendar calendar)

Returns the enum constant of this type with the specified calendar's field value.

Parameters:

calendar - calendar

Returns:

the enum constant with the specified calendar's field value.

Throws:

IllegalArgumentException - if this enum type has no constant with the specified calendar's field value.

fieldValues

public Integer[] fieldValues()

Returns an array containing the field values of this enum type, in order they are declared.

Returns:

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

getFieldValue

public Integer getFieldValue()

Description copied from interface: FieldEnum

Returns field value.

Specified by:

getFieldValue in interface FieldEnum<CalendarPeriodOfDay,Integer>

Returns:

field value.

set

public void set(Calendar calendar)

Specified by:

set in interface CalendarFieldEnum<CalendarPeriodOfDay,Integer>