org.josef.util

Enum WeekDay

java.lang.Object

java.lang.Enum<WeekDay>

org.josef.util.WeekDay

All Implemented Interfaces:

Serializable, Comparable<WeekDay>, Localizable, LocalizableEnumeration

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

Enumeration of all the days in a week.
The days are numbered from 1 (Sunday) to 7 (Saturday).
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
FRIDAY Friday.
MONDAY Monday.
SATURDAY Saturday.
SUNDAY Sunday.
THURSDAY Thursday.
TUESDAY Tuesday.
WEDNESDAY Wednesday.

Field Summary

Fields

Modifier and Type	Field and Description
static int	DAYS_IN_WEEK The number of days in a week.

Method Summary

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

SUNDAY

public static final WeekDay SUNDAY

Sunday.

MONDAY

public static final WeekDay MONDAY

Monday.

TUESDAY

public static final WeekDay TUESDAY

Tuesday.

WEDNESDAY

public static final WeekDay WEDNESDAY

Wednesday.

THURSDAY

public static final WeekDay THURSDAY

Thursday.

FRIDAY

public static final WeekDay FRIDAY

Friday.

SATURDAY

public static final WeekDay SATURDAY

Saturday.

Field Detail

DAYS_IN_WEEK

public static final int DAYS_IN_WEEK

The number of days in a week.

See Also:

Constant Field Values

Method Detail

values

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

Returns:

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

valueOf

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

valueOf

public static WeekDay valueOf(int day)

Gets the Day corresponding to the supplied integer day.

Parameters:

day - The integer day from 1 (Sunday) to 7 (Saturday).

Returns:

The WeekDay corresponding to the supplied integer day.

Throws:

IllegalArgumentException - When no WeekDay exists that corresponds to the supplied day.
This normally happens when the day is not in the range: 1 <= day <= 7.

toLocalizedString

public String toLocalizedString(Locale locale)

Creates a localized String representation of this WeekDay.

Parameters:

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

Returns:

A localized String representation of this WeekDay.

toLocalizedShortString

public String toLocalizedShortString(Locale locale)

Creates a localized short String representation of this WeekDay.

Parameters:

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

Returns:

A localized short String representation of this WeekDay.

getCode

public Serializable getCode()

Gets the code of this WeekDay.

Specified by:

getCode in interface LocalizableEnumeration

Returns:

The code of this WeekDay.
WeekDays are numbered from 1 to 7!

getDescription

public String getDescription(Locale locale)

Gets the localized description of this WeekDay.

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 WeekDay.

See Also:

toLocalizedString(Locale)

getCodeDescription

public CodeDescription getCodeDescription(Locale locale)

Gets the CodeDescription of this WeekDay.

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 WeekDay.

getCodeDescriptions

public static List<CodeDescription> getCodeDescriptions(Locale locale)

Gets a List of CodeDescription objects for all the WeekDays.

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 WeekDays.