Package io.jmix.messagetemplates

Interface MessageTemplatesGenerator.SingleTemplateGenerator

All Known Implementing Classes:

MessageTemplatesGeneratorImpl.SingleTemplateGeneratorImpl

Enclosing interface:

MessageTemplatesGenerator

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

Method Summary

Modifier and Type	Method	Description
MessageTemplatesGenerator.SingleTemplateGenerator	addParam(String alias, Object value)	Adds a parameter to filling the template.
String	generate()	Generates a message based on the current state of the generator.
MessageTemplatesGenerator.SingleTemplateGenerator	withConfiguration(freemarker.template.Configuration configuration)	Sets the Configuration for message generation.
MessageTemplatesGenerator.SingleTemplateGenerator	withParams(Map<String,Object> params)	Sets the parameters for filling the template.
MessageTemplatesGenerator.SingleTemplateGenerator	withTemplate(MessageTemplate template)	Sets the template for generating the message.
MessageTemplatesGenerator.SingleTemplateGenerator	withTemplateCode(String templateCode)	Sets the template code for generating the message.

Method Details

withTemplate

MessageTemplatesGenerator.SingleTemplateGenerator withTemplate(MessageTemplate template)

Sets the template for generating the message.

Parameters:

template - template for generating the message

Returns:

this

withTemplateCode

MessageTemplatesGenerator.SingleTemplateGenerator withTemplateCode(String templateCode)

Sets the template code for generating the message.

Parameters:

templateCode - template code for generating the message

Returns:

this

withConfiguration

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

Sets the Configuration for message generation.

Parameters:

configuration - configuration for generating the message

Returns:

this

withParams

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

Sets the parameters for filling the template.

Parameters:

params - parameters map

Returns:

this

addParam

MessageTemplatesGenerator.SingleTemplateGenerator addParam(String alias,
 Object value)

Adds a parameter to filling the template.

Parameters:

alias - parameter alias

value - parameter value

Returns:

this

generate

String generate()

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

Returns:

generated message as a string