Class ResourceBundleManager

java.lang.Object

com.dlsc.gemsfx.util.ResourceBundleManager

public class ResourceBundleManager
extends Object

This class provides a centralized mechanism to retrieve localized strings from property files based on the current locale settings. It caches the resource bundles to avoid repetitive and unnecessary loading of the properties files.

Usage involves retrieving strings via base names of the resource bundles or by using predefined types which represent specific views or components in the application.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static enum	ResourceBundleManager.BundleType	Typed categories for the currently supported i18n bundle domains.
static enum	ResourceBundleManager.Type	Deprecated. use ResourceBundleManager.BundleType instead.

Method Summary

Modifier and Type	Method	Description
static String	format(ResourceBundleManager.BundleType bundleType, String key, Object... args)
static String	format(String baseName, String key, Object... args)
static ResourceBundle	getBundle(ResourceBundleManager.BundleType bundleType)
static ResourceBundle	getBundle(ResourceBundleManager.Type type)	Deprecated. use getBundle(BundleType) instead.
static ResourceBundle	getBundle(String baseName)	Retrieves the resource bundle for the specified base name and the current application locale.
static Locale	getLocale()
static String	getString(ResourceBundleManager.BundleType bundleType, String key)	Retrieves a localized string from the resource bundle associated with a given bundle type.
static String	getString(ResourceBundleManager.BundleType bundleType, String key, String fallbackValue)	Retrieves a localized string from the resource bundle associated with a given bundle type.
static String	getString(ResourceBundleManager.Type type, String key)	Deprecated. use getString(BundleType, String) instead.
static String	getString(ResourceBundleManager.Type type, String key, String fallbackValue)	Deprecated. use getString(BundleType, String, String) instead.
static String	getString(String baseName, String key)	Retrieves a localized string from the resource bundle specified by the base name.
static String	getString(String baseName, String key, String fallbackValue)	Retrieves a localized string from the resource bundle specified by the base name.
static void	setLocale(Locale locale)	Sets the current locale of the application.

Methods inherited from class Object

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

Method Details

getBundle

public static ResourceBundle getBundle(String baseName)

Retrieves the resource bundle for the specified base name and the current application locale. This method will return a cached bundle if it exists, or load a new bundle if it does not.

Parameters:

baseName - the base name of the resource bundle.

Returns:

the requested resource bundle.

getBundle

public static ResourceBundle getBundle(ResourceBundleManager.BundleType bundleType)

getBundle

@Deprecated
public static ResourceBundle getBundle(ResourceBundleManager.Type type)

Deprecated.

use getBundle(BundleType) instead.

setLocale

public static void setLocale(Locale locale)

Sets the current locale of the application. If the locale is changed, the method clears the cache of loaded resource bundles.

Parameters:

locale - the new locale to set as the current.

getLocale

public static Locale getLocale()

getString

public static String getString(String baseName,
 String key)

Retrieves a localized string from the resource bundle specified by the base name. If the key is not found, it logs a warning and returns the key itself.

Parameters:

baseName - the base name of the resource bundle.

key - the key for the desired string in the bundle.

Returns:

the localized string.

getString

public static String getString(String baseName,
 String key,
 String fallbackValue)

Retrieves a localized string from the resource bundle specified by the base name. If the key is not found, it logs a warning and returns the provided fallback value.

Parameters:

baseName - the base name of the resource bundle.

key - the key for the desired string in the bundle.

fallbackValue - the fallback value used when the key or bundle is missing.

Returns:

the localized string or fallback value.

getString

public static String getString(ResourceBundleManager.BundleType bundleType,
 String key)

Retrieves a localized string from the resource bundle associated with a given bundle type.

Parameters:

bundleType - the type of the resource bundle.

key - the key for the desired string in the bundle.

Returns:

the localized string.

getString

public static String getString(ResourceBundleManager.BundleType bundleType,
 String key,
 String fallbackValue)

Retrieves a localized string from the resource bundle associated with a given bundle type.

Parameters:

bundleType - the type of the resource bundle.

key - the key for the desired string in the bundle.

fallbackValue - the fallback value used when the key or bundle is missing.

Returns:

the localized string or fallback value.

getString

@Deprecated
public static String getString(ResourceBundleManager.Type type,
 String key)

Deprecated.

use getString(BundleType, String) instead.

getString

@Deprecated
public static String getString(ResourceBundleManager.Type type,
 String key,
 String fallbackValue)

Deprecated.

use getString(BundleType, String, String) instead.

format

public static String format(ResourceBundleManager.BundleType bundleType,
 String key,
 Object... args)

format

public static String format(String baseName,
 String key,
 Object... args)