Enum Class LocaleCode
- All Implemented Interfaces:
Serializable,Comparable<LocaleCode>,Constable
Locale code.
The list of the enum entries was generated based on the output from
Locale.getAvailableLocales(), but locales whose format do not match either 'xx' or 'xx-XX' were excluded.
-
Nested Class Summary
Nested classes/interfaces inherited from class java.lang.Enum
Enum.EnumDesc<E extends Enum<E>> -
Enum Constant Summary
Enum Constants -
Method Summary
Modifier and TypeMethodDescriptionstatic LocaleCodeGet aLocaleCodeinstance that corresponds to the given code.static LocaleCodeGet aLocaleCodeinstance that corresponds to the given code.static LocaleCodeGet aLocaleCodeinstance that corresponds to the given pair of language code and country code.static LocaleCodeGet aLocaleCodeinstance that corresponds to the given pair of language code and country code.static LocaleCodegetByCodeIgnoreCase(String code) Get aLocaleCodeinstance that corresponds to the given code.static LocaleCodegetByCodeIgnoreCase(String language, String country) Get aLocaleCodeinstance that corresponds to the given pair of language code and country code.static List<LocaleCode> getByCountry(String country) Get a list ofLocaleCodeinstances whose country matches the given one.static List<LocaleCode> getByCountry(String country, boolean caseSensitive) Get a list ofLocaleCodeinstances whose country matches the given one.static List<LocaleCode> getByCountry(CountryCode country) Get a list ofLocaleCodeinstances whose country matches the given one.static List<LocaleCode> getByCountryIgnoreCase(String country) Get a list ofLocaleCodeinstances whose country matches the given one.static List<LocaleCode> getByLanguage(String language) Get a list ofLocaleCodeinstances whose language matches the given one.static List<LocaleCode> getByLanguage(String language, boolean caseSensitive) Get a list ofLocaleCodeinstances whose language matches the given one.static List<LocaleCode> getByLanguage(LanguageCode language) Get a list ofLocaleCodeinstances whose language matches the given one.static List<LocaleCode> getByLanguageIgnoreCase(String language) Get a list ofLocaleCodeinstances whose language matches the given one.static LocaleCodegetByLocale(Locale locale) Get aLocaleCodeinstance that corresponds to the givenLocaleinstance.Get the country code.Get the language code.toLocale()Convert thisLocaleCodeinstance to aLocaleinstance.toString()Get the string representation of this locale code.static LocaleCodeReturns the enum constant of this class with the specified name.static LocaleCode[]values()Returns an array containing the constants of this enum class, in the order they are declared.
-
Enum Constant Details
-
undefined
-
ar
-
ar_AE
-
ar_BH
-
ar_DZ
-
ar_EG
-
ar_IQ
-
ar_JO
-
ar_KW
-
ar_LB
-
ar_LY
-
ar_MA
-
ar_OM
-
ar_QA
-
ar_SA
-
ar_SD
-
ar_SY
-
ar_TN
-
ar_YE
-
be
-
be_BY
-
bg
-
bg_BG
-
ca
-
ca_ES
-
cs
-
cs_CZ
-
da
-
da_DK
-
de
-
de_AT
-
de_CH
-
de_DE
-
de_LU
-
el
-
el_CY
-
el_GR
-
en
-
en_AU
-
en_CA
-
en_GB
-
en_HK
-
en_IE
-
en_IN
-
en_MT
-
en_NZ
-
en_PH
-
en_SG
-
en_US
-
en_ZA
-
es
-
es_AR
-
es_BO
-
es_CL
-
es_CO
-
es_CR
-
es_DO
-
es_EC
-
es_ES
-
es_GT
-
es_HN
-
es_MX
-
es_NI
-
es_PA
-
es_PE
-
es_PR
-
es_PY
-
es_SV
-
es_US
-
es_UY
-
es_VE
-
et
-
et_EE
-
fa
-
fa_IR
-
fi
-
fi_FI
-
fr
-
fr_BE
-
fr_CA
-
fr_CH
-
fr_FR
-
fr_LU
-
ga
-
ga_IE
-
he
-
he_IL
-
hi_IN
-
hr
-
hr_HR
-
hu
-
hu_HU
-
id
-
id_ID
-
is
-
is_IS
-
it
-
it_CH
-
it_IT
-
ja
-
ja_JP
-
kk_KZ
-
ko
-
ko_KR
-
lt
-
lt_LT
-
lv
-
lv_LV
-
mk
-
mk_MK
-
ms
-
ms_MY
-
mt
-
mt_MT
-
nb
-
nb_NO
-
nl
-
nl_BE
-
nl_NL
-
nn_NO
-
no
- See Also:
-
no_NO
Deprecated.nb_NOshould be used.- See Also:
-
pl
-
pl_PL
-
pt
-
pt_BR
-
pt_PT
-
ro
-
ro_MD
-
ro_RO
-
ru
-
ru_KZ
-
ru_RU
-
se
-
se_NO
-
sk
-
sk_SK
-
sl
-
sl_SI
-
sq
-
sq_AL
-
sr
-
sr_BA
-
sr_CS
-
sr_ME
-
sr_RS
-
sv
-
sv_SE
-
th
-
th_TH
-
tr
-
tr_TR
-
uk
-
uk_UA
-
vi
-
vi_VN
-
zh
-
zh_CN
-
zh_HK
-
zh_SG
-
zh_TW
-
-
Method Details
-
values
Returns an array containing the constants of this enum class, in the order they are declared.- Returns:
- an array containing the constants of this enum class, in the order they are declared
-
valueOf
Returns the enum constant of this class with the specified name. The string must match exactly an identifier used to declare an enum constant in this class. (Extraneous whitespace characters are not permitted.)- Parameters:
name- the name of the enum constant to be returned.- Returns:
- the enum constant with the specified name
- Throws:
IllegalArgumentException- if this enum class has no constant with the specified nameNullPointerException- if the argument is null
-
getByCode
Get aLocaleCodeinstance that corresponds to the given code.This method just calls
getByCode(code, true). Note that the behavior has changed since the version 1.13. In the older versions, this method was an alias ofgetByCode(code, false).- Parameters:
code- A locale code.- Returns:
- A
LocaleCodeinstance, ornullif not found. - See Also:
-
getByCodeIgnoreCase
Get aLocaleCodeinstance that corresponds to the given code.This method just calls
getByCode(code, false).- Parameters:
code- A locale code.- Returns:
- A
LocaleCodeinstance, ornullif not found. - See Also:
-
getByCode
Get aLocaleCodeinstance that corresponds to the given code.The format of the code should be either of the following:
- Parameters:
code- A locale code.caseSensitive- Iftrue, the language part of the given code must be lower-case and the country part, if notnull, must be upper-case. If false, this method internally canonicalizes the given code and then performs search.- Returns:
- A
LocaleCodeinstance, ornullif not found.
-
getByCode
Get aLocaleCodeinstance that corresponds to the given pair of language code and country code.This method just calls
getByCode(language, country, true). Note that the behavior has changed since the version 1.13. In the older versions, this method was an alias ofgetByCode(language, country, false).- Parameters:
language- ISO 639-1language code. Or "undefined" (case sensitive). If the given language code is one of legacy ones { "iw", "ji" and "in" }, it is regarded as its newer official counterpart { "he", "yi" and "id" }, respectively.country- ISO 3166-1 alpha-2 country code. Or "UNDEFINED" (case sensitive).- Returns:
- A
LocaleCode, ornullif not found. - See Also:
-
getByCodeIgnoreCase
Get aLocaleCodeinstance that corresponds to the given pair of language code and country code.This method just calls
getByCode(language, country, false).- Parameters:
language- ISO 639-1 language code. Or "undefined" (case insensitive). If the given language code is one of legacy ones { "iw", "ji" and "in" }, it is regarded as its newer official counterpart { "he", "yi" and "id" }, respectively.country- ISO 3166-1 alpha-2 country code. Or "UNDEFINED" (case insensitive).- Returns:
- A
LocaleCode, ornullif not found. - See Also:
-
getByCode
Get aLocaleCodeinstance that corresponds to the given pair of language code and country code.If
languageis "undefined" and ifcountryisnullor "UNDEFINED",LocaleCode.undefinedis returned.- Parameters:
language- ISO 639-1 language code. Or "undefined". If the given language code is one of legacy ones { "iw", "ji" and "in" }, it is regarded as its newer official counterpart { "he", "yi" and "id" }, respectively.country- ISO 3166-1 alpha-2 country code. Or "UNDEFINED".caseSensitive- Iftrue, the given language code must be lower-case and the given country code, if notnull, must be upper-case. Iffalse, this method internally canonicalizes the given codes and then performs search.- Returns:
- A
LocaleCode, ornullif not found.
-
getByLocale
Get aLocaleCodeinstance that corresponds to the givenLocaleinstance.- Parameters:
locale- ALocaleinstance.- Returns:
- A
LocaleCodeinstance, ornullif not found. When the value returned bygetLanguage()method of the given instance isnullor an empty string and the value returned bygetCountry()method of the given instance isnullor an empty string,LocaleCode.undefinedis returned.
-
getByLanguage
Get a list ofLocaleCodeinstances whose language matches the given one.This method is an alias of
getByLanguage(language, true). Note that the behavior has changed since the version 1.13. In the older versions, this method was an alias ofgetByLanguage(language, false).- Parameters:
language- Language code. ISO 639 alpha-2 or alpha-3.- Returns:
- List of
LocaleCodeinstances. If there is noLocaleCodeinstance whose language matches the given one, the size of the returned list is zero.
-
getByLanguageIgnoreCase
Get a list ofLocaleCodeinstances whose language matches the given one.This method is an alias of
getByLanguage(language, false).- Parameters:
language- Language code. ISO 639 alpha-2 or alpha-3.- Returns:
- List of
LocaleCodeinstances. If there is noLocaleCodeinstance whose language matches the given one, the size of the returned list is zero.
-
getByLanguage
Get a list ofLocaleCodeinstances whose language matches the given one.This method is an alias of
getByLanguage(LanguageCode.getByCode(language, caseSensitive)).- Parameters:
language- Language code. ISO 639 alpha-2 or alpha-3.caseSensitive- Iftrue, the given code should consist of lowercase letters only. Iffalse, case is ignored.- Returns:
- List of
LocaleCodeinstances. If there is noLocaleCodeinstance whose language matches the given one, the size of the returned list is zero.
-
getByLanguage
Get a list ofLocaleCodeinstances whose language matches the given one.- Parameters:
language-LanguageCodeinstance that represents a language.- Returns:
- List of
LocaleCodeinstances. If there is noLocaleCodeinstance whose language matches the given one, the size of the returned list is zero.
-
getByCountry
Get a list ofLocaleCodeinstances whose country matches the given one.This method is an alias of
getByCountry(country, true). Note that the behavior has changed since the version 1.13. In the older versions, this method was an alias ofgetByCountry(country, false).- Parameters:
country- Country code. ISO 3166-1 alpha-2 or alpha-3.- Returns:
- List of
LocaleCodeinstances. If there is noLocaleCodeinstance whose country matches the given one, the size of the returned list is zero.
-
getByCountryIgnoreCase
Get a list ofLocaleCodeinstances whose country matches the given one.This method is an alias of
getByCountry(country, false).- Parameters:
country- Country code. ISO 3166-1 alpha-2 or alpha-3.- Returns:
- List of
LocaleCodeinstances. If there is noLocaleCodeinstance whose country matches the given one, the size of the returned list is zero.
-
getByCountry
Get a list ofLocaleCodeinstances whose country matches the given one.This method is an alias of
getByCountry(CountryCode.getByCode(country, caseSensitive)).- Parameters:
country- Country code. ISO 3166-1 alpha-2 or alpha-3.caseSensitive- Iftrue, the given code should consist of uppercase letters only. Iffalse, case is ignored.- Returns:
- List of
LocaleCodeinstances. If there is noLocaleCodeinstance whose country matches the given one, the size of the returned list is zero.
-
getByCountry
Get a list ofLocaleCodeinstances whose country matches the given one.- Parameters:
country-CountryCodeinstance that represents a country.- Returns:
- List of
LocaleCodeinstances. If there is noLocaleCodeinstance whose country matches the given one, the size of the returned list is zero.
-
getLanguage
Get the language code.- Returns:
- The language code. This method always returns a non-null value.
-
getCountry
Get the country code.- Returns:
- The country code. This method may return null.
For example,
LocaleCode.en.getCountry() returns null.
-
toString
Get the string representation of this locale code. Its format is either of the following:- language
- language
-country
- Overrides:
toStringin classEnum<LocaleCode>- Returns:
- The string representation of this locale code.
-
toLocale
Convert thisLocaleCodeinstance to aLocaleinstance.In most cases, this method creates a new
In addition,Localeinstance every time it is called, but someLocaleCodeinstances return their corresponding entries inLocaleclass. For example,LocaleCode.italways returnsLocale.ITALIAN.toLocale()ofLocaleCode.undefinedbehaves a bit differently. It returnsLocale.ROOTwhen it is available (i.e. when the version of Java SE is 1.6 or higher). Otherwise, it returns aLocaleinstance whose language and country are empty strings. Even in the latter case, the same instance is returned on every call.- Returns:
- A
Localeinstance that matches thisLocaleCode.
-
nbornb_NOshould be used.