Module dk.cloudcreate.essentials.shared

Package dk.cloudcreate.essentials.shared.messages

Class AbstractMessageTemplate

java.lang.Object

dk.cloudcreate.essentials.shared.messages.AbstractMessageTemplate

All Implemented Interfaces:

MessageTemplate

Direct Known Subclasses:

MessageTemplate0, MessageTemplate1, MessageTemplate2, MessageTemplate3, MessageTemplate4

public abstract class AbstractMessageTemplate
extends Object
implements MessageTemplate

Field Summary

Fields

Modifier and Type	Field	Description
protected String	defaultMessage
protected String	key

Constructor Summary

Constructors

Constructor	Description
AbstractMessageTemplate(String key)
AbstractMessageTemplate(String key, String defaultMessage)

Method Summary

Modifier and Type	Method	Description
boolean	equals(Object o)
String	getDefaultMessage()	The default Message for the given message key E.g.
String	getKey()	The message key for this MessageTemplate.
int	hashCode()
String	toString()

Methods inherited from class java.lang.Object

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

Field Detail

key

protected final String key

defaultMessage

protected final String defaultMessage

Constructor Detail

AbstractMessageTemplate

public AbstractMessageTemplate(String key,
                               String defaultMessage)

AbstractMessageTemplate

public AbstractMessageTemplate(String key)

Method Detail

getKey

public String getKey()

Description copied from interface: MessageTemplate

The message key for this MessageTemplate. Message key's can be used for multiple purposes:

• A Message key is the identifier for a message or error (e.g. INVENTORY_ITEM.OUT_OF_STOCK)
• A Message key can be used to lookup translations (e.g. in a Resource bundle)

Specified by:

getKey in interface MessageTemplate

Returns:

the message key for this MessageTemplate

getDefaultMessage

public String getDefaultMessage()

Description copied from interface: MessageTemplate

The default Message for the given message key
E.g. say the MessageTemplate.getKey() is SALES.INVENTORY_ITEM.OUT_OF_STOCK and the concrete MessageTemplate is a MessageTemplate1 then a default english message for this key could be: Inventory item {0} is out of Stock, which would be defined as:

 MessageTemplate1<ProductName> INVENTORY_OUT_OF_STOCK = MessageTemplates.key1("INVENTORY_ITEM.OUT_OF_STOCK", "Inventory item {0} is out of Stock");
 

Specified by:

getDefaultMessage in interface MessageTemplate

Returns:

the default message for the given message key

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

toString

public String toString()

Overrides:

toString in class Object