public class

GwtLocaleImpl

extends Object
implements GwtLocale
java.lang.Object
   ↳ com.google.gwt.i18n.server.GwtLocaleImpl

Class Overview

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

Summary

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

Public Methods

public int compareTo (GwtLocale o)

The default comparison is a lexical ordering.

public boolean equals (Object obj)

public 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 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 GwtLocale getCanonicalForm ()

Returns this locale in canonical form. Changes for canonical form are:

  • Deprecated language/region tags are replaced with official versions

Returns
  • GwtLocale instance

public 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 List<GwtLocale> getInheritanceChain ()

Return 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 String getLanguage ()

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

public String getLanguageNotNull ()

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

public String getRegion ()

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

public String getRegionNotNull ()

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

public String getScript ()

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

public String getScriptNotNull ()

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

public String getVariant ()

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

public String getVariantNotNull ()

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

public int hashCode ()

public boolean inheritsFrom (GwtLocale parent)

Return 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 boolean isDefault ()

Returns true if this is the default or root locale.

public String toString ()

public boolean usesSameScript (GwtLocale other)

Checks if this locale uses the same script as another locale, taking into account default scripts.

Returns
  • true if the scripts are the same