com.adobe.agl.util

Class ULocale

java.lang.Object

com.adobe.agl.util.ULocale

All Implemented Interfaces:

Serializable

public final class ULocale
extends Object
implements Serializable

A class analogous to Locale that provides additional support for ICU protocol. In ICU 3.0 this class is enhanced to support RFC 3066 language identifiers.

Many classes and services in ICU follow a factory idiom, in which a factory method or object responds to a client request with an object. The request includes a locale (the requested locale), and the returned object is constructed using data for that locale. The system may lack data for the requested locale, in which case the locale fallback mechanism will be invoked until a populated locale is found (the valid locale). Furthermore, even when a populated locale is found (the valid locale), further fallback may be required to reach a locale containing the specific data required by the service (the actual locale).

ULocale performs 'normalization' and 'canonicalization' of locale ids. Normalization 'cleans up' ICU locale ids as follows:

• language, script, country, variant, and keywords are properly cased
  (lower, title, upper, upper, and lower case respectively)
• hyphens used as separators are converted to underscores
• three-letter language and country ids are converted to two-letter equivalents where available
• surrounding spaces are removed from keywords and values
• if there are multiple keywords, they are put in sorted order

Canonicalization additionally performs the following:

• POSIX ids are converted to ICU format IDs
• 'grandfathered' 3066 ids are converted to ICU standard form
• 'PREEURO' and 'EURO' variants are converted to currency keyword form, with the currency id appropriate to the country of the locale (for PREEURO) or EUR (for EURO).

All ULocale constructors automatically normalize the locale id. To handle POSIX ids, canonicalize can be called to convert the id to canonical form, or the canonicalInstance factory method can be called.

This class provides selectors #VALID_LOCALE and #ACTUAL_LOCALE intended for use in methods named getLocale() . These methods exist in several ICU classes, including com.adobe.agl.util.Calendar, Currency, UFormat, BreakIterator, Collator, com.adobe.agl.text.DateFormatSymbols, and DecimalFormatSymbols and their subclasses, if any. Once an object of one of these classes has been created, getLocale() may be called on it to determine the valid and actual locale arrived at during the object's construction.

Note: The getLocale() method will be implemented in ICU 3.0; ICU 2.8 contains a partial preview implementation. The actual locale is returned correctly, but the valid locale is not, in most cases.

See Also:

Locale, Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
static ULocale	ROOT The root ULocale.

Constructor Summary

Constructors

Constructor and Description
ULocale(String localeID)

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj) Equals based on locale.
static ULocale	forLocale(Locale loc) Return a ULocale object for a Locale.
String	getCountry()
static ULocale	getDefault()
ULocale	getFallback()
String	getLanguage()
String	getScript()
int	hashCode() Return hashcode based on locale
Locale	toLocale()

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, toString, wait, wait, wait

Field Detail

ROOT

public static final ULocale ROOT

The root ULocale.

Constructor Detail

ULocale

public ULocale(String localeID)

Method Detail

forLocale

public static ULocale forLocale(Locale loc)

Return a ULocale object for a Locale. The ULocale is canonicalized.

Parameters:

loc - a JDK locale

getLanguage

public String getLanguage()

getCountry

public String getCountry()

getScript

public String getScript()

getDefault

public static ULocale getDefault()

toLocale

public Locale toLocale()

getFallback

public ULocale getFallback()

hashCode

public int hashCode()

Return hashcode based on locale

Overrides:

hashCode in class Object

equals

public boolean equals(Object obj)

Equals based on locale.

Overrides:

equals in class Object