de.alpharogroup.resourcebundle.locale

Class LocaleResolver

java.lang.Object

de.alpharogroup.resourcebundle.locale.LocaleResolver

public class LocaleResolver
extends java.lang.Object

The Class LocaleResolver helps to resolve locale objects and languages.

Constructor Summary

Constructors

Constructor and Description
LocaleResolver()

Method Summary

Modifier and Type	Method and Description
static java.util.List<java.util.Locale>	getAvailableLocales() Returns a list of all available locales on the current jdk.
static java.util.Locale	getLocale(@NonNull java.lang.String countryCode) Resolves a Locale from the given country code.
static java.util.List<java.util.Locale>	getLocales(@NonNull java.lang.String languageCode) Resolves a Locale objects from the given language code.
static boolean	isISOCountryCode(java.lang.String code) Checks the given code if its a valide ISO 3166-1 countrycode.
static java.util.Set<java.lang.String>	resolveAvailableLanguages(java.lang.String bundlepackage, java.lang.String bundlename) Resolves all the available languages for the given resource bundle name in the given bundle package.
java.util.List<java.util.Locale>	resolveAvailableLocales() Resolve available locales on the current system.
static java.lang.String	resolveBundlename(java.io.File propertiesFile) Resolves the bundle name from the given properties file.
static java.util.Locale	resolveLocale(java.io.File propertiesFile) Resolves the locale from the given properties file.
static java.util.Locale	resolveLocale(java.io.File propertiesFile, boolean systemsDefault) Resolves the locale from the given properties file.
static java.util.Locale	resolveLocale(java.io.File propertiesFile, java.util.Locale defaultLocale, boolean systemsDefault) Resolves the locale from the given properties file.
static java.util.Locale	resolveLocale(java.lang.String localeCode) Resolves the Locale object from the given locale code.
static java.util.Locale	resolveLocale(java.lang.String localeCode, boolean systemsDefault) Resolves the Locale object from the given locale code.
static java.util.Locale	resolveLocale(java.lang.String localeCode, java.util.Locale defaultLocale, boolean systemsDefault) Resolves the Locale object from the given locale code.
static java.lang.String	resolveLocaleCode(java.io.File propertiesFile) Resolves from the given properties file the locale code like "en", "en_US" or "en_US_win".
static java.util.Locale	resolveLocaleCode(java.lang.String code) Converts the given String code like "en", "en_US" or "en_US_win" to new Locale.
static java.util.Map<java.io.File,java.util.Locale>	resolveLocales(java.lang.String bundlepackage, java.lang.String bundlename) Resolves all the available Locales to the given resource bundle name in the given bundle package.
static java.util.Map<java.io.File,java.util.Locale>	resolveLocales(java.lang.String bundlepackage, java.lang.String bundlename, boolean systemsDefault) Resolves all the available Locales to the given resource bundle name in the given bundle package.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocaleResolver

public LocaleResolver()

Method Detail

isISOCountryCode

public static boolean isISOCountryCode(java.lang.String code)

Checks the given code if its a valide ISO 3166-1 countrycode.

Parameters:

code - The code to check.

Returns:

true if the code is valide otherwise false.

resolveAvailableLanguages

public static java.util.Set<java.lang.String> resolveAvailableLanguages(java.lang.String bundlepackage,
                                                                        java.lang.String bundlename)

Resolves all the available languages for the given resource bundle name in the given bundle package. Note the default resource bundle is named 'default'.

Parameters:

bundlepackage - The package that contains the properties files.

bundlename - The name of the resource bundle.

Returns:

a Set of String objects with the available languages excluding the default.

resolveBundlename

public static java.lang.String resolveBundlename(java.io.File propertiesFile)

Resolves the bundle name from the given properties file.

Parameters:

propertiesFile - the properties file

Returns:

the bundle name

resolveLocale

public static java.util.Locale resolveLocale(java.io.File propertiesFile)

Resolves the locale from the given properties file.

Parameters:

propertiesFile - the properties file

Returns:

the locale

resolveLocale

public static java.util.Locale resolveLocale(java.io.File propertiesFile,
                                             boolean systemsDefault)

Resolves the locale from the given properties file.

Parameters:

propertiesFile - the properties file

systemsDefault - if this flag is true the systems default locale will be taken if not found

Returns:

the locale

resolveLocale

public static java.util.Locale resolveLocale(java.io.File propertiesFile,
                                             java.util.Locale defaultLocale,
                                             boolean systemsDefault)

Resolves the locale from the given properties file.

Parameters:

propertiesFile - the properties file

defaultLocale - the default locale

systemsDefault - if this flag is true the systems default locale will be taken if not found

Returns:

the locale

resolveLocale

public static java.util.Locale resolveLocale(java.lang.String localeCode)

Resolves the Locale object from the given locale code. If not found the system default locale will be taken.

Parameters:

localeCode - the locale code

Returns:

the Locale object.

resolveLocale

public static java.util.Locale resolveLocale(java.lang.String localeCode,
                                             boolean systemsDefault)

Resolves the Locale object from the given locale code.

Parameters:

localeCode - the locale code

systemsDefault - if this flag is true the systems default locale will be taken if not found otherwise not

Returns:

the Locale object or null if not found and flag systemsDefault is false.

resolveLocale

public static java.util.Locale resolveLocale(java.lang.String localeCode,
                                             java.util.Locale defaultLocale,
                                             boolean systemsDefault)

Resolves the Locale object from the given locale code. If the given default locale is not null and the locale code does resolve to no locale the default locale will be returned.

Parameters:

localeCode - the locale code

defaultLocale - the default locale

systemsDefault - if this flag is true the systems default locale will be taken if not found otherwise not

Returns:

the Locale object or null if not found and flag systemsDefault is false and defaultLocale is null.

resolveLocaleCode

public static java.lang.String resolveLocaleCode(java.io.File propertiesFile)

Resolves from the given properties file the locale code like "en", "en_US" or "en_US_win". For instance if the filename is resource_en.properties than it will return "en", if the filename is resource_en_US.properties than it will return "en_US". If nothing is found than it returns that the properties file is the "default".

Parameters:

propertiesFile - the properties file

Returns:

the locale code

resolveLocaleCode

public static java.util.Locale resolveLocaleCode(java.lang.String code)

Converts the given String code like "en", "en_US" or "en_US_win" to new Locale.

Parameters:

code - the code

Returns:

the Locale object or null.

resolveLocales

public static java.util.Map<java.io.File,java.util.Locale> resolveLocales(java.lang.String bundlepackage,
                                                                          java.lang.String bundlename)

Resolves all the available Locales to the given resource bundle name in the given bundle package. For now it is only for properties files.

Parameters:

bundlepackage - The package that contains the properties files.

bundlename - The name of the resource bundle.

Returns:

a Map of File objects with the corresponding Locales to it.

resolveLocales

public static java.util.Map<java.io.File,java.util.Locale> resolveLocales(java.lang.String bundlepackage,
                                                                          java.lang.String bundlename,
                                                                          boolean systemsDefault)

Resolves all the available Locales to the given resource bundle name in the given bundle package. For now it is only for properties files.

Parameters:

bundlepackage - The package that contains the properties files.

bundlename - The name of the resource bundle.

systemsDefault - if this flag is true the systems default locale will be taken as the default locale otherwise the value will be null for the default locale.

Returns:

a Map of File objects with the corresponding Locales to it.

resolveAvailableLocales

public java.util.List<java.util.Locale> resolveAvailableLocales()

Resolve available locales on the current system.

Returns:

the list with the available locales.

getAvailableLocales

public static java.util.List<java.util.Locale> getAvailableLocales()

Returns a list of all available locales on the current jdk.

Returns:

list of all available locales on the current jdk.

getLocale

public static java.util.Locale getLocale(@NonNull
                                         @NonNull java.lang.String countryCode)

Resolves a Locale from the given country code.

Parameters:

countryCode - the country code

Returns:

the found Locale or null if not found

getLocales

public static java.util.List<java.util.Locale> getLocales(@NonNull
                                                          @NonNull java.lang.String languageCode)

Resolves a Locale objects from the given language code.

Parameters:

languageCode - the language code

Returns:

the found Locale objects or an empty list if nothing found