Package io.micronaut.views.freemarker

Class FreemarkerViewsRenderer<T,R>

java.lang.Object

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

Type Parameters:

T - The model type

R - The request type

All Implemented Interfaces:

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

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

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

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor	Description
FreemarkerViewsRenderer(ViewsConfiguration viewsConfiguration, FreemarkerViewsRendererConfigurationProperties freemarkerConfiguration)

Method Summary

Modifier and Type	Method	Description
boolean	exists(@NonNull String view)
@NonNull io.micronaut.core.io.Writable	render(@NonNull String viewName, T data, R 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 Details

viewsConfiguration

protected final ViewsConfiguration viewsConfiguration

Views Configuration.

freemarkerMicronautConfiguration

protected final FreemarkerViewsRendererConfigurationProperties freemarkerMicronautConfiguration

Freemarker Configuration.

extension

protected final String extension

Default extension.

Constructor Details

FreemarkerViewsRenderer

@Inject
public FreemarkerViewsRenderer(ViewsConfiguration viewsConfiguration,
 FreemarkerViewsRendererConfigurationProperties freemarkerConfiguration)

Parameters:

viewsConfiguration - Views Configuration Properties

freemarkerConfiguration - Freemarker Configuration Properties

Method Details

render

@NonNull
public @NonNull io.micronaut.core.io.Writable render(@NonNull
 @NonNull String viewName,
 @Nullable
 T data,
 @Nullable
 R request)

Specified by:

render in interface ViewsRenderer<T,R>

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
 @NonNull String view)

Specified by:

exists in interface ViewsRenderer<T,R>

Parameters:

view - view name to be rendered

Returns:

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