public class OrderUserMessage
extends java.lang.Object
This class encapsulates messages, configurable string constants and message formatting conventions. This class is used for client messages. These are messages displayed to a user when something is not correct. i.e. The user incorrectly types in the wrong information on a form.
This class obtains resource bundles based on a java.util.Locale
object.
Usage:
OrderUserMessage.getString("MSG1", Locale)
Object[] params = {"one", "two"};
OrderUserMessage.format("MSG2", params, Locale)
Modifier and Type | Field and Description |
---|---|
static java.lang.String |
CLASS_VERSION
Class version string
|
static java.lang.String |
RESOURCE_BUNDLE |
Constructor and Description |
---|
OrderUserMessage() |
Modifier and Type | Method and Description |
---|---|
static java.lang.String |
format(java.lang.String pKey,
java.util.Locale pLocale)
Return a String message specific for the given locale.
|
static java.lang.String |
format(java.lang.String pKey,
java.lang.Object[] pParams,
java.util.Locale pLocale)
Format a set of parameters into a message for a given locale
|
static java.lang.String |
format(java.lang.String pKey,
java.lang.Object pParam,
java.util.Locale pLocale)
Format a single parameter into a message for a given locale
|
static java.text.MessageFormat |
getFormat(java.lang.String pKey,
java.util.Locale pLocale)
Return a MessageFormat from the resource bundle, for the given locale
|
static java.util.ResourceBundle |
getResourceBundle(java.util.Locale pLocale)
Returns a ResourceBundle specific for the given locale
|
static java.lang.String |
getString(java.lang.String pKey,
java.util.Locale pLocale)
Return a String message specific for the given locale
|
public static java.lang.String CLASS_VERSION
public static java.lang.String RESOURCE_BUNDLE
public static java.util.ResourceBundle getResourceBundle(java.util.Locale pLocale) throws java.util.MissingResourceException
pLocale
- the locale of the userjava.util.MissingResourceException
public static java.lang.String getString(java.lang.String pKey, java.util.Locale pLocale)
pKey
- the identifier for the message to retrieve out of the ResourceBundlepLocale
- the locale of the userpublic static java.text.MessageFormat getFormat(java.lang.String pKey, java.util.Locale pLocale)
pLocale
- the locale of the userpKey
- the identifier for the message to retrieve out of the ResourceBundlepublic static java.lang.String format(java.lang.String pKey, java.util.Locale pLocale)
getString
pKey
- the identifier for the message to retrieve out of the ResourceBundlepLocale
- the locale of the userpublic static java.lang.String format(java.lang.String pKey, java.lang.Object pParam, java.util.Locale pLocale)
pKey
- the identifier for the message to retrieve out of the ResourceBundlepParam
- a single parameter to use in formattingpLocale
- the locale of the userpublic static java.lang.String format(java.lang.String pKey, java.lang.Object[] pParams, java.util.Locale pLocale)
pKey
- the identifier for the message to retrieve out of the ResourceBundlepParams
- a set of parameters to use in the formattingpLocale
- the locale of the user