org.josef.util

Enum Month

java.lang.Object

java.lang.Enum<Month>

org.josef.util.Month

All Implemented Interfaces:

Serializable, Comparable<Month>, Localizable, LocalizableEnumeration

@Status(stage=PRODUCTION,
        unitTests=PARTIAL)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public enum Month
extends Enum<Month>
implements LocalizableEnumeration

Enumeration of all the months in a year.
Normally it is a bad idea to depend upon the ordering of the enumerations but in this case I figured I can get away with it.

Version:

1.0 $Revision: 6488 $

Author:

Kees Schotanus

Enum Constant Summary

Enum Constants

Enum Constant and Description
APRIL April.
AUGUST August.
DECEMBER December.
FEBRUARY February.
JANUARY January.
JULY July.
JUNE June.
MARCH March.
MAY May.
NOVEMBER November.
OCTOBER October.
SEPTEMBER September.

Field Summary

Fields

Modifier and Type	Field and Description
static int	MONTHS_IN_A_YEAR The number of months in a year.

Method Summary

Modifier and Type	Method and Description
Serializable	getCode() Gets the code of this Month.
CodeDescription	getCodeDescription(Locale locale) Gets the CodeDescription of this Month.
static List<CodeDescription>	getCodeDescriptions(Locale locale) Gets a List of CodeDescription objects for all the Months.
String	getDescription(Locale locale) Gets the localized description of this Month.
int	getMaximumNumberOfDays() Gets the maximum number of days of this Month.
int	getNumber() Gets the one based number of this Month.
String	toLocalizedShortString(Locale locale) Creates a localized short String representation of this Month.
String	toLocalizedString(Locale locale) Creates a localized String representation of this Month.
static Month	valueOf(int month) Gets the Month corresponding to the supplied integer month.
static Month	valueOf(String name) Returns the enum constant of this type with the specified name.
static Month[]	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

JANUARY

public static final Month JANUARY

January.

FEBRUARY

public static final Month FEBRUARY

February.

MARCH

public static final Month MARCH

March.

APRIL

public static final Month APRIL

April.

MAY

public static final Month MAY

May.

JUNE

public static final Month JUNE

June.

JULY

public static final Month JULY

July.

AUGUST

public static final Month AUGUST

August.

SEPTEMBER

public static final Month SEPTEMBER

September.

OCTOBER

public static final Month OCTOBER

October.

NOVEMBER

public static final Month NOVEMBER

November.

DECEMBER

public static final Month DECEMBER

December.

Field Detail

MONTHS_IN_A_YEAR

public static final int MONTHS_IN_A_YEAR

The number of months in a year.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

getNumber

public int getNumber()

Gets the one based number of this Month.
For Java methods by Sun you probably want to use Enum.ordinal() since these methods use a zero (for January) based month.

Returns:

The number of this Month.
1 for January, 12 for December.

getMaximumNumberOfDays

public int getMaximumNumberOfDays()

Gets the maximum number of days of this Month.

Returns:

The maximum number of days of this Month.
For February 29 will be returned but this would only be accurate for a leap year!

valueOf

public static Month valueOf(int month)

Gets the Month corresponding to the supplied integer month.

Parameters:

month - The integer month from 1 to 12.

Returns:

The Month corresponding to the supplied integer month.

Throws:

IllegalArgumentException - When no Month exists that corresponds to the supplied month.
This normally happens when the month is not in the range: 1 <= month <= 12.

toLocalizedString

public String toLocalizedString(Locale locale)

Creates a localized String representation of this Month.

Parameters:

locale - Locale to localize this Month.
When null is supplied, the default locale is used.

Returns:

A localized String representation of this Month.

toLocalizedShortString

public String toLocalizedShortString(Locale locale)

Creates a localized short String representation of this Month.

Parameters:

locale - Locale to localize this Month.
When null is supplied, the default locale is used.

Returns:

A localized short String representation of this Month.

getCode

public Serializable getCode()

Gets the code of this Month.

Specified by:

getCode in interface LocalizableEnumeration

Returns:

The code of this Month.
Months are numbered from 1 to 12!

getDescription

public String getDescription(Locale locale)

Gets the localized description of this Month.

Specified by:

getDescription in interface Localizable

Specified by:

getDescription in interface LocalizableEnumeration

Parameters:

locale - Locale used to localize the description.
When null is supplied the default locale is used.

Returns:

The localized description of this Month.

See Also:

toLocalizedString(Locale)

getCodeDescription

public CodeDescription getCodeDescription(Locale locale)

Gets the CodeDescription of this Month.

Specified by:

getCodeDescription in interface LocalizableEnumeration

Parameters:

locale - Locale used to localize the description.
When null is supplied the default locale is used.

Returns:

The localized CodeDescription of this Month.

getCodeDescriptions

public static List<CodeDescription> getCodeDescriptions(Locale locale)

Gets a List of CodeDescription objects for all the Months.

Parameters:

locale - Locale used to localize the descriptions.
When null is supplied the default locale is used.

Returns:

A List of CodeDescription objects for all the Months.