io.vertx.ext.web.templ.freemarker.impl

Class FreeMarkerTemplateEngineImpl

java.lang.Object

io.vertx.ext.web.common.template.CachingTemplateEngine<freemarker.template.Template>

io.vertx.ext.web.templ.freemarker.impl.FreeMarkerTemplateEngineImpl

All Implemented Interfaces:

TemplateEngine, FreeMarkerTemplateEngine

public class FreeMarkerTemplateEngineImpl
extends CachingTemplateEngine<freemarker.template.Template>
implements FreeMarkerTemplateEngine

Author:

Paulo Lopes

Field Summary

Fields inherited from class io.vertx.ext.web.common.template.CachingTemplateEngine

extension

Fields inherited from interface io.vertx.ext.web.templ.freemarker.FreeMarkerTemplateEngine

DEFAULT_TEMPLATE_EXTENSION

Constructor Summary

Constructors

Constructor and Description
FreeMarkerTemplateEngineImpl(Vertx vertx, String extension)

Method Summary

Modifier and Type	Method and Description
void	render(Map<String,Object> context, String templateFile, Handler<AsyncResult<Buffer>> handler) Render the template.
<T> T	unwrap() Returns the underlying engine, so further configurations or customizations may be applied.

Methods inherited from class io.vertx.ext.web.common.template.CachingTemplateEngine

adjustLocation, clearCache, getTemplate, putTemplate

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.vertx.ext.web.templ.freemarker.FreeMarkerTemplateEngine

create, create

Methods inherited from interface io.vertx.ext.web.common.template.TemplateEngine

clearCache, render, render, render

Constructor Detail

FreeMarkerTemplateEngineImpl

public FreeMarkerTemplateEngineImpl(Vertx vertx,
                                    String extension)

Method Detail

unwrap

public <T> T unwrap()

Description copied from interface: TemplateEngine

Returns the underlying engine, so further configurations or customizations may be applied.

Specified by:

unwrap in interface TemplateEngine

Type Parameters:

T - the engine object type.

Returns:

the engine instance.

render

public void render(Map<String,Object> context,
                   String templateFile,
                   Handler<AsyncResult<Buffer>> handler)

Description copied from interface: TemplateEngine

Render the template. Template engines that support partials/fragments should extract the template base path from the template filename up to the last file separator. Some engines support localization, for these engines, there is a predefined key "lang" to specify the language to be used in the localization, the format should follow the standard locale formats e.g.: "en-gb", "pt-br", "en".

Specified by:

render in interface TemplateEngine

Parameters:

context - the routing context

templateFile - the template file name to use

handler - the handler that will be called with a result containing the buffer or a failure.