io.micronaut.views.velocity

Class VelocityViewsRenderer<T>

java.lang.Object

io.micronaut.views.velocity.VelocityViewsRenderer<T>

Type Parameters:

T - The model type

All Implemented Interfaces:

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

@Singleton
public class VelocityViewsRenderer<T>
extends java.lang.Object
implements ViewsRenderer<T>

Renders with templates with Apache Velocity Project.

Since:

1.0

Author:

Sergio del Amo, graemerocher

See Also:

https://velocity.apache.org

Field Summary

Fields

Modifier and Type	Field and Description
protected java.lang.String	folder
protected VelocityViewsRendererConfiguration	velocityConfiguration
protected org.apache.velocity.app.VelocityEngine	velocityEngine
protected ViewsConfiguration	viewsConfiguration

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
VelocityViewsRenderer(ViewsConfiguration viewsConfiguration, VelocityViewsRendererConfiguration velocityConfiguration, org.apache.velocity.app.VelocityEngine velocityEngine)

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String viewName)
io.micronaut.core.io.Writable	render(java.lang.String view, T data, io.micronaut.http.HttpRequest<?> request)
void	render(java.lang.String view, org.apache.velocity.VelocityContext context, java.lang.String encoding, java.io.Writer writer)

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

velocityEngine

protected final org.apache.velocity.app.VelocityEngine velocityEngine

viewsConfiguration

protected final ViewsConfiguration viewsConfiguration

velocityConfiguration

protected final VelocityViewsRendererConfiguration velocityConfiguration

folder

protected final java.lang.String folder

Constructor Detail

VelocityViewsRenderer

@Inject
public VelocityViewsRenderer(ViewsConfiguration viewsConfiguration,
                                     VelocityViewsRendererConfiguration velocityConfiguration,
                                     org.apache.velocity.app.VelocityEngine velocityEngine)

Parameters:

viewsConfiguration - Views Configuration

velocityConfiguration - Velocity Configuration

velocityEngine - Velocity Engine

Method Detail

render

@NonNull
public io.micronaut.core.io.Writable render(@NonNull
                                                     java.lang.String view,
                                                     @Nullable
                                                     T data,
                                                     @NonNull
                                                     io.micronaut.http.HttpRequest<?> request)

Specified by:

render in interface ViewsRenderer<T>

Parameters:

view - 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.

render

public void render(@NonNull
                   java.lang.String view,
                   org.apache.velocity.VelocityContext context,
                   java.lang.String encoding,
                   java.io.Writer writer)

Parameters:

view - The view

context - The context

encoding - The encoding

writer - The writer

exists

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

Specified by:

exists in interface ViewsRenderer<T>

Parameters:

viewName - view name to be rendered

Returns:

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