Class MessageTemplate2<PARAM_1,​PARAM_2>

  • All Implemented Interfaces:
    MessageTemplate

    public class MessageTemplate2<PARAM_1,​PARAM_2>
    extends AbstractMessageTemplate
    Represents a MessageTemplate accepting 2 parameters
    Example defining a MessageTemplate2's:
    
     // Has key: "ESSENTIALS"
     MessageTemplate0 ROOT = MessageTemplates.root("ESSENTIALS");
    
     // Has key: "ESSENTIALS.ACCOUNT_NOT_FOUND"
     MessageTemplate2<BigDecimal, BigDecimal> AMOUNT_TOO_HIGH = ROOT.key2("AMOUNT_TOO_HIGH",
                                                                          "Amount {0} is higher than {1}");
     
    Example creating a Message from a MessageTemplate2:
    
     MessageTemplate2<BigDecimal, BigDecimal> AMOUNT_TOO_HIGH = ROOT.key2("AMOUNT_TOO_HIGH",
                                                                          "Amount {0} is higher than {1}");
    
     BigDecimal requestedAmount = ...;
     BigDecimal maximumAmountAllowed = ...;
     Message msg = AMOUNT_TOO_HIGH.create(requestedAmount,
                                          maximumAmountAllowed);
     
    • Constructor Detail

      • MessageTemplate2

        public MessageTemplate2​(String messageKey,
                                String defaultMessage)
    • Method Detail

      • create

        public Message create​(PARAM_1 param1,
                              PARAM_2 param2)
        Create a Message, with the provided parameter, based on this MessageTemplate
        Example creating a Message from a MessageTemplate2:
        
         MessageTemplate2<BigDecimal, BigDecimal> AMOUNT_TOO_HIGH = ROOT.key2("AMOUNT_TOO_HIGH",
                                                                              "Amount {0} is higher than {1}");
        
         BigDecimal requestedAmount = ...;
         BigDecimal maximumAmountAllowed = ...;
         Message msg = AMOUNT_TOO_HIGH.create(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()
        Returns:
        the new Message with the parameter applied