org.josef.util

Interface LocalizableEnumeration

All Superinterfaces:

Localizable

All Known Implementing Classes:

CColor, Element, Iso3166Country, Month, Nationality, Planet, WeekDay

@Status(stage=PRODUCTION)
 @Review(by="Kees Schotanus",
        at="2009-09-28")
public interface LocalizableEnumeration
extends Localizable

Interface to declare that an enumeration supports localization.
For an example see; Planet.

Version:

1.0 $Revision: 6230 $

Author:

Kees Schotanus

Method Summary

Modifier and Type	Method and Description
Serializable	getCode() Gets the code of the enumerated constant.
CodeDescription	getCodeDescription(Locale locale) Gets the CodeDescription of the enumerated constant.
String	getDescription(Locale locale) Gets the localized description of the enumerated constant.

Method Detail

getCode

Serializable getCode()

Gets the code of the enumerated constant.
This code should be unique to all the enumerated constants within the same enum.

Returns:

The code of the enumerated constant.

getDescription

String getDescription(Locale locale)

Gets the localized description of the enumerated constant.

Specified by:

getDescription in interface Localizable

Parameters:

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

Returns:

The localized description of the enumerated constant.

getCodeDescription

CodeDescription getCodeDescription(Locale locale)

Gets the CodeDescription of the enumerated constant.

Parameters:

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

Returns:

The localized CodeDescription of the enumerated constant.