Module dk.cloudcreate.essentials.shared

Package dk.cloudcreate.essentials.shared.messages

Class Message

java.lang.Object

dk.cloudcreate.essentials.shared.messages.Message

All Implemented Interfaces:

Serializable

public class Message
extends Object
implements Serializable

A Message is an instance of a MessageTemplate with parameters bound to it
A Message instance is e.g. useful for error/validation reporting.

Example creating a Message from a MessageTemplate4:

 MessageTemplate4<String, BigDecimal, BigDecimal, LocalDate> ACCOUNT_OVERDRAWN = ROOT.key4("ACCOUNT_OVERDRAWN",
                                                                                           "Account {0} is overdrawn by ${1}. A fee of ${2} will be debited on the {3}");

 String accountId = "Account1";
 BigDecimal overdrawnAmount = new BigDecimal("125");
 BigDecimal feeAmount = new BigDecimal("10");
 LocalDate  feeDebitDate =  LocalDate.of(2023, 2, 25);
 Message msg = ACCOUNT_OVERDRAWN.create(accountId,
                                        overdrawnAmount,
                                        feeAmount,
                                        feeDebitDate);

 

will create a Message with getMessage(): "Account Account1 is overdrawn by $125. A fee of $10 will be debited on the 2023-2-25" (date formatting is dependent on the Locale)

See Also:

MessageTemplate, MessageTemplates, Serialized Form

Constructor Summary

Constructors

Constructor	Description
Message(MessageTemplate template, Object... parameters)	Create a concrete instance of a MessageTemplate

Method Summary

Modifier and Type	Method	Description
String	getKey()	The MessageTemplate.getKey()
String	getMessage()	The MessageTemplate.getDefaultMessage() with the getParameters() applied using MessageFormat.format(String, Object...) Example creating a Message from a MessageTemplate4:
List<Object>	getParameters()	The concrete parameters for the message
MessageTemplate	getTemplate()	The message template that this message is based on

Methods inherited from class java.lang.Object

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

Constructor Detail

Message

public Message(MessageTemplate template,
               Object... parameters)

Create a concrete instance of a MessageTemplate

Parameters:

template - the message template

parameters - the parameters for the message template

Method Detail

getKey

public String getKey()

The MessageTemplate.getKey()

Returns:

The MessageTemplate.getKey()

getTemplate

public MessageTemplate getTemplate()

The message template that this message is based on

Returns:

the message template that this message is based on

getParameters

public List<Object> getParameters()

The concrete parameters for the message

Returns:

the concrete parameters for the message

getMessage

public String getMessage()

The MessageTemplate.getDefaultMessage() with the getParameters() applied using MessageFormat.format(String, Object...)
Example creating a Message from a MessageTemplate4:

 MessageTemplate4<String, BigDecimal, BigDecimal, LocalDate> ACCOUNT_OVERDRAWN = ROOT.key4("ACCOUNT_OVERDRAWN",
                                                                                           "Account {0} is overdrawn by ${1}. A fee of ${2} will be debited on the {3}");

 String accountId = "Account1";
 BigDecimal overdrawnAmount = new BigDecimal("125");
 BigDecimal feeAmount = new BigDecimal("10");
 LocalDate  feeDebitDate =  LocalDate.of(2023, 2, 25);
 Message msg = ACCOUNT_OVERDRAWN.create(accountId,
                                        overdrawnAmount,
                                        feeAmount,
                                        feeDebitDate);

 

will create a Message with getMessage(): "Account Account1 is overdrawn by $125. A fee of $10 will be debited on the 2023-2-25" (date formatting is dependent on the Locale)

Returns:

The MessageTemplate.getDefaultMessage() with the getParameters() applied using MessageFormat.format(String, Object...)