com.izforge.izpack.api.resource

Interface Locales

public interface Locales

Supported locales.

IzPack uses 3 character ISO language and country codes to identify locale-specific resources rather than the convention used by Java to identify resources bundles.

This has the following restrictions:

• resources can either be associated with a particular country code or language code, but not both
• country codes should be specified as lower-case
• country codes are used in preference to language codes. This is to handle the case where a language variation is spoken for which there is no ISO language code.

  e.g Portuguese and Brazilian Portuguese.

  For resources bundles, these would typically be specified as "pt" and "pt_BR". In IzPack, they must be specified using "prt" and "bra" respectively.

Author:

Tim Anderson

Method Summary

Modifier and Type	Method and Description
String	getISOCode() Returns the current locale's 3 character ISO code.
List<String>	getISOCodes() Returns the 3 character ISO codes of the supported locales.
Locale	getLocale() Returns the current locale.
Locale	getLocale(String code) Returns the locale corresponding to the supplied ISO2/ISO3 code.
List<Locale>	getLocales() Returns the supported locales.
Messages	getMessages() Returns messages for the current locale.
Messages	getMessages(String name) Returns the named messages for the current locale.
void	setLocale(String code) Sets the current locale.

Method Detail

getLocale

Locale getLocale()

Returns the current locale.

Returns:

the current locale. May be null

setLocale

void setLocale(String code)

Sets the current locale.

Parameters:

code - the ISO code

Throws:

ResourceNotFoundException - if the locale isn't supported

getISOCode

String getISOCode()

Returns the current locale's 3 character ISO code.

This is the code that was used to select the locale's messages and may be a country or language code.

Returns:

the current locale's ISO code, or null if there is no current locale

getLocale

Locale getLocale(String code)

Returns the locale corresponding to the supplied ISO2/ISO3 code.

Parameters:

code - the ISO code. May be a country or language code

Returns:

the corresponding locale, or null if the locale isn't supported

getLocales

List<Locale> getLocales()

Returns the supported locales.

Returns:

the supported locales

getISOCodes

List<String> getISOCodes()

Returns the 3 character ISO codes of the supported locales.

For backward compatibility:

1. these should all be lowercase; and
2. may be a mix of language and country codes

Returns:

the ISO codes

getMessages

Messages getMessages()

Returns messages for the current locale.

Returns:

messages for the current locale

Throws:

ResourceNotFoundException - if the messages resource cannot be found

getMessages

Messages getMessages(String name)

Returns the named messages for the current locale.

Parameters:

name - the message resource name

Returns:

messages for the current locale

Throws:

ResourceNotFoundException - if the named resource cannot be found