io.micronaut.views.freemarker

Class FreemarkerViewsRenderer

java.lang.Object

io.micronaut.views.freemarker.FreemarkerViewsRenderer

All Implemented Interfaces:

ViewsRenderer

@Produces(value="text/html")
 @Requires(property="micronaut.views.freemarker.enabled",notEquals="false") @Requires(classes=freemarker.template.Configuration.class)
 @Singleton
public class FreemarkerViewsRenderer
extends java.lang.Object
implements ViewsRenderer

Renders Views with FreeMarker Java template engine.

Since:

1.1

Author:

Jerónimo López

See Also:

freemarker.apache.org

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	extension
protected FreemarkerViewsRendererConfigurationProperties	freemarkerMicronautConfiguration
protected ViewsConfiguration	viewsConfiguration

Fields inherited from interface io.micronaut.views.ViewsRenderer

EXTENSION_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
FreemarkerViewsRenderer(ViewsConfiguration viewsConfiguration, FreemarkerViewsRendererConfigurationProperties freemarkerConfiguration)

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String view)
io.micronaut.core.io.Writable	render(java.lang.String viewName, java.lang.Object data)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.views.ViewsRenderer

modelOf, render

Field Detail

viewsConfiguration

protected final ViewsConfiguration viewsConfiguration

freemarkerMicronautConfiguration

protected final FreemarkerViewsRendererConfigurationProperties freemarkerMicronautConfiguration

extension

protected final java.lang.String extension

Constructor Detail

FreemarkerViewsRenderer

@Inject
public FreemarkerViewsRenderer(ViewsConfiguration viewsConfiguration,
                                       FreemarkerViewsRendererConfigurationProperties freemarkerConfiguration)

Parameters:

viewsConfiguration - Views Configuration Properties

freemarkerConfiguration - Freemarker Configuration Properties

Method Detail

render

@NonNull
public io.micronaut.core.io.Writable render(@NonNull
                                                     java.lang.String viewName,
                                                     @Nullable
                                                     java.lang.Object data)

Specified by:

render in interface ViewsRenderer

Parameters:

viewName - view name to be render

data - response body to render it with a view

Returns:

A writable where the view will be written to.

exists

public boolean exists(@NonNull
                      java.lang.String view)

Specified by:

exists in interface ViewsRenderer

Parameters:

view - view name to be render

Returns:

true if a template can be found for the supplied view name.