org.hawkular.commons.templates

Interface TemplateService

All Known Implementing Classes:

TemplateServiceImpl

public interface TemplateService

Author:

Juraci Paixão Kröhling

Method Summary

Modifier and Type	Method and Description
String	getProcessedTemplate(String templateName, Locale locale, Map<String,Object> properties) Merges the given template name with the properties.

Method Detail

getProcessedTemplate

String getProcessedTemplate(String templateName,
                            Locale locale,
                            Map<String,Object> properties)
                     throws IOException,
                            freemarker.template.TemplateException

Merges the given template name with the properties. Uses the given locale to determine which template to load, but it's not determinant, ie, if a specific template for the given locale doesn't exists, it loads the default template. If no such template is found, a TemplateException is thrown.

Parameters:

templateName - the template name, such as 'invitation_plain.ftl'.

locale - the locale for the template, such as Locale.US

properties - the properties to merge the template with

Returns:

a String with the merged template

Throws:

IOException

freemarker.template.TemplateException