Module dk.cloudcreate.essentials.shared

Package dk.cloudcreate.essentials.shared.messages

Class MessageTemplate0

java.lang.Object

dk.cloudcreate.essentials.shared.messages.MessageTemplate0

All Implemented Interfaces:

MessageTemplate

Direct Known Subclasses:

MessageTemplate1, MessageTemplate2, MessageTemplate3, MessageTemplate4

public class MessageTemplate0
extends Object
implements MessageTemplate

Represents a MessageTemplate accepting 0 parameters.
Example defining a MessageTemplate0's:

 // Has key: "ESSENTIALS"
 MessageTemplate0 ROOT = MessageTemplates.root("ESSENTIALS");

 // Has key: "ESSENTIALS.VALIDATION"
 MessageTemplate0 VALIDATION = ROOT.subKey("VALIDATION");
 

Example creating a Message from a MessageTemplate0:

 MessageTemplate0 VALIDATION = ROOT.subKey("VALIDATION");
 Message msg = VALIDATION.create();
 

Constructor Summary

Constructors

Constructor	Description
MessageTemplate0(String messageKey)
MessageTemplate0(String messageKey, String defaultMessage)

Method Summary

Modifier and Type	Method	Description
Message	create()	Create a Message based on this MessageTemplate Example creating a Message from a MessageTemplate0:
String	getDefaultMessage()	The default Message for the given message key E.g.
String	getKey()	The message key for this MessageTemplate.

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageTemplate0

public MessageTemplate0(String messageKey,
                        String defaultMessage)

MessageTemplate0

public MessageTemplate0(String messageKey)

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

create

public Message create()

Create a Message based on this MessageTemplate
Example creating a Message from a MessageTemplate0:

 MessageTemplate0 VALIDATION = ROOT.subKey("VALIDATION");
 Message msg = VALIDATION.create();
 

Returns:

the new Message