com.dpslink.flash.cmd.util

Class MessageBundle

java.lang.Object

com.dpslink.flash.cmd.util.MessageBundle

All Implemented Interfaces:

java.io.Serializable

public class MessageBundle
extends java.lang.Object
implements java.io.Serializable

A utility class for retrieving and formatting messages obtained from a ResourceBundle.

See Also:

Serialized Form

Field Summary

Fields

Modifier and Type	Field and Description
private java.util.ResourceBundle	ivResourceBundle The resource bundle created by the constructor.
private static long	serialVersionUID The class' serialization version id.

Constructor Summary

Constructors

Constructor and Description
MessageBundle(java.util.ResourceBundle bundle) Creates an instance of MessageBundle for the specified resource bundle.
MessageBundle(java.lang.String bundleName) Creates an instance of MessageBundle for the specified resource bundle name.

Method Summary

Modifier and Type	Method and Description
java.lang.String	getMessage(java.lang.String msgid) Returns the message for a given message id.
java.lang.String	getMessage(java.lang.String msgid, java.lang.String... values) Returns the message text for a given message id with the given set of substitution value(s) inserted into the message text.
private java.lang.String	getString(java.lang.String key) Returns the resource string for a given resource key.

Methods inherited from class java.lang.Object

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

Field Detail

serialVersionUID

private static final long serialVersionUID

The class' serialization version id.

See Also:

Constant Field Values

ivResourceBundle

private java.util.ResourceBundle ivResourceBundle

The resource bundle created by the constructor.

Constructor Detail

MessageBundle

public MessageBundle(java.lang.String bundleName)

Creates an instance of MessageBundle for the specified resource bundle name.

Parameters:

bundleName - (String) The resource bundle file name, in dotted notation. Example:

 new MessageBundle("package.SomeMessageFile");
 

MessageBundle

public MessageBundle(java.util.ResourceBundle bundle)

Creates an instance of MessageBundle for the specified resource bundle.

Parameters:

bundle - (ResourceBundle) The resource bundle object.

Method Detail

getMessage

public java.lang.String getMessage(java.lang.String msgid)

Returns the message for a given message id. Returns an error message if the key cannot be found.

Parameters:

msgid - (String) The resource key for the message to retrieve.

Returns:

String - The message text.

getMessage

public java.lang.String getMessage(java.lang.String msgid,
                                   java.lang.String... values)

Returns the message text for a given message id with the given set of substitution value(s) inserted into the message text. Substitution positions within the message text are denoted by {n} where n is a zero-based ordinal for each value to be substituted (i.e. {0} {1} {2} {3}). Returns an error message text if the message id cannot be found.

Parameters:

msgid - (String) The resource key for the message to retrieve.

values - (String) The value(s) that are to be substituted into the message text. This parameter uses the varargs feature and can therefore be passed as multiple parms (msgid, value1, value2, value3, valueN) or as an array (msgid, values[]).

Returns:

String - The message text.

getString

private java.lang.String getString(java.lang.String key)

Returns the resource string for a given resource key. Returns an error message if the key cannot be found.

Parameters:

key - (String) The resource key to retrieve.

Returns:

String - The string associated with the passed key.