net.sf.basedb.util.resources
Class ResourceBundleWrapper

java.lang.Object
  net.sf.basedb.util.resources.ResourceBundleWrapper

public class ResourceBundleWrapper
extends Object

A wrapper around ResourceBundle objects. We use the wrapper because we don't want to throw exceptions if a key is missing. Instead, we return the key as the value and log a message to system log. There are also some other useful variants for retreiving values.

Since:

2.16

Author:

Nicklas

Last modified

$Date: 2010-09-16 13:32:06 +0200 (Thu, 16 Sep 2010) $

Field Summary

private static Logger	log
private String	name
private ResourceBundle	parent
private boolean	returnKeys

Constructor Summary

ResourceBundleWrapper(String name, ResourceBundle parent)
The wrapper is created by ResourceBundleFactory.

Method Summary

Locale	getLocale() Get the actual locale used by the bundle, which may be a different locale from the one that was used to load it.
String	getName() Get the base name of the resource bundle.
ResourceBundle	getResourceBundle() Get access to the underlying resource bundle.
String	getString(String key, boolean variant, String... replacements) Utility method for returning the value for the key given by key.0 (variant=false) or key.1 (variant=true) depending on the value of the variant parameter.
String	getString(String key, int index, String... replacements) Utility method for returning the value for the key given by: key.index.
String	getString(String key, String... replacements) Get a string value from the bundle.
void	setReturnKeys(boolean returnKeys) Set a flag indicating that the various getString() methods should always return the key instead of trying to find a value for it.
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

log

private static final Logger log

name

private final String name

parent

private final ResourceBundle parent

returnKeys

private boolean returnKeys

Constructor Detail

ResourceBundleWrapper

public ResourceBundleWrapper(String name,
                             ResourceBundle parent)

The wrapper is created by ResourceBundleFactory.

Parameters:

name - The base name of the bundle

parent - The underlying ResourceBundle

Method Detail

getName

public String getName()

Get the base name of the resource bundle.

getLocale

public Locale getLocale()

Get the actual locale used by the bundle, which may be a different locale from the one that was used to load it.

setReturnKeys

public void setReturnKeys(boolean returnKeys)

Set a flag indicating that the various getString() methods should always return the key instead of trying to find a value for it.

Parameters:

returnKeys - TRUE to always return the key, FALSE to try to find values

getResourceBundle

public ResourceBundle getResourceBundle()

Get access to the underlying resource bundle.

getString

public String getString(String key,
                        boolean variant,
                        String... replacements)

Utility method for returning the value for the key given by key.0 (variant=false) or key.1 (variant=true) depending on the value of the variant parameter.

See Also:

getString(String, String...)

getString

public String getString(String key,
                        int index,
                        String... replacements)

Utility method for returning the value for the key given by: key.index.

See Also:

getString(String, String...)

getString

public String getString(String key,
                        String... replacements)

Get a string value from the bundle. The value may contain placeholders of the form {index} which will be replaced by the corresponding value from the replacements array. Index values that are outside the range of the array are not replaced.

If no value is found for the key or if the setReturnKeys(boolean) has been enabled the key is returned.

Parameters:

key - The key for the value

replacements - An optional array with string replacments

Returns:

The value found for the key

toString

public String toString()

Overrides:

toString in class Object