info.fingo.util
Class Locales

java.lang.Object
  info.fingo.util.Locales

public class Locales
extends java.lang.Object

Provides some locale related utility method. First of all service for countries and languages.

Author:

Mariusz, FINGO - Robert Marek

Field Summary

static java.lang.String

DEFAULT_CHARSET The default charset used for loading localization files: 'ISO-8859-1'.

Method Summary

static java.util.Vector<Pair>	getCountries() Returns sorted names of all countries using default locale.
static java.util.Vector<Pair>	getCountries(java.lang.String locale) Returns sorted names of all countries using specified locale.
static java.util.Vector<Pair>	getCountries(java.lang.String[] countriesToShow, java.lang.String locale) Returns sorted names of given countries using specified locale.
static java.lang.String	getCountryName(java.lang.String country) Returns the name of the given country using defualt locale.
static java.lang.String	getCountryName(java.lang.String country, java.lang.String locale) Returns name of the given country using specified locale.
static java.lang.String	getLanguageName(java.lang.String language) Returns the name of the given language using default locale.
static java.lang.String	getLanguageName(java.lang.String language, java.lang.String locale) Returns the name of the given language using speicified locale.
static java.util.Vector<Pair>	getLanguages() Returns the sorted languages using default locale.
static java.util.Vector<Pair>	getLanguages(java.lang.String locale) Returns the sorted languages using given locale.
static java.util.Vector<Pair>	getLanguages(java.lang.String[] languagesToShow, java.lang.String locale) Returns sorted names of given languages using specified locales.
static Locales	getLocales(java.lang.String locDir) Get the only and one Locales object Localization file is set to Localization Reloading is set to false Default language is set to empty
static Locales	getLocales(java.lang.String locDir, java.lang.String defLanguage) Get the only and one Locales object Localization file is set to Localization Reloading is set to false
static Locales	getLocales(java.lang.String locDir, java.lang.String locFile, java.lang.String defLanguage, boolean autoreload) Get the only and one Locales object
static Locales	getLocales(java.lang.String locDir, java.lang.String locFile, java.lang.String defLanguage, java.lang.String charset, boolean autoreload) Get the only and one Locales object
java.lang.String	getString(java.lang.String key) Returns the value of the given key for default language.
java.lang.String	getString(java.lang.String key, java.lang.String language) Returns the value of the given key for the given language.
java.lang.String	includeFile(java.lang.String file) Get content of localization file for default language If not found, return [file]
java.lang.String	includeFile(java.lang.String file, java.lang.String language) Get content of localization file for language File have to be placed in subdirectory for given language code If not found, return [file]
void	reload() Reload cached resources

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

DEFAULT_CHARSET

public static final java.lang.String DEFAULT_CHARSET

The default charset used for loading localization files: 'ISO-8859-1'.

See Also:

Constant Field Values

Method Detail

getLocales

public static Locales getLocales(java.lang.String locDir,
                                 java.lang.String locFile,
                                 java.lang.String defLanguage,
                                 java.lang.String charset,
                                 boolean autoreload)

Get the only and one Locales object

Parameters:

locDir - directory with localization files

locFile - base name of localization file

defLanguage - language used if requested not found

charset - character set using for proper file reading

autoreload - if true, resources are reloaded each time a resource is requested

Returns:

Locales object

getLocales

public static Locales getLocales(java.lang.String locDir,
                                 java.lang.String locFile,
                                 java.lang.String defLanguage,
                                 boolean autoreload)

Get the only and one Locales object

Parameters:

locDir - directory with localization files

locFile - base name of localization file

defLanguage - language used if requested not found

autoreload - if true, resources are reloaded each time a resource is requested

Returns:

Locales object

getLocales

public static Locales getLocales(java.lang.String locDir,
                                 java.lang.String defLanguage)

Get the only and one Locales object Localization file is set to Localization Reloading is set to false

Parameters:

locDir - directory with localization files

defLanguage - language used if requested not found

Returns:

Locales object

getLocales

public static Locales getLocales(java.lang.String locDir)

Get the only and one Locales object Localization file is set to Localization Reloading is set to false Default language is set to empty

Parameters:

locDir - directory with localization files

Returns:

Locales object

getString

public java.lang.String getString(java.lang.String key)

Returns the value of the given key for default language. If not found returns [key].

Parameters:

key - The key

Returns:

String The value of the given key for the given language

getString

public java.lang.String getString(java.lang.String key,
                                  java.lang.String language)

Returns the value of the given key for the given language. If not found it tries to retrieve the value for the default language. If still not found returns [key].

Parameters:

key - The key

language - The language ISO code

Returns:

String The value of the given key for the given language

includeFile

public java.lang.String includeFile(java.lang.String file)

Get content of localization file for default language If not found, return [file]

Parameters:

file - file name

Returns:

content of localization file

includeFile

public java.lang.String includeFile(java.lang.String file,
                                    java.lang.String language)

Get content of localization file for language File have to be placed in subdirectory for given language code If not found, return [file]

Parameters:

file - file name

language - language ISO code

Returns:

content of localization file

reload

public void reload()

Reload cached resources

getCountries

public static java.util.Vector<Pair> getCountries()

Returns sorted names of all countries using default locale.

Returns:

Vector of pairs: key=2-letter country iso code, value=country name

getCountries

public static java.util.Vector<Pair> getCountries(java.lang.String locale)

Returns sorted names of all countries using specified locale.

Parameters:

locale - 2-letter iso code of the locales language

Returns:

Vector of pairs: key=2-letter country iso code, value=country name

getCountries

public static java.util.Vector<Pair> getCountries(java.lang.String[] countriesToShow,
                                                  java.lang.String locale)

Returns sorted names of given countries using specified locale.

Parameters:

countriesToShow - 2-letter iso codes

locale - 2-letter iso code of the locales language

Returns:

Vector of pairs: key=2-letter country iso code, value=country name

getCountryName

public static java.lang.String getCountryName(java.lang.String country,
                                              java.lang.String locale)

Returns name of the given country using specified locale.

Parameters:

country - the 2-letter iso code of the country

locale - t2-letter iso code of the locales language

Returns:

The name of the country

getCountryName

public static java.lang.String getCountryName(java.lang.String country)

Returns the name of the given country using defualt locale.

Parameters:

country - the 2-letter country iso code

Returns:

The name of the country

getLanguages

public static java.util.Vector<Pair> getLanguages()

Returns the sorted languages using default locale.

Returns:

Vector of pairs: key=2-letter iso code, value=language name

getLanguages

public static java.util.Vector<Pair> getLanguages(java.lang.String locale)

Returns the sorted languages using given locale.

Parameters:

locale - 2-letter iso code of the language of the locale

Returns:

Vector of pairs: key=2-letter iso code, value=language name

getLanguages

public static java.util.Vector<Pair> getLanguages(java.lang.String[] languagesToShow,
                                                  java.lang.String locale)

Returns sorted names of given languages using specified locales.

Parameters:

languagesToShow - 2-letter iso codes

locale - 2-letter iso code of language of the locale

Returns:

Vector of pairs: key=2-letter iso code, value=language name

getLanguageName

public static java.lang.String getLanguageName(java.lang.String language,
                                               java.lang.String locale)

Returns the name of the given language using speicified locale.

Parameters:

language - the language 2-letter iso code

locale - the 2-letter iso code of language of locale to use

Returns:

The language name.

getLanguageName

public static java.lang.String getLanguageName(java.lang.String language)

Returns the name of the given language using default locale.

Parameters:

language - the language 2-letter iso code

Returns:

The language name