Package io.jmix.messagetemplates.impl

Class MessageTemplatesGeneratorImpl.SingleTemplateGeneratorImpl

java.lang.Object

io.jmix.messagetemplates.impl.MessageTemplatesGeneratorImpl.SingleTemplateGeneratorImpl

All Implemented Interfaces:

MessageTemplatesGenerator.SingleTemplateGenerator

Enclosing class:

MessageTemplatesGeneratorImpl

public class MessageTemplatesGeneratorImpl.SingleTemplateGeneratorImpl
extends Object
implements MessageTemplatesGenerator.SingleTemplateGenerator

Field Summary

Fields

Modifier and Type	Field	Description
protected freemarker.template.Configuration	configuration
protected Map<String,Object>	params
protected MessageTemplate	template

Constructor Summary

Constructors

Constructor	Description
SingleTemplateGeneratorImpl()

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.

Methods inherited from class java.lang.Object

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

Field Details

template

protected MessageTemplate template

params

protected Map<String,Object> params

configuration

protected freemarker.template.Configuration configuration

Constructor Details

SingleTemplateGeneratorImpl

public SingleTemplateGeneratorImpl()

Method Details

withTemplate

public MessageTemplatesGenerator.SingleTemplateGenerator withTemplate(MessageTemplate template)

Description copied from interface: MessageTemplatesGenerator.SingleTemplateGenerator

Sets the template for generating the message.

Specified by:

withTemplate in interface MessageTemplatesGenerator.SingleTemplateGenerator

Parameters:

template - template for generating the message

Returns:

this

withTemplateCode

public MessageTemplatesGenerator.SingleTemplateGenerator withTemplateCode(String templateCode)

Description copied from interface: MessageTemplatesGenerator.SingleTemplateGenerator

Sets the template code for generating the message.

Specified by:

withTemplateCode in interface MessageTemplatesGenerator.SingleTemplateGenerator

Parameters:

templateCode - template code for generating the message

Returns:

this

withConfiguration

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

Description copied from interface: MessageTemplatesGenerator.SingleTemplateGenerator

Sets the Configuration for message generation.

Specified by:

withConfiguration in interface MessageTemplatesGenerator.SingleTemplateGenerator

Parameters:

configuration - configuration for generating the message

Returns:

this

withParams

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

Description copied from interface: MessageTemplatesGenerator.SingleTemplateGenerator

Sets the parameters for filling the template.

Specified by:

withParams in interface MessageTemplatesGenerator.SingleTemplateGenerator

Parameters:

params - parameters map

Returns:

this

addParam

public MessageTemplatesGenerator.SingleTemplateGenerator addParam(String alias,
 Object value)

Description copied from interface: MessageTemplatesGenerator.SingleTemplateGenerator

Adds a parameter to filling the template.

Specified by:

addParam in interface MessageTemplatesGenerator.SingleTemplateGenerator

Parameters:

alias - parameter alias

value - parameter value

Returns:

this

generate

public String generate()

Description copied from interface: MessageTemplatesGenerator.SingleTemplateGenerator

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

Specified by:

generate in interface MessageTemplatesGenerator.SingleTemplateGenerator

Returns:

generated message as a string