Package io.jmix.messagetemplates

Interface MessageTemplatesGenerator.MultiParamTemplateGenerator

All Known Implementing Classes:

MessageTemplatesGeneratorImpl.MultiParamTemplateGeneratorImpl

Enclosing interface:

MessageTemplatesGenerator

public static interface 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.

Method Summary

Modifier and Type	Method	Description
MessageTemplatesGenerator.MultiParamTemplateGenerator	addParams(Map<String,Object> params)	Adds a parameter map to the collection of parameters for generating the messages.
List<String>	generate()	Generates a messages based on the current state of the generator.
MessageTemplatesGenerator.MultiParamTemplateGenerator	withConfiguration(freemarker.template.Configuration configuration)	Sets the Configuration for message generation.
MessageTemplatesGenerator.MultiParamTemplateGenerator	withTemplate(MessageTemplate template)	Sets the template for generating the messages.
MessageTemplatesGenerator.MultiParamTemplateGenerator	withTemplateCode(String templateCode)	Sets the template code for generating the messages.

Method Details

withTemplate

MessageTemplatesGenerator.MultiParamTemplateGenerator withTemplate(MessageTemplate template)

Sets the template for generating the messages.

Parameters:

template - template for generating the messages

Returns:

this

withTemplateCode

MessageTemplatesGenerator.MultiParamTemplateGenerator withTemplateCode(String templateCode)

Sets the template code for generating the messages.

Parameters:

templateCode - template code for generating the messages

Returns:

this

withConfiguration

MessageTemplatesGenerator.MultiParamTemplateGenerator withConfiguration(freemarker.template.Configuration configuration)

Sets the Configuration for message generation.

Parameters:

configuration - configuration for generating the message

Returns:

this

addParams

MessageTemplatesGenerator.MultiParamTemplateGenerator addParams(Map<String,Object> params)

Adds a parameter map to the collection of parameters for generating the messages.

Parameters:

params - parameter map to add

Returns:

this

generate

List<String> generate()

Generates a messages based on the current state of the generator.

Returns:

generated messages as a list of strings