Class FreemarkerViewsRenderer<T,R>

java.lang.Object

io.micronaut.views.AbstractViewsRenderer<T,R>

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 AbstractViewsRenderer<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)	Determines whether a template resource for the given view name is available.
@NonNull io.micronaut.core.io.Writable	render(@NonNull String viewName, @Nullable T data, @Nullable R request)

Methods inherited from class AbstractViewsRenderer

defaultExtension, getTemplate, viewLocationWithExtension, viewLocationWithoutExtension, viewNameWithExtension

Methods inherited from class 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

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

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

Description copied from class: AbstractViewsRenderer

Determines whether a template resource for the given view name is available.

Returns false when this renderer was created without a resource loader.

Specified by:

exists in interface ViewsRenderer<T,R>

Overrides:

exists in class AbstractViewsRenderer<T,R>

Parameters:

view - The requested view name, with or without the configured extension

Returns:

Whether the corresponding template resource exists