public interface

GwtLocale

implements Comparable<T>
com.google.gwt.i18n.shared.GwtLocale
Known Indirect Subclasses

Class Overview

Class representing GWT locales and conversion to/from other formats. These locales correspond to BCP47.

Summary

Constants
String DEFAULT_LOCALE
Public Methods
abstract int compareTo(GwtLocale o)
The default comparison is a lexical ordering.
abstract List<GwtLocale> getAliases()
Returns the list of aliases for this locale.
abstract String getAsString()
Returns the locale as a fixed-format string suitable for use in searching for localized resources.
abstract GwtLocale getCanonicalForm()
Returns this locale in canonical form.
abstract List<GwtLocale> getCompleteSearchList()
Returns the complete list of locales to search for the current locale.
abstract List<GwtLocale> getInheritanceChain()
Returns a list of locales to search for, in order of preference.
abstract String getLanguage()
Returns the language portion of the locale, or null if none.
abstract String getLanguageNotNull()
Returns the language portion of the locale, or the empty string if none.
abstract String getRegion()
Returns the region portion of the locale, or null if none.
abstract String getRegionNotNull()
Returns the region portion of the locale, or the empty string if none.
abstract String getScript()
Returns the script portion of the locale, or null if none.
abstract String getScriptNotNull()
Returns the script portion of the locale, or the empty string if none.
abstract String getVariant()
Returns the variant portion of the locale, or null if none.
abstract String getVariantNotNull()
Returns the variant portion of the locale, or the empty string if none.
abstract boolean inheritsFrom(GwtLocale parent)
Returns true if this locale inherits from the specified locale.
abstract boolean isDefault()
Returns true if this is the default or root locale.
abstract String toString()
Returns a human readable string -- "default" or the same as getAsString().
abstract boolean usesSameScript(GwtLocale other)
Checks if this locale uses the same script as another locale.
[Expand]
Inherited Methods
From interface java.lang.Comparable

Constants

public static final String DEFAULT_LOCALE

Constant Value: "default"

Public Methods

public abstract int compareTo (GwtLocale o)

The default comparison is a lexical ordering.

public abstract List<GwtLocale> getAliases ()

Returns the list of aliases for this locale. The canonical form of the current locale is always first on the list. Language/region codes have changed over time, so some systems continue to use the older codes. Aliases allow GWT to use the official Unicode CLDR locales while still interoperating with such systems.

Returns
  • alias list

public abstract String getAsString ()

Returns the locale as a fixed-format string suitable for use in searching for localized resources. The format is language_Script_REGION_VARIANT, where language is a 2-8 letter code (possibly with 3-letter extensions), script is a 4-letter code with an initial capital letter, region is a 2-character country code or a 3-digit region code, and variant is a 5-8 character (may be 4 if the first character is numeric) code. If a component is missing, its preceding _ is also omitted. If this is the default locale, the empty string will be returned.

Returns
  • String representing locale

public abstract GwtLocale getCanonicalForm ()

Returns this locale in canonical form.

  • Deprecated language/region tags are replaced with official versions
  • Default scripts are removed (including region-specific defaults for Chinese)
  • no/nb/nn are normalized
  • Default region for zh_Hans and zh_Hant if none specified

Returns
  • GwtLocale instance

public abstract List<GwtLocale> getCompleteSearchList ()

Returns the complete list of locales to search for the current locale. This list will always start with the canonical form of this locale, and end with "default", and include all appropriate aliases along the way.

Returns
  • search list

public abstract List<GwtLocale> getInheritanceChain ()

Returns a list of locales to search for, in order of preference. The current locale is always first on the list. Aliases are not included in the list -- use getAliases() to expand those.

Returns
  • inheritance list

public abstract String getLanguage ()

Returns the language portion of the locale, or null if none.

public abstract String getLanguageNotNull ()

Returns the language portion of the locale, or the empty string if none.

public abstract String getRegion ()

Returns the region portion of the locale, or null if none.

public abstract String getRegionNotNull ()

Returns the region portion of the locale, or the empty string if none.

public abstract String getScript ()

Returns the script portion of the locale, or null if none.

public abstract String getScriptNotNull ()

Returns the script portion of the locale, or the empty string if none.

public abstract String getVariant ()

Returns the variant portion of the locale, or null if none.

public abstract String getVariantNotNull ()

Returns the variant portion of the locale, or the empty string if none.

public abstract boolean inheritsFrom (GwtLocale parent)

Returns true if this locale inherits from the specified locale. Note that locale.inheritsFrom(locale) is false -- if you want that to be true, you should just use locale.getInheritanceChain().contains(x).

Parameters
parent locale to test against
Returns
  • true if parent is an ancestor of this locale

public abstract boolean isDefault ()

Returns true if this is the default or root locale.

public abstract String toString ()

Returns a human readable string -- "default" or the same as getAsString().

public abstract boolean usesSameScript (GwtLocale other)

Checks if this locale uses the same script as another locale.

Returns
  • true if the scripts are the same