org.drombler.commons.client.util

Class ResourceBundleUtils

java.lang.Object

org.drombler.commons.client.util.ResourceBundleUtils

public final class ResourceBundleUtils
extends Object

A utility class to work with ResourceBundles.

Author:

puce

Field Summary

Fields

Modifier and Type	Field and Description
static String	KEY_PREFIX The prefix for resource keys to mark them as I18N keys.
static String	PACKAGE_RESOURCE_BUNDLE_BASE_NAME The resource bundle base name of package resource bundles.

Method Summary

Modifier and Type	Method and Description
static ResourceBundle	getClassResourceBundle(Class<?> type) Gets the resource bundle, which is in the same package as the provided type and has a base name equal to the simple name of the provided class.
static String	getClassResourceStringPrefixed(Class<?> type, String resourceKey) Gets a resource string from the class-ResourceBundle (same package and same base name as the provided type), if the resourceKey is prefixed with '%', else the resoure key itself gets returned (no I18N).
static ResourceBundle	getConditionalResourceBundle(Class<?> type, String resourceBundleBaseName) Gets the ResourceBundle.
static ResourceBundle	getConditionalResourceBundlePrefixed(Class<?> type, String resourceBundleBaseName, String resourceKey) Gets the ResourceBundle if the resource key is prefixed with '%', else null (no I18N).
static ResourceBundle	getPackageResourceBundle(Class<?> type) Gets the package-ResourceBundle (Bundle.properties), which is in the same package as the specified type.
static String	getPackageResourceStringPrefixed(Class<?> type, String resourceKey) Gets a resource string from the package-ResourceBundle (Bundle.properties), if the resourceKey is prefixed with '%', else the resoure key itself gets returned (no I18N).
static String	getPackageResourceStringPrefixed(String aPackage, String resourceKey, ClassLoader classLoader) Gets a resource string from the package-ResourceBundle (Bundle.properties), if the resourceKey is prefixed with '%', else the resoure key itself gets returned (no I18N).
static String	getResourceStringPrefixed(String resourceKey, ResourceBundle resourceBundle) If the resource key starts with '%' prefix, the prefix gets stripped and the value gets read from the provided ResourceBundle, else the provided resourceKey will be returned without lookup (no I18N).
static boolean	isPrefixedResourceString(String resourceKey) Checks if the resource key starts with the '%' prefix, which marks it as an I18N key.

Methods inherited from class java.lang.Object

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

Field Detail

PACKAGE_RESOURCE_BUNDLE_BASE_NAME

public static final String PACKAGE_RESOURCE_BUNDLE_BASE_NAME

The resource bundle base name of package resource bundles.

See Also:

Constant Field Values

KEY_PREFIX

public static final String KEY_PREFIX

The prefix for resource keys to mark them as I18N keys.

See Also:

Constant Field Values

Method Detail

getConditionalResourceBundlePrefixed

public static ResourceBundle getConditionalResourceBundlePrefixed(Class<?> type,
                                                                  String resourceBundleBaseName,
                                                                  String resourceKey)

Gets the ResourceBundle if the resource key is prefixed with '%', else null (no I18N).

 If resourceBundleBaseName is null, the getClassResourceBundle(java.lang.Class) gets returned.
 If resourceBundleBaseName equals 'Bundle', the getPackageResourceBundle(java.lang.Class) gets returned.
 Else the ResourceBundle for the resourceBundleBaseName gets returned using the same ClassLoader as the provided type.
 

Parameters:

type - the type

resourceBundleBaseName - the base name of the ResourceBundle, 'Bundle' (for the package ResourceBundle) or null (for the class ResourceBundle).

resourceKey - the prefixed resourceKey or the value to return (no I18N)

Returns:

the ResoureBundle if the resource key is prefixed with '%', else null (no I18N)

See Also:

getClassResourceBundle(java.lang.Class), getPackageResourceBundle(java.lang.Class), getConditionalResourceBundle(java.lang.Class, java.lang.String), KEY_PREFIX, PACKAGE_RESOURCE_BUNDLE_BASE_NAME

getConditionalResourceBundle

public static ResourceBundle getConditionalResourceBundle(Class<?> type,
                                                          String resourceBundleBaseName)

Gets the ResourceBundle.

 If resourceBundleBaseName is null, the getClassResourceBundle(java.lang.Class) gets returned.
 If resourceBundleBaseName equals 'Bundle', the getPackageResourceBundle(java.lang.Class) gets returned.
 Else the ResourceBundle for the resourceBundleBaseName gets returned using the same ClassLoader as the provided type.
 

Parameters:

type - the type

resourceBundleBaseName - the base name of the ResourceBundle, 'Bundle' (for the package ResourceBundle) or null (for the class ResourceBundle).

Returns:

the ResoureBundle

See Also:

getClassResourceBundle(java.lang.Class), getPackageResourceBundle(java.lang.Class), PACKAGE_RESOURCE_BUNDLE_BASE_NAME

getClassResourceBundle

public static ResourceBundle getClassResourceBundle(Class<?> type)

Gets the resource bundle, which is in the same package as the provided type and has a base name equal to the simple name of the provided class.

Parameters:

type - the type

Returns:

the resource bundle for the type

See Also:

getResourceBundle(java.lang.Class, java.lang.String)

getClassResourceStringPrefixed

public static String getClassResourceStringPrefixed(Class<?> type,
                                                    String resourceKey)

Gets a resource string from the class-ResourceBundle (same package and same base name as the provided type), if the resourceKey is prefixed with '%', else the resoure key itself gets returned (no I18N).

Parameters:

type - the type of the same package and the same simple name as the base name of the ResourceBundle

resourceKey - the prefixed resourceKey or the value to return (no I18N)

Returns:

if the resourceKey is prefixed, the value from the class-ResourceBundle, else the resourceKey (no I18N)

See Also:

KEY_PREFIX

getPackageResourceBundle

public static ResourceBundle getPackageResourceBundle(Class<?> type)

Gets the package-ResourceBundle (Bundle.properties), which is in the same package as the specified type.

Parameters:

type - a type of the same package

Returns:

the package ResourceBundle

See Also:

PACKAGE_RESOURCE_BUNDLE_BASE_NAME

getPackageResourceStringPrefixed

public static String getPackageResourceStringPrefixed(Class<?> type,
                                                      String resourceKey)

Gets a resource string from the package-ResourceBundle (Bundle.properties), if the resourceKey is prefixed with '%', else the resoure key itself gets returned (no I18N).

Parameters:

type - a type of the package

resourceKey - the prefixed key

Returns:

the package resource for the prefixed key, if the key is prefixed, else the resource key gets returned

See Also:

KEY_PREFIX

getPackageResourceStringPrefixed

public static String getPackageResourceStringPrefixed(String aPackage,
                                                      String resourceKey,
                                                      ClassLoader classLoader)

Gets a resource string from the package-ResourceBundle (Bundle.properties), if the resourceKey is prefixed with '%', else the resoure key itself gets returned (no I18N).

Parameters:

aPackage - the package

resourceKey - the prefixed resourceKey or the value to return (no I18N)

classLoader - the ClassLoader to load the ResourceBundle

Returns:

if the resourceKey is prefixed, the value from the package-ResourceBundle, else the resourceKey (no I18N)

See Also:

KEY_PREFIX

getResourceStringPrefixed

public static String getResourceStringPrefixed(String resourceKey,
                                               ResourceBundle resourceBundle)

If the resource key starts with '%' prefix, the prefix gets stripped and the value gets read from the provided ResourceBundle, else the provided resourceKey will be returned without lookup (no I18N).

Parameters:

resourceKey - the prefixed resourceKey or the value to return (no I18N)

resourceBundle - the ResourceBundle to lookup values

Returns:

if the resourceKey is prefixed, the value from the ResourceBundle, else the resourceKey (no I18N)

Throws:

MissingResourceException - if no value for the specified key can be found

ClassCastException - if the value is not a String

See Also:

KEY_PREFIX

isPrefixedResourceString

public static boolean isPrefixedResourceString(String resourceKey)

Checks if the resource key starts with the '%' prefix, which marks it as an I18N key.

Parameters:

resourceKey - the resource key to check

Returns:

true if the resource key starts with the '%' prefix, else false (no I18N)

See Also:

KEY_PREFIX