LocaleCode (Neo Visionaries Internationalization Package 1.18 API)

java.lang.Object
- java.lang.Enum<LocaleCode>
- - com.neovisionaries.i18n.LocaleCode

All Implemented Interfaces:: Serializable, Comparable<LocaleCode>

public enum LocaleCode
extends Enum<LocaleCode>

Locale code.

The list of the enum entries was generated based on the output from Locale.getAvailableLocales() of Java SE 7, but locales whose format do not match either 'xx' or 'xx-XX' were excluded.

 // List all the locale codes.
 for (LocaleCode code : LocaleCode.values())
 {
     String language = code.getLanguage().getName();
     String country  = code.getCountry() != null
                     ? code.getCountry().getName() : null;

     // For example, "[de-DE] German, Germany" is printed.
     System.out.format("[%s] %s, %s\n", code, language, country);
 }

 // Get a LocaleCode instance in various ways.
 LocaleCode code;
 code = LocaleCode.getByCode("en-GB");
 code = LocaleCode.getByCode("es", "ES");
 code = LocaleCode.getByLocale(new Locale("pt", "BR"));

 // Convert to a Locale instance.
 Locale locale = LocaleCode.en.toLocale();

 // toLocale() of some LocaleCode instances does not create
 // a new Locale instance but returns a static variable of
 // Locale class instead. See toLocale() for details.
 if (locale == Locale.ENGLISH)
 {
     System.out.println("Locale.en.toLocale() returned Locale.ENGLISH");
 }

 // Get a list of LocaleCode instances whose language is Arabic.
 List<LocaleCode> list = LocaleCode.getByLanguage(LanguageCode.ar);

 // Get a list of LocaleCode instances whose country is Switzerland.
 list = LocaleCode.getByCountry(CountryCode.CH);

Author:: Takahiko Kawasaki

Enum Constant Summary

Enum Constants
Enum Constant and Description
`ar` `Arabic`
`ar_AE` `Arabic`, `United Arab Emirates`
`ar_BH` `Arabic`, `Bahrain`
`ar_DZ` `Arabic`, `Algeria`
`ar_EG` `Arabic`, `Egypt`
`ar_IQ` `Arabic`, `Iraq`
`ar_JO` `Arabic`, `Jordan`
`ar_KW` `Arabic`, `Kuwait`
`ar_LB` `Arabic`, `Lebanon`
`ar_LY` `Arabic`, `Libya`
`ar_MA` `Arabic`, `Morocco`
`ar_OM` `Arabic`, `Oman`
`ar_QA` `Arabic`, `Qatar`
`ar_SA` `Arabic`, `Saudi Arabia`
`ar_SD` `Arabic`, `Sudan`
`ar_SY` `Arabic`, `Syrian Arab Republic`
`ar_TN` `Arabic`, `Tunisia`
`ar_YE` `Arabic`, `Yemen`
`be` `Belarusian`
`be_BY` `Belarusian`, `Belarus`
`bg` `Bulgarian`
`bg_BG` `Bulgarian`, `Bulgaria`
`ca` `Catalan`
`ca_ES` `Catalan`, `Spain`
`cs` `Czech`
`cs_CZ` `Czech`, `Czech Republic`
`da` `Danish`
`da_DK` `Danish`, `Denmark`
`de` `German`
`de_AT` `German`, `Austria`
`de_CH` `German`, `Switzerland`
`de_DE` `German`, `Germany`
`de_LU` `German`, `Luxembourg`
`el` `Greek`
`el_CY` `Greek`, `Cyprus`
`el_GR` `Greek`, `Greece`
`en` `English`
`en_AU` `English`, `Australia`
`en_CA` `English`, `Canada`
`en_GB` `English`, `United Kingdom`
`en_IE` `English`, `Ireland`
`en_IN` `English`, `India`
`en_MT` `English`, `Malta`
`en_NZ` `English`, `New Zealand`
`en_PH` `English`, `Philippines`
`en_SG` `English`, `Singapore`
`en_US` `English`, `United States`
`en_ZA` `English`, `South Africa`
`es` `Spanish`
`es_AR` `Spanish`, `Argentina`
`es_BO` `Spanish`, `Bolivia, Plurinational State of`
`es_CL` `Spanish`, `Chile`
`es_CO` `Spanish`, `Colombia`
`es_CR` `Spanish`, `Costa Rica`
`es_DO` `Spanish`, `Dominican Republic`
`es_EC` `Spanish`, `Ecuador`
`es_ES` `Spanish`, `Spain`
`es_GT` `Spanish`, `Guatemala`
`es_HN` `Spanish`, `Honduras`
`es_MX` `Spanish`, `Mexico`
`es_NI` `Spanish`, `Nicaragua`
`es_PA` `Spanish`, `Panama`
`es_PE` `Spanish`, `Peru`
`es_PR` `Spanish`, `Puerto Rico`
`es_PY` `Spanish`, `Paraguay`
`es_SV` `Spanish`, `El Salvador`
`es_US` `Spanish`, `United States`
`es_UY` `Spanish`, `Uruguay`
`es_VE` `Spanish`, `Venezuela, Bolivarian Republic of`
`et` `Estonian`
`et_EE` `Estonian`, `Estonia`
`fi` `Finnish`
`fi_FI` `Finnish`, `Finland`
`fr` `French`
`fr_BE` `French`, `Belgium`
`fr_CA` `French`, `Canada`
`fr_CH` `French`, `Switzerland`
`fr_FR` `French`, `France`
`fr_LU` `French`, `Luxembourg`
`ga` `Irish`
`ga_IE` `Irish`, `Ireland`
`he` `Hebrew`
`he_IL` `Hebrew`, `Israel`
`hi_IN` `Hindi`, `India`
`hr` `Croatian`
`hr_HR` `Croatian`, `Croatia`
`hu` `Hungarian`
`hu_HU` `Hungarian`, `Hungary`
`id` `Indonesian`
`id_ID` `Indonesian`, `Indonesia`
`is` `Icelandic`
`is_IS` `Icelandic`, `Iceland`
`it` `Italian`
`it_CH` `Italian`, `Switzerland`
`it_IT` `Italian`, `Italy`
`ja` `Japanese`
`ja_JP` `Japanese`, `Japan`
`ko` `Korean`
`ko_KR` `Korean`, `Korea, Republic of`
`lt` `Lithuanian`
`lt_LT` `Lithuanian`, `Lithuania`
`lv` `Latvian`
`lv_LV` `Latvian`, `Latvia`
`mk` `Macedonian`
`mk_MK` `Macedonian`, `Macedonia, the former Yugoslav Republic of`
`ms` `Malay`
`ms_MY` `Malay`, `Malaysia`
`mt` `Maltese`
`mt_MT` `Maltese`, `Malta`
`nb` `Norwegian Bokmål`
`nb_NO` `Norwegian Bokmål`, `Norway`
`nl` `Dutch`
`nl_BE` `Dutch`, `Belgium`
`nl_NL` `Dutch`, `Netherlands`
`nn_NO` `Norwegian Nynorsk`, `Norway`
`no` Deprecated. `nb` or `nb_NO` should be used.
`no_NO` Deprecated. `nb_NO` should be used.
`pl` `Polish`
`pl_PL` `Polish`, `Poland`
`pt` `Portuguese`
`pt_BR` `Portuguese`, `Brazil`
`pt_PT` `Portuguese`, `Portugal`
`ro` `Romanian`
`ro_RO` `Romanian`, `Romania`
`ru` `Russian`
`ru_RU` `Russian`, `Russian Federation`
`se` `Northern Sami`
`se_NO` `Northern Sami`, `Norway`
`sk` `Slovak`
`sk_SK` `Slovak`, `Slovakia`
`sl` `Slovene`
`sl_SI` `Slovene`, `Slovenia`
`sq` `Albanian`
`sq_AL` `Albanian`, `Albania`
`sr` `Serbian`
`sr_BA` `Serbian`, `Bosnia and Herzegovina`
`sr_CS` `Serbian`, `Serbia and Montenegro`
`sr_ME` `Serbian`, `Montenegro`
`sr_RS` `Serbian`, `Serbia`
`sv` `Swedish`
`sv_SE` `Swedish`, `Sweden`
`th` `Thai`
`th_TH` `Thai`, `Thailand`
`tr` `Turkish`
`tr_TR` `Turkish`, `Turkey`
`uk` `Ukrainian`
`uk_UA` `Ukrainian`, `Ukraine`
`undefined` `Undefined`, `Undefined`
`vi` `Vietnamese`
`vi_VN` `Vietnamese`, `Viet Nam`
`zh` `Chinese`
`zh_CN` `Chinese`, `China`
`zh_HK` `Chinese`, `Hong Kong`
`zh_SG` `Chinese`, `Singapore`
`zh_TW` `Chinese`, `Taiwan, Province of China`

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`static LocaleCode`	`getByCode(String code)` Get a `LocaleCode` instance that corresponds to the given code.
`static LocaleCode`	`getByCode(String code, boolean caseSensitive)` Get a `LocaleCode` instance that corresponds to the given code.
`static LocaleCode`	`getByCode(String language, String country)` Get a `LocaleCode` instance that corresponds to the given pair of language code and country code.
`static LocaleCode`	`getByCode(String language, String country, boolean caseSensitive)` Get a `LocaleCode` instance that corresponds to the given pair of language code and country code.
`static LocaleCode`	`getByCodeIgnoreCase(String code)` Get a `LocaleCode` instance that corresponds to the given code.
`static LocaleCode`	`getByCodeIgnoreCase(String language, String country)` Get a `LocaleCode` instance that corresponds to the given pair of language code and country code.
`static List<LocaleCode>`	`getByCountry(CountryCode country)` Get a list of `LocaleCode` instances whose country matches the given one.
`static List<LocaleCode>`	`getByCountry(String country)` Get a list of `LocaleCode` instances whose country matches the given one.
`static List<LocaleCode>`	`getByCountry(String country, boolean caseSensitive)` Get a list of `LocaleCode` instances whose country matches the given one.
`static List<LocaleCode>`	`getByCountryIgnoreCase(String country)` Get a list of `LocaleCode` instances whose country matches the given one.
`static List<LocaleCode>`	`getByLanguage(LanguageCode language)` Get a list of `LocaleCode` instances whose language matches the given one.
`static List<LocaleCode>`	`getByLanguage(String language)` Get a list of `LocaleCode` instances whose language matches the given one.
`static List<LocaleCode>`	`getByLanguage(String language, boolean caseSensitive)` Get a list of `LocaleCode` instances whose language matches the given one.
`static List<LocaleCode>`	`getByLanguageIgnoreCase(String language)` Get a list of `LocaleCode` instances whose language matches the given one.
`static LocaleCode`	`getByLocale(Locale locale)` Get a `LocaleCode` instance that corresponds to the given `Locale` instance.
`CountryCode`	`getCountry()` Get the country code.
`LanguageCode`	`getLanguage()` Get the language code.
`Locale`	`toLocale()` Convert this `LocaleCode` instance to a `Locale` instance.
`String`	`toString()` Get the string representation of this locale code.
`static LocaleCode`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static LocaleCode[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

Enum Constant Detail

undefined

public static final LocaleCode undefined

Undefined, Undefined

Since:: 1.14

ar
```
public static final LocaleCode ar
```
Arabic

ar_AE
```
public static final LocaleCode ar_AE
```
Arabic, United Arab Emirates

ar_BH
```
public static final LocaleCode ar_BH
```
Arabic, Bahrain

ar_DZ
```
public static final LocaleCode ar_DZ
```
Arabic, Algeria

ar_EG
```
public static final LocaleCode ar_EG
```
Arabic, Egypt

ar_IQ
```
public static final LocaleCode ar_IQ
```
Arabic, Iraq

ar_JO
```
public static final LocaleCode ar_JO
```
Arabic, Jordan

ar_KW
```
public static final LocaleCode ar_KW
```
Arabic, Kuwait

ar_LB
```
public static final LocaleCode ar_LB
```
Arabic, Lebanon

ar_LY
```
public static final LocaleCode ar_LY
```
Arabic, Libya

ar_MA
```
public static final LocaleCode ar_MA
```
Arabic, Morocco

ar_OM
```
public static final LocaleCode ar_OM
```
Arabic, Oman

ar_QA
```
public static final LocaleCode ar_QA
```
Arabic, Qatar

ar_SA
```
public static final LocaleCode ar_SA
```
Arabic, Saudi Arabia

ar_SD
```
public static final LocaleCode ar_SD
```
Arabic, Sudan

ar_SY
```
public static final LocaleCode ar_SY
```
Arabic, Syrian Arab Republic

ar_TN
```
public static final LocaleCode ar_TN
```
Arabic, Tunisia

ar_YE
```
public static final LocaleCode ar_YE
```
Arabic, Yemen

be
```
public static final LocaleCode be
```
Belarusian

be_BY
```
public static final LocaleCode be_BY
```
Belarusian, Belarus

bg
```
public static final LocaleCode bg
```
Bulgarian

bg_BG
```
public static final LocaleCode bg_BG
```
Bulgarian, Bulgaria

ca
```
public static final LocaleCode ca
```
Catalan

ca_ES
```
public static final LocaleCode ca_ES
```
Catalan, Spain

cs
```
public static final LocaleCode cs
```
Czech

cs_CZ
```
public static final LocaleCode cs_CZ
```
Czech, Czech Republic

da
```
public static final LocaleCode da
```
Danish

da_DK
```
public static final LocaleCode da_DK
```
Danish, Denmark

de
```
public static final LocaleCode de
```
German

de_AT
```
public static final LocaleCode de_AT
```
German, Austria

de_CH
```
public static final LocaleCode de_CH
```
German, Switzerland

de_DE
```
public static final LocaleCode de_DE
```
German, Germany

de_LU
```
public static final LocaleCode de_LU
```
German, Luxembourg

el
```
public static final LocaleCode el
```
Greek

el_CY
```
public static final LocaleCode el_CY
```
Greek, Cyprus

el_GR
```
public static final LocaleCode el_GR
```
Greek, Greece

en
```
public static final LocaleCode en
```
English

en_AU
```
public static final LocaleCode en_AU
```
English, Australia

en_CA
```
public static final LocaleCode en_CA
```
English, Canada

en_GB
```
public static final LocaleCode en_GB
```
English, United Kingdom

en_IE
```
public static final LocaleCode en_IE
```
English, Ireland

en_IN
```
public static final LocaleCode en_IN
```
English, India

en_MT
```
public static final LocaleCode en_MT
```
English, Malta

en_NZ
```
public static final LocaleCode en_NZ
```
English, New Zealand

en_PH
```
public static final LocaleCode en_PH
```
English, Philippines

en_SG
```
public static final LocaleCode en_SG
```
English, Singapore

en_US
```
public static final LocaleCode en_US
```
English, United States

en_ZA
```
public static final LocaleCode en_ZA
```
English, South Africa

es
```
public static final LocaleCode es
```
Spanish

es_AR
```
public static final LocaleCode es_AR
```
Spanish, Argentina

es_BO
```
public static final LocaleCode es_BO
```
Spanish, Bolivia, Plurinational State of

es_CL
```
public static final LocaleCode es_CL
```
Spanish, Chile

es_CO
```
public static final LocaleCode es_CO
```
Spanish, Colombia

es_CR
```
public static final LocaleCode es_CR
```
Spanish, Costa Rica

es_DO
```
public static final LocaleCode es_DO
```
Spanish, Dominican Republic

es_EC
```
public static final LocaleCode es_EC
```
Spanish, Ecuador

es_ES
```
public static final LocaleCode es_ES
```
Spanish, Spain

es_GT
```
public static final LocaleCode es_GT
```
Spanish, Guatemala

es_HN
```
public static final LocaleCode es_HN
```
Spanish, Honduras

es_MX
```
public static final LocaleCode es_MX
```
Spanish, Mexico

es_NI
```
public static final LocaleCode es_NI
```
Spanish, Nicaragua

es_PA
```
public static final LocaleCode es_PA
```
Spanish, Panama

es_PE
```
public static final LocaleCode es_PE
```
Spanish, Peru

es_PR
```
public static final LocaleCode es_PR
```
Spanish, Puerto Rico

es_PY
```
public static final LocaleCode es_PY
```
Spanish, Paraguay

es_SV
```
public static final LocaleCode es_SV
```
Spanish, El Salvador

es_US
```
public static final LocaleCode es_US
```
Spanish, United States

es_UY
```
public static final LocaleCode es_UY
```
Spanish, Uruguay

es_VE
```
public static final LocaleCode es_VE
```
Spanish, Venezuela, Bolivarian Republic of

et
```
public static final LocaleCode et
```
Estonian

et_EE
```
public static final LocaleCode et_EE
```
Estonian, Estonia

fi
```
public static final LocaleCode fi
```
Finnish

fi_FI
```
public static final LocaleCode fi_FI
```
Finnish, Finland

fr
```
public static final LocaleCode fr
```
French

fr_BE
```
public static final LocaleCode fr_BE
```
French, Belgium

fr_CA
```
public static final LocaleCode fr_CA
```
French, Canada

fr_CH
```
public static final LocaleCode fr_CH
```
French, Switzerland

fr_FR
```
public static final LocaleCode fr_FR
```
French, France

fr_LU
```
public static final LocaleCode fr_LU
```
French, Luxembourg

ga
```
public static final LocaleCode ga
```
Irish

ga_IE
```
public static final LocaleCode ga_IE
```
Irish, Ireland

he
```
public static final LocaleCode he
```
Hebrew

he_IL
```
public static final LocaleCode he_IL
```
Hebrew, Israel

hi_IN
```
public static final LocaleCode hi_IN
```
Hindi, India

hr
```
public static final LocaleCode hr
```
Croatian

hr_HR
```
public static final LocaleCode hr_HR
```
Croatian, Croatia

hu
```
public static final LocaleCode hu
```
Hungarian

hu_HU
```
public static final LocaleCode hu_HU
```
Hungarian, Hungary

id
```
public static final LocaleCode id
```
Indonesian

id_ID
```
public static final LocaleCode id_ID
```
Indonesian, Indonesia

is
```
public static final LocaleCode is
```
Icelandic

is_IS
```
public static final LocaleCode is_IS
```
Icelandic, Iceland

it
```
public static final LocaleCode it
```
Italian

it_CH
```
public static final LocaleCode it_CH
```
Italian, Switzerland

it_IT
```
public static final LocaleCode it_IT
```
Italian, Italy

ja
```
public static final LocaleCode ja
```
Japanese

ja_JP
```
public static final LocaleCode ja_JP
```
Japanese, Japan

ko
```
public static final LocaleCode ko
```
Korean

ko_KR
```
public static final LocaleCode ko_KR
```
Korean, Korea, Republic of

lt
```
public static final LocaleCode lt
```
Lithuanian

lt_LT
```
public static final LocaleCode lt_LT
```
Lithuanian, Lithuania

lv
```
public static final LocaleCode lv
```
Latvian

lv_LV
```
public static final LocaleCode lv_LV
```
Latvian, Latvia

mk
```
public static final LocaleCode mk
```
Macedonian

mk_MK
```
public static final LocaleCode mk_MK
```
Macedonian, Macedonia, the former Yugoslav Republic of

ms
```
public static final LocaleCode ms
```
Malay

ms_MY
```
public static final LocaleCode ms_MY
```
Malay, Malaysia

mt
```
public static final LocaleCode mt
```
Maltese

mt_MT
```
public static final LocaleCode mt_MT
```
Maltese, Malta

nb
```
public static final LocaleCode nb
```
Norwegian Bokmål

Since:

1.8

nb_NO
```
public static final LocaleCode nb_NO
```
Norwegian Bokmål, Norway

Since:

1.8

nl
```
public static final LocaleCode nl
```
Dutch

nl_BE
```
public static final LocaleCode nl_BE
```
Dutch, Belgium

nl_NL
```
public static final LocaleCode nl_NL
```
Dutch, Netherlands

nn_NO
```
public static final LocaleCode nn_NO
```
Norwegian Nynorsk, Norway

no
```
public static final LocaleCode no
```
Deprecated. nb or nb_NO should be used.

Norwegian

See Also:

Språkkoder for POSIX locale i Norge, Red Hat Bugzilla – Bug 532487 Legacy Norwegian locale (no_NO) should be removed from language selection menu

no_NO
```
public static final LocaleCode no_NO
```
Deprecated. nb_NO should be used.

Norwegian, Norway

See Also:

Språkkoder for POSIX locale i Norge, Red Hat Bugzilla – Bug 532487 Legacy Norwegian locale (no_NO) should be removed from language selection menu

pl
```
public static final LocaleCode pl
```
Polish

pl_PL
```
public static final LocaleCode pl_PL
```
Polish, Poland

pt
```
public static final LocaleCode pt
```
Portuguese

pt_BR
```
public static final LocaleCode pt_BR
```
Portuguese, Brazil

pt_PT
```
public static final LocaleCode pt_PT
```
Portuguese, Portugal

ro
```
public static final LocaleCode ro
```
Romanian

ro_RO
```
public static final LocaleCode ro_RO
```
Romanian, Romania

ru
```
public static final LocaleCode ru
```
Russian

ru_RU
```
public static final LocaleCode ru_RU
```
Russian, Russian Federation

se
```
public static final LocaleCode se
```
Northern Sami

Since:

1.8

se_NO
```
public static final LocaleCode se_NO
```
Northern Sami, Norway

Since:

1.8

sk
```
public static final LocaleCode sk
```
Slovak

sk_SK
```
public static final LocaleCode sk_SK
```
Slovak, Slovakia

sl
```
public static final LocaleCode sl
```
Slovene

sl_SI
```
public static final LocaleCode sl_SI
```
Slovene, Slovenia

sq
```
public static final LocaleCode sq
```
Albanian

sq_AL
```
public static final LocaleCode sq_AL
```
Albanian, Albania

sr
```
public static final LocaleCode sr
```
Serbian

sr_BA
```
public static final LocaleCode sr_BA
```
Serbian, Bosnia and Herzegovina

sr_CS
```
public static final LocaleCode sr_CS
```
Serbian, Serbia and Montenegro

sr_ME
```
public static final LocaleCode sr_ME
```
Serbian, Montenegro

sr_RS
```
public static final LocaleCode sr_RS
```
Serbian, Serbia

sv
```
public static final LocaleCode sv
```
Swedish

sv_SE
```
public static final LocaleCode sv_SE
```
Swedish, Sweden

th
```
public static final LocaleCode th
```
Thai

th_TH
```
public static final LocaleCode th_TH
```
Thai, Thailand

tr
```
public static final LocaleCode tr
```
Turkish

tr_TR
```
public static final LocaleCode tr_TR
```
Turkish, Turkey

uk
```
public static final LocaleCode uk
```
Ukrainian

uk_UA
```
public static final LocaleCode uk_UA
```
Ukrainian, Ukraine

vi
```
public static final LocaleCode vi
```
Vietnamese

vi_VN
```
public static final LocaleCode vi_VN
```
Vietnamese, Viet Nam

zh
```
public static final LocaleCode zh
```
Chinese

zh_CN
```
public static final LocaleCode zh_CN
```
Chinese, China

zh_HK
```
public static final LocaleCode zh_HK
```
Chinese, Hong Kong

zh_SG
```
public static final LocaleCode zh_SG
```
Chinese, Singapore

zh_TW
```
public static final LocaleCode zh_TW
```
Chinese, Taiwan, Province of China

Method Detail

values
```
public static LocaleCode[] values()
```
Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (LocaleCode c : LocaleCode.values())
    System.out.println(c);
```
Returns:

an array containing the constants of this enum type, in the order they are declared

valueOf
```
public static LocaleCode valueOf(String name)
```
Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (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 type has no constant with the specified name

NullPointerException - if the argument is null

getLanguage
```
public LanguageCode getLanguage()
```
Get the language code.

Returns:

The language code. This method always returns a non-null value.

getCountry
```
public CountryCode getCountry()
```
Get the country code.

Returns:

The country code. This method may return null. For example, LocaleCode.en.getCountry() returns null.

toString
```
public String toString()
```
Get the string representation of this locale code. Its format is either of the following:
- language
- language-country
where language is an ISO 639-1 code and country is an ISO 3166-1 alpha-2 code.
Overrides:

toString in class Enum<LocaleCode>

Returns:

The string representation of this locale code.

toLocale

public Locale toLocale()

Convert this LocaleCode instance to a Locale instance.

In most cases, this method creates a new Locale instance every time it is called, but some LocaleCode instances return their corresponding entries in Locale class. For example, LocaleCode.it always returns Locale.ITALIAN.

The table below lists LocaleCode entries whose toLocale() does not create a new Locale instance but returns an entry in Locale class.

LocaleCode	Locale
`LocaleCode.de`	`Locale.GERMAN`
`LocaleCode.en`	`Locale.ENGLISH`
`LocaleCode.fr`	`Locale.FRENCH`
`LocaleCode.fr_CA`	`Locale.CANADA_FRENCH`
`LocaleCode.it`	`Locale.ITALIAN`
`LocaleCode.ja`	`Locale.JAPANESE`
`LocaleCode.ko`	`Locale.KOREAN`
`LocaleCode.zh`	`Locale.CHINESE`
`LocaleCode.zh_CN`	`Locale.SIMPLIFIED_CHINESE`
`LocaleCode.zh_TW`	`Locale.TRADITIONAL_CHINESE`

In addition, toLocale() of LocaleCode.undefined behaves a bit differently. It returns Locale.ROOT when it is available (i.e. when the version of Java SE is 1.6 or higher). Otherwise, it returns a Locale instance whose language and country are empty strings. Even in the latter case, the same instance is returned on every call.

Returns:: A Locale instance that matches this LocaleCode.

getByCode
```
public static LocaleCode getByCode(String code)
```
Get a LocaleCode instance 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 of getByCode(code, false).

Parameters:

code - A locale code.

Returns:

A LocaleCode instance, or null if not found.

See Also:

getByCode(String, boolean)

getByCodeIgnoreCase
```
public static LocaleCode getByCodeIgnoreCase(String code)
```
Get a LocaleCode instance that corresponds to the given code.
This method just calls getByCode(code, false).

Parameters:

code - A locale code.

Returns:

A LocaleCode instance, or null if not found.

Since:

1.13

See Also:

getByCode(String, boolean)

getByCode
```
public static LocaleCode getByCode(String code,
                                   boolean caseSensitive)
```
Get a LocaleCode instance that corresponds to the given code.
The format of the code should be either of the following:
- language
- language-country
where language is an ISO 639-1 code and country is an ISO 3166-1 alpha-2 code. The separator between language and country should be a hyphen (-) or an underscore (_).

Note that if the language part of the given code is one of legacy ones { "iw", "ji" and "in" }, it is regarded as its newer official counterpart { "he", "yi" and "id" }, respectively.
Parameters:

code - A locale code.

caseSensitive - If true, the language part of the given code must be lower-case and the country part, if not null, must be upper-case. If false, this method internally canonicalizes the given code and then performs search.

Returns:

A LocaleCode instance, or null if not found.

getByCode
```
public static LocaleCode getByCode(String language,
                                   String country)
```
Get a LocaleCode instance 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 of getByCode(language, country, false).

Parameters:

language - ISO 639-1 language 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, or null if not found.

See Also:

getByCode(String, String, boolean)

getByCodeIgnoreCase
```
public static LocaleCode getByCodeIgnoreCase(String language,
                                             String country)
```
Get a LocaleCode instance 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, or null if not found.

Since:

1.13

See Also:

getByCode(String, String, boolean)

getByCode
```
public static LocaleCode getByCode(String language,
                                   String country,
                                   boolean caseSensitive)
```
Get a LocaleCode instance that corresponds to the given pair of language code and country code.
If language is "undefined" and if country is null or "UNDEFINED", LocaleCode.undefined is 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 - If true, the given language code must be lower-case and the given country code, if not null, must be upper-case. If false, this method internally canonicalizes the given codes and then performs search.

Returns:

A LocaleCode, or null if not found.

getByLocale
```
public static LocaleCode getByLocale(Locale locale)
```
Get a LocaleCode instance that corresponds to the given Locale instance.

Parameters:

locale - A Locale instance.

Returns:

A LocaleCode instance, or null if not found. When the value returned by getLanguage() method of the given instance is null or an empty string and the value returned by getCountry() method of the given instance is null or an empty string, LocaleCode.undefined is returned.

getByLanguage
```
public static List<LocaleCode> getByLanguage(String language)
```
Get a list of LocaleCode instances 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 of getByLanguage(language, false).

Parameters:

language - Language code. ISO 639 alpha-2 or alpha-3.

Returns:

List of LocaleCode instances. If there is no LocaleCode instance whose language matches the given one, the size of the returned list is zero.

Since:

1.3

getByLanguageIgnoreCase
```
public static List<LocaleCode> getByLanguageIgnoreCase(String language)
```
Get a list of LocaleCode instances 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 LocaleCode instances. If there is no LocaleCode instance whose language matches the given one, the size of the returned list is zero.

Since:

1.13

getByLanguage
```
public static List<LocaleCode> getByLanguage(String language,
                                             boolean caseSensitive)
```
Get a list of LocaleCode instances 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 - If true, the given code should consist of lowercase letters only. If false, case is ignored.

Returns:

List of LocaleCode instances. If there is no LocaleCode instance whose language matches the given one, the size of the returned list is zero.

Since:

1.3

getByLanguage
```
public static List<LocaleCode> getByLanguage(LanguageCode language)
```
Get a list of LocaleCode instances whose language matches the given one.

Parameters:

language - LanguageCode instance that represents a language.

Returns:

List of LocaleCode instances. If there is no LocaleCode instance whose language matches the given one, the size of the returned list is zero.

Since:

1.3

getByCountry
```
public static List<LocaleCode> getByCountry(String country)
```
Get a list of LocaleCode instances 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 of getByCountry(country, false).

Parameters:

country - Country code. ISO 3166-1 alpha-2 or alpha-3.

Returns:

List of LocaleCode instances. If there is no LocaleCode instance whose country matches the given one, the size of the returned list is zero.

Since:

1.3

getByCountryIgnoreCase
```
public static List<LocaleCode> getByCountryIgnoreCase(String country)
```
Get a list of LocaleCode instances 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 LocaleCode instances. If there is no LocaleCode instance whose country matches the given one, the size of the returned list is zero.

Since:

1.13

getByCountry
```
public static List<LocaleCode> getByCountry(String country,
                                            boolean caseSensitive)
```
Get a list of LocaleCode instances 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 - If true, the given code should consist of uppercase letters only. If false, case is ignored.

Returns:

List of LocaleCode instances. If there is no LocaleCode instance whose country matches the given one, the size of the returned list is zero.

Since:

1.3

getByCountry
```
public static List<LocaleCode> getByCountry(CountryCode country)
```
Get a list of LocaleCode instances whose country matches the given one.

Parameters:

country - CountryCode instance that represents a country.

Returns:

List of LocaleCode instances. If there is no LocaleCode instance whose country matches the given one, the size of the returned list is zero.

Since:

1.3

Enum LocaleCode

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

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_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

fi

fi_FI