com.kheops.jmap.messages

Class MessageFormat

java.lang.Object

com.kheops.jmap.messages.MessageFormat

public class MessageFormat
extends java.lang.Object

This class provides methods to simplify the localized formatted message creation.

Constructor Summary

Constructors

Constructor and Description
MessageFormat()

Method Summary

Modifier and Type	Method and Description
static java.lang.String	format(java.lang.String messageCode, java.lang.String[] messageArgs) Creates a formatted and localized message using the specified message code and arguments.
static java.lang.String	logFormat(java.lang.String messageCode, java.lang.String[] messageArgs) Similar to the method format(String, String[]) except that the message returned will include the message code at the beginning.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageFormat

public MessageFormat()

Method Detail

format

public static java.lang.String format(java.lang.String messageCode,
                                      java.lang.String[] messageArgs)

Creates a formatted and localized message using the specified message code and arguments. The message code must be present in the resources. If not, the message code is returned.

Parameters:

messageCode - used as the key to obtain the message from the resources.

messageArgs - array of arguments to be inserted in the message.

Returns:

the resulting message or the message code if the code is not found in the resources.

logFormat

public static java.lang.String logFormat(java.lang.String messageCode,
                                         java.lang.String[] messageArgs)

Similar to the method format(String, String[]) except that the message returned will include the message code at the beginning. Useful for message logging.

Parameters:

messageCode - used as the key to obtain the message from the resources.

messageArgs - array of arguments to be inserted in the message.

Returns:

the resulting message or the message code if the code is not found in the resources.