com.vmware.vapi.bindings

Class LocalizableMessageFactory

java.lang.Object

com.vmware.vapi.bindings.LocalizableMessageFactory

public class LocalizableMessageFactory
extends java.lang.Object

Factory for LocalizableMessage instances.

Message data (keys, templates) are loaded from ResourceBundle.

Constructor Summary

Constructors

Constructor and Description
LocalizableMessageFactory(java.util.ResourceBundle msgBundle, TemplateFormatter formatter) Constructor.

Method Summary

Modifier and Type	Method and Description
LocalizableMessage	getLocalizableMessage(java.lang.String msgId, java.lang.Object... args) Creates a LocalizableMessage for the specified ID and typed arguments.
LocalizableMessage	getLocalizableMessage(java.lang.String msgId, java.lang.String... args) Creates a LocalizableMessage for the specified ID and arguments.

Methods inherited from class java.lang.Object

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

Constructor Detail

LocalizableMessageFactory

public LocalizableMessageFactory(java.util.ResourceBundle msgBundle,
                                 TemplateFormatter formatter)

Constructor.

Parameters:

msgBundle - resource bundle for messages; can not be null

formatter - message template formatter to be used for default message generation for the created LocalizableMessages; may be null

Method Detail

getLocalizableMessage

public LocalizableMessage getLocalizableMessage(java.lang.String msgId,
                                                java.lang.String... args)

Creates a LocalizableMessage for the specified ID and arguments.

In case message template can not be found for the specified msgId a default 'unknown' message is returned.

If TemplateFormatter is set for this factory LocalizableMessage.getDefaultMessage() will be set to localized string for the locale of the ResourceBundle for this factory. Otherwise default message will be the raw message template.

Parameters:

msgId - identifier for the message

args - arguments to substitute in the message template

Returns:

fully constructed LocalizableMessage isntance

getLocalizableMessage

public LocalizableMessage getLocalizableMessage(java.lang.String msgId,
                                                java.lang.Object... args)

Creates a LocalizableMessage for the specified ID and typed arguments.

Supported types are

• java.lang.Long
• java.lang.Double
• java.lang.String
• java.util.Calendar

Throws:

LocalizationException - if argument of unsupported type is presented

See Also:

getLocalizableMessage(String, String...)