com.communote.server.persistence.common.messages

Class MessageKeyLocalizedMessage

java.lang.Object

com.communote.server.persistence.common.messages.MessageKeyLocalizedMessage

All Implemented Interfaces:

LocalizedMessage, LocalizationChangeObservable

public class MessageKeyLocalizedMessage
extends Object
implements LocalizedMessage, LocalizationChangeObservable

Message that uses the ResourceBundleManager for localization.

Author:

Communote GmbH - http://www.communote.com/

Constructor Summary

Constructors

Constructor and Description
MessageKeyLocalizedMessage(String messageKey, Object... arguments) Constructor.

Method Summary

Modifier and Type	Method and Description
Object[]	getArguments()
Class<ResourceBundleChangedEvent>	getChangeNotificationEvent() Return the event type that will be fired when the localizations which are used by this component have changed. This event type can be used to register an event listener to be notified about the changes of the localizations which is for instance useful when doing some local caching of localized content.
String	getMessageKey()
boolean	isCombineArguments()
void	setArguments(Object[] arguments)
void	setCombineArguments(boolean combineArguments) Whether to combine the the arguments passed to toString with those set via setArguments.
void	setMessageKey(String messageKey)
String	toString()
String	toString(Locale locale, Object... arguments) Returns the localized message.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageKeyLocalizedMessage

public MessageKeyLocalizedMessage(String messageKey,
                                  Object... arguments)

Constructor.

Parameters:

messageKey - The message key to use.

arguments - Optional arguments for the message.

Method Detail

getArguments

public Object[] getArguments()

Returns:

the arguments

getChangeNotificationEvent

public Class<ResourceBundleChangedEvent> getChangeNotificationEvent()

Description copied from interface: LocalizationChangeObservable

Return the event type that will be fired when the localizations which are used by this component have changed.
This event type can be used to register an event listener to be notified about the changes of the localizations which is for instance useful when doing some local caching of localized content.

Specified by:

getChangeNotificationEvent in interface LocalizationChangeObservable

Returns:

the event class

getMessageKey

public String getMessageKey()

Returns:

the messageKey

isCombineArguments

public boolean isCombineArguments()

setArguments

public void setArguments(Object[] arguments)

Parameters:

arguments - the arguments to set

setCombineArguments

public void setCombineArguments(boolean combineArguments)

Whether to combine the the arguments passed to toString with those set via setArguments.

Parameters:

combineArguments - true to append the arguments, which were passed to toString, to the arguments set with setArguments.

setMessageKey

public void setMessageKey(String messageKey)

Parameters:

messageKey - the messageKey to set

toString

public String toString()

Overrides:

toString in class Object

Returns:

messageKey + " " + arguments

toString

public String toString(Locale locale,
                       Object... arguments)

Description copied from interface: LocalizedMessage

Returns the localized message.

Specified by:

toString in interface LocalizedMessage

Parameters:

locale - The locale to be used.

arguments - Set this to overwrite possible default arguments.

Returns:

The localized message from the message key.