com.vmware.vapi

Class Message

java.lang.Object

com.vmware.vapi.Message

public class Message
extends Object

This class represents a localizable message.

See Also:

MessageFactory

Constructor Summary

Constructors

Constructor and Description
Message(String id, String defMsg, String... args) Construct a Message with a unique identifier, a ready-to-use default message, in default/server locale (say English) and the args.

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object obj)
String[]	getArgs()
String	getDefaultMessage()
String	getId()
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Message

public Message(String id,
               String defMsg,
               String... args)

Construct a Message with a unique identifier, a ready-to-use default message, in default/server locale (say English) and the args.

The message id is usually used to lookup a message template string in some message catalog. However this instance doesn't look it up, neither it guarantees that the id is available in a catalog. More generally this class doesn't attempt to load message catalogs at all.

Parameters:

id - the identifier for the message; must not be null

defMsg - default message with already placed in args in the default/server locale; must not be null

args - values for the message template placeholders

Method Detail

getId

public String getId()

Returns:

the message identifier; never null

getDefaultMessage

public String getDefaultMessage()

Returns:

the message detault representation; never null

getArgs

public String[] getArgs()

Returns:

the message argument values (for replacement into the message template's placeholders); maybe be empty array, but never null

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object