de.alpharogroup.resourcebundle.locale

Class ResourceBundleExtensions

java.lang.Object

de.alpharogroup.resourcebundle.locale.ResourceBundleExtensions

public class ResourceBundleExtensions
extends Object

The class ResourceBundleExtensions holds extension methods for the class ResourceBundle.

Field Summary

Fields

Modifier and Type	Field and Description
protected static org.apache.log4j.Logger	LOGGER The Constant logger.

Constructor Summary

Constructors

Constructor and Description
ResourceBundleExtensions()

Method Summary

Modifier and Type	Method and Description
static String	getString(BundleKey bundleKey) Resolves the String object from the given BundleKey.
static String	getString(ResourceBundle resourceBundle, String key, Object... parameters) Gets the string from the given ResourceBundle object.
static String	getString(ResourceBundle resourceBundle, String key, String defaultValue) Gets the string from the given ResourceBundle object.
static String	getString(ResourceBundle resourceBundle, String key, String defaultValue, Object... parameters) Gets the string from the given ResourceBundle object.
static String	getString(String baseName, Locale locale, String key) Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.
static String	getString(String baseName, Locale locale, String key, Object... parameters) Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.
static String	getString(String baseName, Locale locale, String key, String defaultValue) Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.
static String	getString(String baseName, Locale locale, String key, String defaultValue, Object... parameters) Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.
static String	getStringQuietly(ResourceBundle resourceBundle, String key, Object... parameters) Gets the string from the given ResourceBundle object.
static String	getStringQuietly(ResourceBundle resourceBundle, String key, String defaultValue) Gets the string from the given ResourceBundle object.
static String	getStringQuietly(ResourceBundle resourceBundle, String key, String defaultValue, Object... parameters) Gets the string from the given ResourceBundle object.
static String	getStringQuietly(String baseName, Locale locale, String key, String defaultValue, Object... parameters) Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.

Methods inherited from class java.lang.Object

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

Field Detail

LOGGER

protected static final org.apache.log4j.Logger LOGGER

The Constant logger.

Constructor Detail

ResourceBundleExtensions

public ResourceBundleExtensions()

Method Detail

getString

public static String getString(ResourceBundle resourceBundle,
                               String key,
                               Object... parameters)
                        throws MissingResourceException

Gets the string from the given ResourceBundle object.

Parameters:

resourceBundle - the resource bundle to get the String object.

key - the properties key

parameters - the parameters

Returns:

the String value from the given key

Throws:

MissingResourceException - is thrown if the given key is missing

getStringQuietly

public static String getStringQuietly(ResourceBundle resourceBundle,
                                      String key,
                                      Object... parameters)

Gets the string from the given ResourceBundle object.

Parameters:

resourceBundle - the resource bundle to get the String object.

key - the properties key

parameters - the parameters

Returns:

the String value from the given key

getString

public static String getString(ResourceBundle resourceBundle,
                               String key,
                               String defaultValue)
                        throws MissingResourceException

Gets the string from the given ResourceBundle object.

Parameters:

resourceBundle - the resource bundle to get the String object.

key - the properties key

defaultValue - the default value

Returns:

the String value from the given key

Throws:

MissingResourceException - is thrown if the given key is missing

getStringQuietly

public static String getStringQuietly(ResourceBundle resourceBundle,
                                      String key,
                                      String defaultValue)

Gets the string from the given ResourceBundle object.

Parameters:

resourceBundle - the resource bundle to get the String object.

key - the properties key

defaultValue - the default value

Returns:

the String value from the given key

getString

public static String getString(ResourceBundle resourceBundle,
                               String key,
                               String defaultValue,
                               Object... parameters)
                        throws MissingResourceException

Gets the string from the given ResourceBundle object.

Parameters:

resourceBundle - the resource bundle to get the String object.

key - the properties key

defaultValue - the default value

parameters - the parameters

Returns:

the String value from the given key

Throws:

MissingResourceException - is thrown if the given key is missing

getStringQuietly

public static String getStringQuietly(ResourceBundle resourceBundle,
                                      String key,
                                      String defaultValue,
                                      Object... parameters)

Gets the string from the given ResourceBundle object.

Parameters:

resourceBundle - the resource bundle to get the String object.

key - the properties key

defaultValue - the default value

parameters - the parameters

Returns:

the String value from the given key

getString

public static String getString(String baseName,
                               Locale locale,
                               String key,
                               String defaultValue,
                               Object... parameters)
                        throws MissingResourceException

Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.

Parameters:

baseName - the base name of the resource bundle, a fully qualified class name

locale - the locale for the resource bundle

key - the properties key

defaultValue - the default value

parameters - the parameters

Returns:

the String value from the given key

Throws:

MissingResourceException - is thrown if the given key is missing

getStringQuietly

public static String getStringQuietly(String baseName,
                                      Locale locale,
                                      String key,
                                      String defaultValue,
                                      Object... parameters)

Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.

Parameters:

baseName - the base name of the resource bundle, a fully qualified class name

locale - the locale for the resource bundle

key - the properties key

defaultValue - the default value

parameters - the parameters

Returns:

the String value from the given key

getString

public static String getString(String baseName,
                               Locale locale,
                               String key,
                               Object... parameters)
                        throws MissingResourceException

Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.

Parameters:

baseName - the base name of the resource bundle, a fully qualified class name

locale - the locale for the resource bundle

key - the properties key

parameters - the parameters

Returns:

the String value from the given key

Throws:

MissingResourceException - is thrown if the given key is missing

getString

public static String getString(String baseName,
                               Locale locale,
                               String key)
                        throws MissingResourceException

Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.

Parameters:

baseName - the base name of the resource bundle, a fully qualified class name

locale - the locale for the resource bundle

key - the properties key

Returns:

the String value from the given key

Throws:

MissingResourceException - is thrown if the given key is missing

getString

public static String getString(String baseName,
                               Locale locale,
                               String key,
                               String defaultValue)
                        throws MissingResourceException

Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.

Parameters:

baseName - the base name of the resource bundle, a fully qualified class name

locale - the locale for the resource bundle

key - the properties key

defaultValue - the default value

Returns:

the String value from the given key

Throws:

MissingResourceException - is thrown if the given key is missing

getString

public static String getString(BundleKey bundleKey)
                        throws MissingResourceException

Resolves the String object from the given BundleKey.

Parameters:

bundleKey - the bundle key

Returns:

the String value from the given BundleKey.

Throws:

MissingResourceException - is thrown if the given key is missing