javax.jdo.spi
Class I18NHelper
public class I18NHelper
extends java.lang.Object
Helper class for constructing messages from bundles. The intended usage
of this class is to construct a new instance bound to a bundle, as in
I18NHelper msg = I18NHelper.getInstance("javax.jdo.Bundle");
This call uses the class loader that loaded the I18NHelper class to find
the specified Bundle. The class provides two overloaded getInstance
methods allowing to specify a different class loader:
getInstance(Class cls)
looks for a bundle
called "Bundle.properties" located in the package of the specified class
object and
getInstance(String bundleName,ClassLoader loader)
uses the specified class loader to find the bundle.
Subsequently, instance methods can be used to format message strings
using the text from the bundle, as in
throw new JDOFatalInternalException (msg.msg("ERR_NoMetadata",
cls.getName()));
static I18NHelper | getInstance(Class cls) - An instance bound to a bundle.
|
static I18NHelper | getInstance(String bundleName) - An instance bound to a bundle.
|
static I18NHelper | getInstance(String bundleName, ClassLoader loader) - An instance bound to a bundle.
|
ResourceBundle | getResourceBundle() - Returns the resource bundle used by this I18NHelper.
|
String | msg(String messageKey) - Message formatter
|
String | msg(String messageKey, Object arg1) - Message formatter
|
String | msg(String messageKey, Object arg1, Object arg2) - Message formatter
|
String | msg(String messageKey, Object arg1, Object arg2, Object arg3) - Message formatter
|
String | msg(String messageKey, Object[] args) - Message formatter
|
String | msg(String messageKey, boolean arg) - Message formatter
|
String | msg(String messageKey, int arg) - Message formatter
|
getInstance
public static I18NHelper getInstance(Class cls)
An instance bound to a bundle. This method figures out the bundle name
for the class object's package and uses the class' class loader to
find the bundle. Note, the specified class object must not be
null
.
cls
- the class object from which to load the resource bundle
- the helper instance bound to the bundle
getInstance
public static I18NHelper getInstance(String bundleName)
An instance bound to a bundle. This method uses the current class
loader to find the bundle.
bundleName
- the name of the bundle
- the helper instance bound to the bundle
getInstance
public static I18NHelper getInstance(String bundleName,
ClassLoader loader)
An instance bound to a bundle. This method uses the specified class
loader to find the bundle. Note, the specified class loader must not
be null
.
bundleName
- the name of the bundleloader
- the class loader from which to load the resource
bundle
- the helper instance bound to the bundle
getResourceBundle
public ResourceBundle getResourceBundle()
Returns the resource bundle used by this I18NHelper.
- the associated resource bundle
msg
public String msg(String messageKey)
Message formatter
messageKey
- the message key
- the resolved message text
msg
public String msg(String messageKey,
Object arg1)
Message formatter
messageKey
- the message keyarg1
- the first argument
- the resolved message text
msg
public String msg(String messageKey,
Object arg1,
Object arg2)
Message formatter
messageKey
- the message keyarg1
- the first argumentarg2
- the second argument
- the resolved message text
msg
public String msg(String messageKey,
Object arg1,
Object arg2,
Object arg3)
Message formatter
messageKey
- the message keyarg1
- the first argumentarg2
- the second argumentarg3
- the third argument
- the resolved message text
msg
public String msg(String messageKey,
Object[] args)
Message formatter
messageKey
- the message keyargs
- the array of arguments
- the resolved message text
msg
public String msg(String messageKey,
boolean arg)
Message formatter
messageKey
- the message keyarg
- the argument
- the resolved message text
msg
public String msg(String messageKey,
int arg)
Message formatter
messageKey
- the message keyarg
- the argument
- the resolved message text