JDO Class

I18NHelper

java.lang.Object
  ∟ javax.jdo.spi.I18NHelper
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: (Class cls) looks for a bundle called "Bundle.properties" located in the package of the specified class object and (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()));

Since:
JDO 1.0

Public Methods

ResourceBundle getResourceBundle()
Returns the resource bundle used by this I18NHelper.
Return:
the associated resource bundle
Since:
JDO 1.1
String msg(String messageKey)
Message formatter
Parameters:
messageKey - the message key
Return:
the resolved message text
Since:
JDO 1.0
String msg(String messageKey, Object arg1)
Message formatter
Parameters:
messageKey - the message key
arg1 - the first argument
Return:
the resolved message text
Since:
JDO 1.0
String msg(String messageKey, Object arg1, Object arg2)
Message formatter
Parameters:
messageKey - the message key
arg1 - the first argument
arg2 - the second argument
Return:
the resolved message text
Since:
JDO 1.0
String msg(String messageKey, Object arg1, Object arg2, Object arg3)
Message formatter
Parameters:
messageKey - the message key
arg1 - the first argument
arg2 - the second argument
arg3 - the third argument
Return:
the resolved message text
Since:
JDO 1.0
String msg(String messageKey, Object[] args)
Message formatter
Parameters:
messageKey - the message key
args - the array of arguments
Return:
the resolved message text
Since:
JDO 1.0
String msg(String messageKey, boolean arg)
Message formatter
Parameters:
messageKey - the message key
arg - the argument
Return:
the resolved message text
Since:
JDO 1.0
String msg(String messageKey, int arg)
Message formatter
Parameters:
messageKey - the message key
arg - the argument
Return:
the resolved message text
Since:
JDO 1.0

Public Static Methods

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.
Parameters:
cls - the class object from which to load the resource bundle
Return:
the helper instance bound to the bundle
Since:
JDO 1.0
I18NHelper getInstance(String bundleName)
An instance bound to a bundle.
This method uses the current class loader to find the bundle.
Parameters:
bundleName - the name of the bundle
Return:
the helper instance bound to the bundle
Since:
JDO 1.0
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.
Parameters:
bundleName - the name of the bundle
loader - the class loader from which to load the resource bundle
Return:
the helper instance bound to the bundle
Since:
JDO 1.0

Method inherited from class java.lang.Object

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