org.apache.derby.iapi.services.i18n

Class MessageService

java.lang.Object

org.apache.derby.iapi.services.i18n.MessageService

public final class MessageService
extends java.lang.Object

Message Service implementation provides a mechanism for locating messages and substituting arguments for message parameters. It also provides a service for locating property values.

It uses the resource bundle mechanism for locating messages based on keys; the preferred form of resource bundle is a property file mapping keys to messages.

Method Summary

Modifier and Type	Method and Description
static java.lang.String	formatMessage(java.util.ResourceBundle bundle, java.lang.String messageId, java.lang.Object[] arguments, boolean lastChance)
static java.util.ResourceBundle	getBundleForLocale(java.util.Locale locale, java.lang.String msgId)
static java.util.ResourceBundle	getBundleWithEnDefault(java.lang.String resource, java.util.Locale locale) Method to use instead of ResourceBundle.getBundle().
static void	getLocalizedMessage(int sqlcode, short errmcLen, java.lang.String sqlerrmc, java.lang.String sqlerrp, int errd0, int errd1, int errd2, int errd3, int errd4, int errd5, java.lang.String warn, java.lang.String sqlState, java.lang.String file, java.lang.String localeStr, java.lang.String[] msg, int[] rc) Method used by Derby Network Server to get localized message
static java.lang.String	getLocalizedMessage(java.util.Locale locale, java.lang.String messageId, java.lang.Object[] args) Method used by Derby Network Server to get localized message
static java.lang.String	getProperty(java.lang.String messageId, java.lang.String propertyName)
static java.lang.String	getTextMessage(java.lang.String messageId, java.lang.Object... arguments) Transform the message from messageID to the actual error, warning, or info message using the correct locale.
static int	hashString50(java.lang.String key) Hash function to split messages into 50 files based upon the message identifier or SQLState.
static void	setFinder(BundleFinder theFinder)

Methods inherited from class java.lang.Object

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

Method Detail

getBundleForLocale

public static java.util.ResourceBundle getBundleForLocale(java.util.Locale locale,
                                                          java.lang.String msgId)

setFinder

public static void setFinder(BundleFinder theFinder)

getTextMessage

public static java.lang.String getTextMessage(java.lang.String messageId,
                                              java.lang.Object... arguments)

Transform the message from messageID to the actual error, warning, or info message using the correct locale.

The arguments to the messages are passed via an object array, the objects in the array WILL be changed by this class. The caller should NOT get the object back from this array.

getLocalizedMessage

public static void getLocalizedMessage(int sqlcode,
                                       short errmcLen,
                                       java.lang.String sqlerrmc,
                                       java.lang.String sqlerrp,
                                       int errd0,
                                       int errd1,
                                       int errd2,
                                       int errd3,
                                       int errd4,
                                       int errd5,
                                       java.lang.String warn,
                                       java.lang.String sqlState,
                                       java.lang.String file,
                                       java.lang.String localeStr,
                                       java.lang.String[] msg,
                                       int[] rc)

Method used by Derby Network Server to get localized message

Parameters:

sqlcode - sqlcode, not used.

errmcLen - sqlerrmc length

sqlerrmc - sql error message tokens, variable part of error message (ie., arguments) plus messageId, separated by separator.

sqlerrp - not used

errd0 - not used

warn - not used

sqlState - 5-char sql state

file - not used

localeStr - client locale in string

msg - OUTPUT parameter, localized error message

rc - OUTPUT parameter, return code -- 0 for success

getLocalizedMessage

public static java.lang.String getLocalizedMessage(java.util.Locale locale,
                                                   java.lang.String messageId,
                                                   java.lang.Object[] args)

Method used by Derby Network Server to get localized message

Parameters:

locale - locale

messageId - message id

args - message arguments

getProperty

public static java.lang.String getProperty(java.lang.String messageId,
                                           java.lang.String propertyName)

formatMessage

public static java.lang.String formatMessage(java.util.ResourceBundle bundle,
                                             java.lang.String messageId,
                                             java.lang.Object[] arguments,
                                             boolean lastChance)

getBundleWithEnDefault

public static java.util.ResourceBundle getBundleWithEnDefault(java.lang.String resource,
                                                              java.util.Locale locale)

Method to use instead of ResourceBundle.getBundle(). This method acts like ResourceBundle.getBundle() but if the resource is not available in the requested locale, default locale or base class the one for en_US is returned.

hashString50

public static int hashString50(java.lang.String key)

Hash function to split messages into 50 files based upon the message identifier or SQLState. We don't use String.hashCode() as it varies between releases and doesn't provide an even distribution across the 50 files.