de.alpharogroup.resourcebundle.locale

Class ResourceBundleExtensions

java.lang.Object

de.alpharogroup.resourcebundle.locale.ResourceBundleExtensions

public final class ResourceBundleExtensions
extends java.lang.Object

The class ResourceBundleExtensions holds extension methods for the class ResourceBundle.

Constructor Summary

Constructors

Constructor and Description
ResourceBundleExtensions()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	format(java.lang.String value, java.lang.Object... parameters) Formats the given value with the given parameters.
static java.lang.String	getString(BundleKey bundleKey) Resolves the String object from the given BundleKey.
static java.lang.String	getString(java.util.ResourceBundle resourceBundle, java.lang.String key, java.lang.Object... parameters) Gets the string from the given ResourceBundle object.
static java.lang.String	getString(java.util.ResourceBundle resourceBundle, java.lang.String key, java.lang.String defaultValue) Gets the string from the given ResourceBundle object.
static java.lang.String	getString(@NonNull java.util.ResourceBundle resourceBundle, @NonNull java.lang.String key, java.lang.String defaultValue, java.lang.Object... parameters) Gets the string from the given ResourceBundle object.
static java.lang.String	getString(java.lang.String baseName, java.util.Locale locale, java.lang.String key) Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.
static java.lang.String	getString(java.lang.String baseName, java.util.Locale locale, java.lang.String key, java.lang.Object... parameters) Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.
static java.lang.String	getString(java.lang.String baseName, java.util.Locale locale, java.lang.String key, java.lang.String defaultValue) Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.
static java.lang.String	getString(java.lang.String baseName, @NonNull java.util.Locale locale, java.lang.String key, java.lang.String defaultValue, java.lang.Object... parameters) Resolves from the given base name and locale the ResourceBundle and get the String from the given key and parameters.
static java.lang.String	getStringQuietly(java.util.ResourceBundle resourceBundle, java.lang.String key, java.lang.Object... parameters) Gets the string from the given ResourceBundle object.
static java.lang.String	getStringQuietly(java.util.ResourceBundle resourceBundle, java.lang.String key, java.lang.String defaultValue) Gets the string from the given ResourceBundle object.
static java.lang.String	getStringQuietly(@NonNull java.util.ResourceBundle resourceBundle, java.lang.String key, java.lang.String defaultValue, java.lang.Object... parameters) Gets the string from the given ResourceBundle object.
static java.lang.String	getStringQuietly(java.lang.String baseName, @NonNull java.util.Locale locale, java.lang.String key, java.lang.String defaultValue, java.lang.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

Constructor Detail

ResourceBundleExtensions

public ResourceBundleExtensions()

Method Detail

getString

public static java.lang.String getString(java.util.ResourceBundle resourceBundle,
                                         java.lang.String key,
                                         java.lang.Object... parameters)
                                  throws java.util.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:

java.util.MissingResourceException - is thrown if the given key is missing

getStringQuietly

public static java.lang.String getStringQuietly(java.util.ResourceBundle resourceBundle,
                                                java.lang.String key,
                                                java.lang.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 java.lang.String getString(java.util.ResourceBundle resourceBundle,
                                         java.lang.String key,
                                         java.lang.String defaultValue)
                                  throws java.util.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:

java.util.MissingResourceException - is thrown if the given key is missing

getStringQuietly

public static java.lang.String getStringQuietly(java.util.ResourceBundle resourceBundle,
                                                java.lang.String key,
                                                java.lang.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 java.lang.String getString(@NonNull
                                         @NonNull java.util.ResourceBundle resourceBundle,
                                         @NonNull
                                         @NonNull java.lang.String key,
                                         java.lang.String defaultValue,
                                         java.lang.Object... parameters)
                                  throws java.util.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:

java.util.MissingResourceException - is thrown if the given key is missing

format

public static java.lang.String format(java.lang.String value,
                                      java.lang.Object... parameters)

Formats the given value with the given parameters.

Parameters:

value - the value with the pattern

parameters - the parameters

Returns:

the formatted string

See Also:

MessageFormat.format(String, Object...)

getStringQuietly

public static java.lang.String getStringQuietly(@NonNull
                                                @NonNull java.util.ResourceBundle resourceBundle,
                                                java.lang.String key,
                                                java.lang.String defaultValue,
                                                java.lang.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 java.lang.String getString(java.lang.String baseName,
                                         @NonNull
                                         @NonNull java.util.Locale locale,
                                         java.lang.String key,
                                         java.lang.String defaultValue,
                                         java.lang.Object... parameters)
                                  throws java.util.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:

java.util.MissingResourceException - is thrown if the given key is missing

getStringQuietly

public static java.lang.String getStringQuietly(java.lang.String baseName,
                                                @NonNull
                                                @NonNull java.util.Locale locale,
                                                java.lang.String key,
                                                java.lang.String defaultValue,
                                                java.lang.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 java.lang.String getString(java.lang.String baseName,
                                         java.util.Locale locale,
                                         java.lang.String key,
                                         java.lang.Object... parameters)
                                  throws java.util.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:

java.util.MissingResourceException - is thrown if the given key is missing

getString

public static java.lang.String getString(java.lang.String baseName,
                                         java.util.Locale locale,
                                         java.lang.String key)
                                  throws java.util.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:

java.util.MissingResourceException - is thrown if the given key is missing

getString

public static java.lang.String getString(java.lang.String baseName,
                                         java.util.Locale locale,
                                         java.lang.String key,
                                         java.lang.String defaultValue)
                                  throws java.util.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:

java.util.MissingResourceException - is thrown if the given key is missing

getString

public static java.lang.String getString(BundleKey bundleKey)
                                  throws java.util.MissingResourceException

Resolves the String object from the given BundleKey.

Parameters:

bundleKey - the bundle key

Returns:

the String value from the given BundleKey.

Throws:

java.util.MissingResourceException - is thrown if the given key is missing