ej.nls

Class BasicImmutablesNLS

java.lang.Object

ej.nls.NLS

ej.nls.BasicImmutablesNLS

Deprecated.

prefer add-on library "BinaryNLS" (based on ".po" files) instead

@Deprecated
public class BasicImmutablesNLS
extends NLS

A BasicImmutablesNLS is a NLS implementation based on immutables. The immutables must be defined as follow:

• An array named [header]_locales contains the list of available locales.
• An array for each available locale containing a list of messages named [header]_[locale].
  All these arrays must have the same size.
  The first value of each array is the display name of the locale.

For example:
<immutables name="NLS_TEST objects">
<array id="test_locales" type="java.lang.String[]" length="2">
<elem value="lang1"/>
<elem value="lang2"/>
</array>
<array id="test_lang1" type="java.lang.String[]" length="4">
<elem value="LANG1"/>
<elem value="lang1_m1"/>
<elem value="lang1_m2"/>
<elem value="lang1_m3"/>
</array>
<array id="test_lang2" type="java.lang.String[]" length="4">
<elem value="LANG2"/>
<elem value="lang2_m1"/>
<elem value="lang2_m2"/>
<elem value="lang2_m3"/>
</array>
</immutables>


See Also:

Immutables

Constructor Summary

Constructors

Constructor and Description
BasicImmutablesNLS(String header) Deprecated. Creates a BasicImmutablesNLS instance specifying the header. The first locale is set as current.

Method Summary

Modifier and Type	Method and Description
String[]	getAvailableLocales() Deprecated. Gets the list of available locales.
String	getCurrentLocale() Deprecated. Gets the current loaded locale.
String	getDisplayName(String locale) Deprecated. Gets the human-readable name of the given locale.
String	getMessage(int messageID) Deprecated. Gets the message matching the specified ID in the current language.
String	getMessage(int messageID, String locale) Deprecated. Gets the message matching the specified ID in the specified locale.
void	setCurrentLocale(String locale) Deprecated. Changes the current locale loaded.

Methods inherited from class ej.nls.NLS

getDefault, instantiate

Methods inherited from class java.lang.Object

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

Constructor Detail

BasicImmutablesNLS

public BasicImmutablesNLS(String header)

Deprecated.

Creates a BasicImmutablesNLS instance specifying the header.
The first locale is set as current.

Parameters:

header - the header of the immutables

Method Detail

getAvailableLocales

public String[] getAvailableLocales()

Deprecated.

Description copied from class: NLS

Gets the list of available locales.

Specified by:

getAvailableLocales in class NLS

Returns:

the list of locales

getDisplayName

public String getDisplayName(String locale)

Deprecated.

Description copied from class: NLS

Gets the human-readable name of the given locale.

Specified by:

getDisplayName in class NLS

Parameters:

locale - the locale

Returns:

the human-readable name

setCurrentLocale

public void setCurrentLocale(String locale)

Deprecated.

Description copied from class: NLS

Changes the current locale loaded.

Specified by:

setCurrentLocale in class NLS

Parameters:

locale - the locale to set

getCurrentLocale

public String getCurrentLocale()

Deprecated.

Description copied from class: NLS

Gets the current loaded locale.

Specified by:

getCurrentLocale in class NLS

Returns:

the current locale

getMessage

public String getMessage(int messageID)

Deprecated.

Description copied from class: NLS

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

Specified by:

getMessage in class NLS

Parameters:

messageID - the ID of the message to retrieve

Returns:

the message at the specified ID

getMessage

public String getMessage(int messageID,
                         String locale)

Deprecated.

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

Specified by:

getMessage in class NLS

Parameters:

messageID - the ID of the message to retrieve

locale - the locale to use

Returns:

the message at the specified ID

Throws:

NoSuchElementException - if the immutable [header]_[locale] does not exist

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