org.mdiutil.lang

Class MessageBundle

java.lang.Object

org.mdiutil.lang.MessageBundle

public class MessageBundle
extends Object

A message provider bundle.

Method Summary

Modifier and Type	Method and Description
String	getDefaultMessage() Return the default message to use when the key does not exist.
String	getMessage(String key) Return a message without variables.
String	getMessage(String key, Object... vars) Return a message with variables.
String	getNamedMessage(String key, Object... vars) Return a message with named variables.
protected void	initialize(URL url) Initialize the bundle with a specified URL.
void	setDefaultMessage(String message) Set the default message to use when the key does not exist.

Methods inherited from class java.lang.Object

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

Method Detail

setDefaultMessage

public void setDefaultMessage(String message)

Set the default message to use when the key does not exist.

Parameters:

message - the default message

getDefaultMessage

public String getDefaultMessage()

Return the default message to use when the key does not exist. The default value is "Undefined message for key $1".

Returns:

the default message

initialize

protected void initialize(URL url)

Initialize the bundle with a specified URL.

Parameters:

url - the URL used for the bundle creation

getMessage

public String getMessage(String key)

Return a message without variables. This is valid for messages in the list without any variables declaration. A key which does not exist in the bundle will return the message "Undefined message for key" followed by the key. For example:

• The message for the key "grammar" is "Wrong File grammar"
• getMessage("grammar") returns "Wrong File grammar"

Parameters:

key - the message key

Returns:

the message

getMessage

public String getMessage(String key,
                         Object... vars)

Return a message with variables. This is valid for messages in the list with variables declaration. A key which does not exist in the bundle will return the message "Undefined message for key" followed by the key. For example:

• The message for the key "type.undef" is "No type of name $1"
• getMessage("type.undef", "myValue") returns "No type of name myValue"

Message elaboration

Any String can be used for the value of the property bundle for the key. Tags $<n> represent the n-th variable in the vararg variables array. For example:

• The message for the key "my.tag" is "No type of name $1 or name $2"
• getMessage("type.undef", "myValue", 3) returns "No type of name myValue or 3"

If there are more variables than n, the remaining variables will be omitted in the result. For example:

• The message for the key "my.tag" is "No type of name $1"
• getMessage("type.undef", "myValue", 3) returns "No type of name myValue"

If there are less variables than n, the remaining tags will be omitted in the result. For example:

• The message for the key "my.tag" is "No type of name $1 or $2"
• getMessage("type.undef", "myValue") returns "No type of name myValue or"

Parameters:

key - the message key

vars - the varargs variables array. The String representation of each variable will be used

Returns:

the message

getNamedMessage

public String getNamedMessage(String key,
                              Object... vars)

Return a message with named variables. This is valid for messages in the list with variables declaration. A key which does not exist in the bundle will return the message "Undefined message for key" followed by the key. For example:

• The message for the key "type.undef" is "No type of name ${name}"
• getMessage("type.undef", "name", "myValue") returns "No type of name myValue"

Message elaboration

Any String can be used for the value of the property bundle for the key. Tags ${<theName>} represent the variable with the namez "theName" in the vararg variables array. For example:

• The message for the key "my.tag" is "No type of name ${name1} or name ${name2}"
• getMessage("type.undef", "name1", "myValue", "name2", 3) returns "No type of name myValue or 3"

If there are unused variables in the varargs, the remaining variables will be omitted in the result. For example:

• The message for the key "my.tag" is "No type of name ${name}"
• getMessage("type.undef", "name" "myValue", "other", 3) returns "No type of name myValue"

Parameters:

key - the message key

vars - the varargs variables array. The String representation of each variable will be used

Returns:

the message