ej.nls

Class NLS

java.lang.Object

ej.nls.NLS

Direct Known Subclasses:

BasicImmutablesNLS

public abstract class NLS
extends Object

NLS provides support for manipulating messages and languages.
Each instance of a NLS manages a set of messages, and each message is defined by a unique int value.
Each language is defined by a locale string. By convention, a locale represents a specific geographical, political, or cultural region. It is often represented using the concatenation of a language code and a country code:

• The language code is the lower-case, two-letter codes as defined by ISO-639.
• The country code is the upper-case, two-letter codes as defined by ISO-3166.

Constructor Summary

Constructors

Constructor and Description
NLS()

Method Summary

Modifier and Type	Method and Description
abstract String[]	getAvailableLocales() Gets the list of available locales.
abstract String	getCurrentLocale() Gets the current loaded locale.
static NLS	getDefault() Deprecated. Use instantiate instead
abstract String	getDisplayName(String locale) Gets the human-readable name of the given locale.
abstract String	getMessage(int messageID) Gets the message matching the specified ID in the current language.
abstract String	getMessage(int messageID, String locale) Gets the message matching the specified ID in the language of the specified locale.
static NLS	instantiate(String header) Creates an NLS instance for the given header
abstract void	setCurrentLocale(String locale) Changes the current locale loaded.

Methods inherited from class java.lang.Object

clone, equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

NLS

public NLS()

Method Detail

getAvailableLocales

public abstract String[] getAvailableLocales()

Gets the list of available locales.

Returns:

the list of locales

getDisplayName

public abstract String getDisplayName(String locale)

Gets the human-readable name of the given locale.

Parameters:

locale - the locale

Returns:

the human-readable name

getMessage

public abstract String getMessage(int messageID)

Gets the message matching the specified ID in the current language. The first message has an ID of 1.

Parameters:

messageID - the ID of the message to retrieve

Returns:

the message at the specified ID

Throws:

ArrayIndexOutOfBoundsException - if the given messageID does not match a valid message

getMessage

public abstract String getMessage(int messageID,
                                  String locale)

Gets the message matching the specified ID in the language of the specified locale. The first message has an ID of 1.

Parameters:

messageID - the ID of the message to retrieve

locale - the locale to use

Returns:

the message at the specified ID

Throws:

ArrayIndexOutOfBoundsException - if the given messageID does not match a valid message

setCurrentLocale

public abstract void setCurrentLocale(String locale)

Changes the current locale loaded.

Parameters:

locale - the locale to set

getCurrentLocale

public abstract String getCurrentLocale()

Gets the current loaded locale.

Returns:

the current locale

instantiate

public static NLS instantiate(String header)

Creates an NLS instance for the given header

Parameters:

header - the NLS instance's header

Returns:

NLS instance with messages for the given header

getDefault

@Deprecated
public static NLS getDefault()

Deprecated. Use instantiate instead

Returns:

null