net.rim.device.api.i18n
Class Locale

java.lang.Object
  |
  +--net.rim.device.api.i18n.Locale

public final class Locale

extends Object

Represents a specific geographical, political, or cultural region to be used for localizing numbers, dates, and text.

Compatible with java.util.Locale in Java's standard edition.

Field Summary

static int	APPLICATION In a global event, check this flag to see if the change was an application or a global one.
static long	GUID_INPUT_LOCALE_CHANGED GUID for global event sent when the current input locale changes.
static long	GUID_LOCALE_CHANGED GUID for global event sent when the current locale changes.
static int	LOCALE_de
static int	LOCALE_en
static int	LOCALE_en_GB
static int	LOCALE_en_US
static int	LOCALE_es
static int	LOCALE_fr
static int	LOCALE_it
static int	LOCALE_ROOT
static int	LOCALE_zh

Method Summary

boolean	equals(Object obj) Determines if provided object is equal to this locale.
static Locale	get(int code) Retrieves locale by code.
static Locale	get(int code, String variant) Retrieves locale by code suggesting variant name.
static Locale	get(String language) Retrieves locale by language.
static Locale	get(String language, String country) Retrieves locale by language and country.
static Locale	get(String language, String country, String variant) Retrieves locale by language, country, and variant.
static Locale[]	getAvailableInputLocales() Retrieves list of known input locales
static Locale[]	getAvailableLocales() Retrieves list of known locales
int	getCode() Retrieves integer code for this locale.
String	getCountry() Retrieves this locale's ISO country code.
static Locale	getDefault() Retrieves the current application's default locale.
static Locale	getDefaultForKeyboard() Retrieves default locale for the keyboard.
static Locale	getDefaultForSystem() Retrieves system's current default locale.
static Locale	getDefaultInputForSystem() Retrieves system's current default locale.
String	getDisplayCountry() Retrieves displayable name for this locale's country.
String	getDisplayLanguage() Retrieves displayable name for this locale's language.
String	getDisplayVariant() Retrieves displayable name for this locale's variant.
static String[]	getISOCountries() Retrieves a list of all 2-letter country codes defined in ISO 3166.
static String[]	getISOLanguages() Retrieves a list of all 2-letter language codes defined in ISO 639.
String	getLanguage() Retrieves this locale's ISO language code.
String	getVariant() Retrieves this locale's variant name.
int	hashCode() Retrieves hash code for this locale.
static void	setDefault(Locale defaultLocale) Sets default locale for the current application.
static void	setDefaultInput(Locale defaultLocale) Sets default locale for the current application.
String	toString() Retrieves the programmatic name of the entire locale.

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Field Detail

GUID_LOCALE_CHANGED

public static final long GUID_LOCALE_CHANGED

GUID for global event sent when the current locale changes.

GUID_INPUT_LOCALE_CHANGED

public static final long GUID_INPUT_LOCALE_CHANGED

GUID for global event sent when the current input locale changes.

Since:

JDE 3.7.0

APPLICATION

public static final int APPLICATION

In a global event, check this flag to see if the change was an application or a global one.

LOCALE_ROOT

public static final int LOCALE_ROOT

LOCALE_de

public static final int LOCALE_de

LOCALE_en

public static final int LOCALE_en

LOCALE_en_GB

public static final int LOCALE_en_GB

LOCALE_en_US

public static final int LOCALE_en_US

LOCALE_es

public static final int LOCALE_es

LOCALE_fr

public static final int LOCALE_fr

LOCALE_it

public static final int LOCALE_it

LOCALE_zh

public static final int LOCALE_zh

Since:

JDE 3.7.0

Method Detail

equals

public boolean equals(Object obj)

Determines if provided object is equal to this locale.

Overrides:

equals in class Object

Parameters:

obj - Object to compare with this locale.

Returns:

True if provided object is equal to this locale (only if the language, country, and variant match); otherwise, false.

Since:

JDE 3.7.0

get

public static Locale get(int code)

Retrieves locale by code.

Note: This method simply invokes get(code,null); this it ignores variants. If no locale exists for the code you specify, then this method creates the new locale, with an empty variant name.

Parameters:

code - Locale code.

Returns:

Locale associated with provided code, or null if no locale is associated with your code.

Since:

JDE 3.7.0

get

public static Locale get(int code,
                         String variant)

Retrieves locale by code suggesting variant name.

Note: if no local exists for the code you specify, then this method creates the new locale. If, in such a case, you passed a null string in for the variant, this method gives an empty variant name to the new locale.

Parameters:

code - Locale code.

variant - Name of locale variant; may be null to indicate no variant. This parameter is only relevant if this method ends up creating a new locale; otherwise, it is ignored.

Returns:

Locale associated with code.

Since:

JDE 3.7.0

get

public static Locale get(String language)

Retrieves locale by language.

This method simply invokes get(language,country=null,variant=null. If no such locale exists, this method creates an entry for it with an empty variant name.

Parameters:

language - Language for locale.

Returns:

Locale object for the given language; the object is interned.

Since:

JDE 3.7.0

get

public static Locale get(String language,
                         String country)

Retrieves locale by language and country.

This method simply invokes get(language,country,variant=null. If no such locale exists, this method creates an entry for it with an empty variant name.

Parameters:

language - Langauge for locale.

country - Country for locale; may be null to indicate no country specified.

Returns:

Locale object for the given language and country; the object is interned.

Since:

JDE 3.7.0

get

public static Locale get(String language,
                         String country,
                         String variant)

Retrieves locale by language, country, and variant.

If no such locale exists, this method creates an entry for it; if, in this case, you provide null for the variant name, this method gives an empty variant name to the new locale.

Parameters:

language - Langauge for locale.

country - Country for locale; may be null to indicate no country specified.

variant - Name of locale variant; may be null to indicate no variant (but see description).

Returns:

Locale object for the given language, country, and variant; the object is interned.

Since:

JDE 3.7.0

getAvailableLocales

public static Locale[] getAvailableLocales()

Retrieves list of known locales.

The elements are guaranteed to be in the order. It is equivalent to: (language, country, variant) tuples where empty is sorted before non empty and it is otherwise is alphabetical order.

Returns:

List of available locales known to the system.

getAvailableInputLocales

public static Locale[] getAvailableInputLocales()

Retrieves list of known input locales.

The elements are guaranteed to be in the order. It is equivalent to: (language, country, variant) tuples where empty is sorted before non empty and it is otherwise is alphabetical order.

Returns:

List of available locales known to the system.

Since:

JDE 3.7.0

getCode

public int getCode()

Retrieves integer code for this locale.

Returns:

Integer code for this locale (that is, the locale code without variant).

getCountry

public final String getCountry()

Retrieves this locale's ISO country code.

Returns:

ISO country/region code for this locale, or the empty string if this locale has no associated country.

getDefault

public static Locale getDefault()

Retrieves the current application's default locale.

This is either the locale that was specified by Locale.setDefault(Locale), or if null the return from Locale.getDefaultForSystem().

This is not guaranteed to be one of the available locales. An application may choose to set it to whatever it wishes.

Returns:

Current application's default locale.

getDefaultForSystem

public static Locale getDefaultForSystem()

Retrieves system's current default locale.

This is guaranteed to return an available locale.

Returns:

System's current default locale.

getDefaultInputForSystem

public static Locale getDefaultInputForSystem()

Retrieves system's current default locale.

This is guaranteed to return an available locale.

Returns:

System's current default locale.

Since:

JDE 3.7.0

getDefaultForKeyboard

public static Locale getDefaultForKeyboard()

Retrieves default locale for the keyboard. This value is used to choose the input type for the device if it has not been selected by the user.

There are no restrictions on which locale can be returned from this function.

Returns:

Default keyboard locale.

getDisplayCountry

public final String getDisplayCountry()

Retrieves displayable name for this locale's country.

Returns:

Locale's displayable country name.

getDisplayLanguage

public final String getDisplayLanguage()

Retrieves displayable name for this locale's language.

Returns:

Locale's displayable language name.

getDisplayVariant

public final String getDisplayVariant()

Retrieves displayable name for this locale's variant.

Returns:

Locale's displayable variant name.

getISOCountries

public static String[] getISOCountries()

Retrieves a list of all 2-letter country codes defined in ISO 3166.

Returns:

List of ISO-standard country codes.

getISOLanguages

public static String[] getISOLanguages()

Retrieves a list of all 2-letter language codes defined in ISO 639.

Returns:

List of ISo-standard language codes.

getLanguage

public final String getLanguage()

Retrieves this locale's ISO language code.

Returns:

ISO Language code for this locale, or the empty string if this locale has no associated language code.

getVariant

public final String getVariant()

Retrieves this locale's variant name.

Returns:

Variant name for this locale, or the empty string if this locale has no associated variant.

hashCode

public int hashCode()

Retrieves hash code for this locale.

Overrides:

hashCode in class Object

Returns:

Hash code value for this object.

setDefault

public static void setDefault(Locale defaultLocale)

Sets default locale for the current application.

Parameters:

defaultLocale - New default locale for the current application; this value always overrides the system value. If null, the current application will inherit the system locale, and the application's locale will change whenever the system locale changes.

Since:

JDE 3.7.0

setDefaultInput

public static void setDefaultInput(Locale defaultLocale)

Sets default locale for the current application.

Parameters:

defaultLocale - New default locale for the current application; this value always overrides the system value. If null, the current application will inherit the system locale, and the application's locale will change whenever the system locale changes.

Since:

JDE 3.7.0

toString

public String toString()

Retrieves the programmatic name of the entire locale.

Overrides:

toString in class Object

Returns:

String representation of this locale: the language, country, and variant are separated by underbars. Country always has one underbar preceeding it, and variant always has two underbars preceeding it. Underbars are not included if all 3 parts are empty.