Module dk.cloudcreate.essentials.shared

Package dk.cloudcreate.essentials.shared.messages

Class MessageTemplate3<PARAM_1,PARAM_2,PARAM_3>

java.lang.Object

dk.cloudcreate.essentials.shared.messages.MessageTemplate0

dk.cloudcreate.essentials.shared.messages.MessageTemplate3<PARAM_1,PARAM_2,PARAM_3>

All Implemented Interfaces:

MessageTemplate

public class MessageTemplate3<PARAM_1,PARAM_2,PARAM_3>
extends MessageTemplate0

Represents a MessageTemplate accepting 3 parameters
Example defining a MessageTemplate3's:

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

 // Has key: "ESSENTIALS.ACCOUNT_OVERDRAWN"
 MessageTemplate3<String, BigDecimal, BigDecimal> ACCOUNT_OVERDRAWN = MessageTemplates.key3("ACCOUNT_OVERDRAWN",
                                                                                           "Account {0} is overdrawn by {1}. Fee {2}");
 

Example creating a Message from a MessageTemplate3:

 MessageTemplate2<String, BigDecimal, BigDecimal> ACCOUNT_OVERDRAWN = MessageTemplates.key3("ACCOUNT_OVERDRAWN",
                                                                                            "Account {0} is overdrawn by {1}. Fee {2}");

 String accountId = ...;
 BigDecimal requestedAmount = ...;
 BigDecimal maximumAmountAllowed = ...;
 Message msg = ACCOUNT_OVERDRAWN.create(accountId,
                                        requestedAmount,
                                        maximumAmountAllowed);
 

Constructor Summary

Constructors

Constructor	Description
MessageTemplate3(String messageKey, String defaultMessage)

Method Summary

Modifier and Type	Method	Description
Message	create(PARAM_1 param1, PARAM_2 param2, PARAM_3 param3)	Create a Message, with the provided parameter, based on this MessageTemplate Example creating a Message from a MessageTemplate3:

Methods inherited from class dk.cloudcreate.essentials.shared.messages.MessageTemplate0

create, getDefaultMessage, getKey

Methods inherited from class java.lang.Object

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

Constructor Detail

MessageTemplate3

public MessageTemplate3(String messageKey,
                        String defaultMessage)

Method Detail

create

public Message create(PARAM_1 param1,
                      PARAM_2 param2,
                      PARAM_3 param3)

Create a Message, with the provided parameter, based on this MessageTemplate
Example creating a Message from a MessageTemplate3:

 MessageTemplate2<String, BigDecimal, BigDecimal> ACCOUNT_OVERDRAWN = MessageTemplates.key3("ACCOUNT_OVERDRAWN",
                                                                                            "Account {0} is overdrawn by {1}. Fee {2}");

 String accountId = ...;
 BigDecimal requestedAmount = ...;
 BigDecimal maximumAmountAllowed = ...;
 Message msg = ACCOUNT_OVERDRAWN.create(accountId,
                                        requestedAmount,
                                        maximumAmountAllowed);
 

Parameters:

param1 - the parameter with index 0 in the generated Message.getMessage()

param2 - the parameter with index 1 in the generated Message.getMessage()

param3 - the parameter with index 2 in the generated Message.getMessage()

Returns:

the new Message with the parameter applied