Package io.jmix.messagetemplates

Interface MessageTemplatesGenerator

All Known Implementing Classes:

MessageTemplatesGeneratorImpl

@NullMarked
public interface MessageTemplatesGenerator

Interface defining methods for generating messages using templates.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	MessageTemplatesGenerator.MultiParamTemplateGenerator	The generator is used to create messages based on a single template and multiple set of parameters.
static interface	MessageTemplatesGenerator.MultiTemplateGenerator	The generator is used to create messages based on a multiple set of templates and a single map of parameters.
static interface	MessageTemplatesGenerator.SingleTemplateGenerator	The generator is used to create messages based on a single template and a single map of parameters.

Method Summary

Modifier and Type	Method	Description
String	generateMessage(MessageTemplate template, Map<String,Object> parameters)	Generates a message based on the passed MessageTemplate and parameters map.
String	generateMessage(String templateCode, Map<String,Object> parameters)	Generates a message based on the passed code of MessageTemplate and parameters map.
MessageTemplatesGenerator.MultiParamTemplateGenerator	generateMultiParamTemplate()	Creates MessageTemplatesGenerator.MultiParamTemplateGenerator.
MessageTemplatesGenerator.MultiTemplateGenerator	generateMultiTemplate()	Creates MessageTemplatesGenerator.MultiTemplateGenerator.
MessageTemplatesGenerator.SingleTemplateGenerator	generateSingleTemplate()	Creates MessageTemplatesGenerator.SingleTemplateGenerator.

Method Details

generateSingleTemplate

MessageTemplatesGenerator.SingleTemplateGenerator generateSingleTemplate()

Creates MessageTemplatesGenerator.SingleTemplateGenerator.

The generator is used to create messages based on a single template and a single map of parameters. The result of the generation is a template filled with passed parameters.

Example of single template generation:

         generateSingleTemplate()
                 .withTemplateCode("my-template")
                 .addParam("username", "admin")
                 .addParam("firstName", "John")
                 .addParam("lastName", "Doe")
                 .generate();

 

Returns:

MessageTemplatesGenerator.SingleTemplateGenerator

generateMultiTemplate

MessageTemplatesGenerator.MultiTemplateGenerator generateMultiTemplate()

Creates MessageTemplatesGenerator.MultiTemplateGenerator.

The generator is used to create messages based on a multiple set of templates and a single map of parameters. The result of the generation is a list of templates filled with passed parameters.

Example of multi template generation:

         generateMultiTemplate()
                 .withTemplateCodes("my-first-template", "my-second-template")
                 .addParam("username", "admin")
                 .addParam("firstName", "John")
                 .addParam("lastName", "Doe")
                 .generate();
 

Returns:

MessageTemplatesGenerator.MultiTemplateGenerator

generateMultiParamTemplate

MessageTemplatesGenerator.MultiParamTemplateGenerator generateMultiParamTemplate()

Creates MessageTemplatesGenerator.MultiParamTemplateGenerator.

The generator is used to create messages based on a single template and multiple set of parameters. The result of the generation is a list of templates filled with different parameters.

Example of multi param template generation:

        generateMultiParamTemplate()
                 .withTemplateCode("my-template")
                 .addParams(Map.of(
                         "username", "admin",
                         "firstName", "John",
                         "lastName", "Doe"
                 ))
                 .addParams(Map.of(
                         "username", "user",
                         "firstName", "Mary",
                         "lastName", "Smith"
                 ))
                 .generate();
 

Returns:

MessageTemplatesGenerator.MultiTemplateGenerator

generateMessage

String generateMessage(MessageTemplate template,
 Map<String,Object> parameters)

Generates a message based on the passed MessageTemplate and parameters map.

Parameters:

template - template for generation

parameters - parameters for generation

Returns:

template filled with parameters

generateMessage

String generateMessage(String templateCode,
 Map<String,Object> parameters)

Generates a message based on the passed code of MessageTemplate and parameters map.

Parameters:

templateCode - code of template for generation

parameters - parameters for generation

Returns:

template filled with parameters