Package org.apache.sis.util
Class Locales
Static methods working on
Locale instances. While this class is documented as
providing static methods, a few methods are actually non-static. Those methods need to be
invoked on the ALL or SIS instance in order to specify the scope.
Examples:
Locales[] lc1 = Locales.ALL.getAvailableLanguages(); // All languages installed on the JavaVM. Locales[] lc2 = Locales.SIS.getAvailableLanguages(); // Only the languages known to Apache SIS.
- Since:
- 0.3
Defined in the sis-utility module
-
Field Summary
Fields -
Method Summary
Modifier and TypeMethodDescriptionLocale[]Locale[]static LocaleParses the given language code, optionally followed by country code and variant.static LocaleParses the given language code and optional complements (country, variant), starting at the given index.static LocaleReturns a unique instance of the given locale, if one is available.
-
Field Details
-
ALL
All locales available on the JavaVM. -
SIS
Only locales available in the Apache SIS library.
-
-
Method Details
-
getAvailableLanguages
Returns the languages known to the JavaVM (ALL) or to the Apache SIS library (SIS). In the latter case, this method returns only the languages for which localized resources are provided in theorg.apache.sis.util.resourcespackage.- Returns:
- the list of supported languages.
-
getAvailableLocales
Returns the locales known to the JavaVM (ALL) or to the Apache SIS library (SIS). In the latter case, this method returns only the locales for which localized resources are provided in theorg.apache.sis.util.resourcespackage.- Returns:
- the list of supported locales.
-
parse
Parses the given language code, optionally followed by country code and variant. The given string can be either the 2 letters or the 3 letters ISO 639 code. It can optionally be followed by the'_'character and the country code (again either as 2 or 3 letters), optionally followed by'_'and the variant.This method can be used when the caller wants the same
Localeconstants no matter if the language and country codes use 2 or 3 letters. This method tries to convert 3-letters codes to 2-letters code on a best effort basis.- Parameters:
code- the language code, optionally followed by country code and variant.- Returns:
- the language for the given code (never
null). - Throws:
IllformedLocaleException- if the given code is not valid.- See Also:
-
parse
Parses the given language code and optional complements (country, variant), starting at the given index. All characters beforefromIndexare ignored. Characters fromfromIndexto the end of the string are parsed as documented in theparse(String)method. In particular, this method tries to convert 3-letters codes to 2-letters code on a best effort basis.Example: This method is useful when language codes are appended to a base property or resource name. For example, a dictionary may define the"remarks"property by values associated to the"remarks_en"and"remarks_fr"keys, for English and French locales respectively.- Parameters:
code- the language code, which may be followed by country code.fromIndex- index of the first character to parse.- Returns:
- the language for the given code (never
null). - Throws:
IllformedLocaleException- if the given code is not valid.- See Also:
-
unique
Returns a unique instance of the given locale, if one is available. Otherwise returns thelocaleunchanged.- Parameters:
locale- the locale to canonicalize.- Returns:
- a unique instance of the given locale, or
localeif the given locale is not cached.
-