public class MessageUtil
extends java.lang.Object
Modifier and Type | Field | Description |
---|---|---|
private java.lang.String |
resourceBundleName |
The name of the resource bundle we are using to load
messages
|
static java.util.Locale |
US |
Constructor | Description |
---|---|
MessageUtil(java.lang.String resourceBundleName) |
Create an instance of MessageUtil with a specific resource
bundle.
|
Modifier and Type | Method | Description |
---|---|---|
static java.lang.String |
composeDefaultMessage(java.lang.String message,
java.lang.Object[] arguments) |
Compose a default message so that the user at least gets
*something* useful rather than just a MissingResourceException,
which is particularly unhelpful
|
private static int |
countParams(java.lang.String message) |
Count the number of substituation parameters in the message
|
static java.lang.String |
formatMessage(java.util.ResourceBundle bundle,
java.lang.String messageId,
java.lang.Object[] arguments,
boolean composeDefault) |
Format a message given a resource bundle and a message id.
|
java.lang.String |
getCompleteMessage(java.lang.String messageID,
java.lang.Object[] args) |
Instance method to get the complete message, using the
provided resource bundle name as specified when this
instance was constructed
If for some reason the message could not be found, we return a
default message using the message arguments
|
static java.lang.String |
getCompleteMessage(java.lang.String messageId,
java.lang.String resourceBundleName,
java.lang.Object[] arguments) |
This is a wrapper for the getCompleteMessage workhorse routine
using some obvious defaults, particularly for non-engine subsystems
that only ever use the default locale.
|
static java.lang.String |
getCompleteMessage(java.util.Locale locale,
java.lang.String resourceBundleName,
java.lang.String messageId,
java.lang.Object[] arguments,
boolean composeDefault) |
Generic routine to get a message with any number of arguments.
|
java.lang.String |
getTextMessage(java.lang.String messageID,
java.lang.Object... args) |
Get a message with default locale.
|
public static final java.util.Locale US
private java.lang.String resourceBundleName
public MessageUtil(java.lang.String resourceBundleName)
resourceBundleName
- The base name of the resource bundle to use.public java.lang.String getTextMessage(java.lang.String messageID, java.lang.Object... args)
public java.lang.String getCompleteMessage(java.lang.String messageID, java.lang.Object[] args)
public static java.lang.String getCompleteMessage(java.util.Locale locale, java.lang.String resourceBundleName, java.lang.String messageId, java.lang.Object[] arguments, boolean composeDefault) throws java.util.MissingResourceException
locale
- The locale to use when looking for the message. If the message
is not found using this locale, we attempt to find it using the
US locale (our default).resourceBundleName
- The base name for the resource bundle to use.messageId
- The message identifier for this messagearguments
- The arguments for the messagecomposeDefault
- If this is true, this method will compose a default message if
the message could not be found in the
provided resource bundles. If it is false, this method will
throw a MissingResourceException if the message could not be
found.java.util.MissingResourceException
- If the message could not be found and the
composeDefault
parameter was set to false.public static java.lang.String getCompleteMessage(java.lang.String messageId, java.lang.String resourceBundleName, java.lang.Object[] arguments) throws java.util.MissingResourceException
messageId
- The id to use to look up the messageresourceBundleName
- The base name of the resource bundle to use.arguments
- The arguments to the messagejava.util.MissingResourceException
public static java.lang.String formatMessage(java.util.ResourceBundle bundle, java.lang.String messageId, java.lang.Object[] arguments, boolean composeDefault)
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.
bundle
- The resource bundle to use to look for the messagemessageId
- The message id to use for the messagearguments
- The arguments for the messagecomposeDefault
- Indicates whether a default message should be composed if
the message can't be found in the resource bundle.
If composeDefault is false, this method will throw a MissingResourceException if the message could not be found.
If composeDefault is true, then if the message id is not found in the given bundle, this method composes and returns as helpful a message as possible in the format "UNKNOWN : [arg1], [arg2], ..."
private static int countParams(java.lang.String message)
public static java.lang.String composeDefaultMessage(java.lang.String message, java.lang.Object[] arguments)
message
- The message to start with, which often is nullarguments
- The arguments to the message.Apache Derby V10.14 Internals - Copyright © 2004,2018 The Apache Software Foundation. All Rights Reserved.