Package io.jmix.messagetemplates

Interface MessageTemplatesGenerator.MultiTemplateGenerator

All Known Implementing Classes:

MessageTemplatesGeneratorImpl.MultiTemplateGeneratorImpl

Enclosing interface:

MessageTemplatesGenerator

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

Method Summary

Modifier and Type	Method	Description
MessageTemplatesGenerator.MultiTemplateGenerator	addParam(String alias, Object value)	Adds a parameter to filling the templates.
List<String>	generate()	Generates a messages based on the current state of the generator.
MessageTemplatesGenerator.MultiTemplateGenerator	withConfiguration(freemarker.template.Configuration configuration)	Sets the Configuration for message generation.
MessageTemplatesGenerator.MultiTemplateGenerator	withParams(Map<String,Object> params)	Sets the parameters for filling the templates.
MessageTemplatesGenerator.MultiTemplateGenerator	withTemplateCodes(String... templateCodes)	Sets the template codes for generating the messages.
MessageTemplatesGenerator.MultiTemplateGenerator	withTemplates(MessageTemplate... templates)	Sets the templates for generating the messages.

Method Details

withTemplates

MessageTemplatesGenerator.MultiTemplateGenerator withTemplates(MessageTemplate... templates)

Sets the templates for generating the messages.

Parameters:

templates - array of MessageTemplate for generating the message.

Returns:

this

withTemplateCodes

MessageTemplatesGenerator.MultiTemplateGenerator withTemplateCodes(String... templateCodes)

Sets the template codes for generating the messages.

Parameters:

templateCodes - array of MessageTemplate codes for generating the message

Returns:

this

withConfiguration

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

Sets the Configuration for message generation.

Parameters:

configuration - configuration for generating the message

Returns:

this

withParams

MessageTemplatesGenerator.MultiTemplateGenerator withParams(Map<String,Object> params)

Sets the parameters for filling the templates.

Parameters:

params - parameters map

Returns:

this

addParam

MessageTemplatesGenerator.MultiTemplateGenerator addParam(String alias,
 Object value)

Adds a parameter to filling the templates.

Parameters:

alias - parameter alias

value - parameter value

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