io.micronaut.views.freemarker

Class FreemarkerViewsRenderer<T>

java.lang.Object

io.micronaut.views.freemarker.FreemarkerViewsRenderer<T>

Type Parameters:

T - The model type

All Implemented Interfaces:

io.micronaut.core.order.Ordered, ViewsRenderer<T>

@Requires(property="micronaut.views.freemarker.enabled",notEquals="false") @Requires(classes=freemarker.template.Configuration.class)
 @Singleton
public class FreemarkerViewsRenderer<T>
extends java.lang.Object
implements ViewsRenderer<T>

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 Default extension.
protected FreemarkerViewsRendererConfigurationProperties	freemarkerMicronautConfiguration Freemarker Configuration.
protected ViewsConfiguration	viewsConfiguration Views Configuration.

Fields inherited from interface io.micronaut.core.order.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

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, T data, io.micronaut.http.HttpRequest<?> request)

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.core.order.Ordered

getOrder

Field Detail

viewsConfiguration

protected final ViewsConfiguration viewsConfiguration

Views Configuration.

freemarkerMicronautConfiguration

protected final FreemarkerViewsRendererConfigurationProperties freemarkerMicronautConfiguration

Freemarker Configuration.

extension

protected final java.lang.String extension

Default 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
                                                     T data,
                                                     @Nullable
                                                     io.micronaut.http.HttpRequest<?> request)

Specified by:

render in interface ViewsRenderer<T>

Parameters:

viewName - view name to be rendered

data - response body to render it with a view

request - HTTP request

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<T>

Parameters:

view - view name to be rendered

Returns:

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