io.micronaut.views.velocity

Class VelocityViewsRenderer

java.lang.Object

io.micronaut.views.velocity.VelocityViewsRenderer

All Implemented Interfaces:

ViewsRenderer

@Produces(value="text/html")
 @Requires(property="micronaut.views.velocity.enabled",notEquals="false") @Requires(classes=org.apache.velocity.app.VelocityEngine.class)
 @Singleton
public class VelocityViewsRenderer
extends Object
implements ViewsRenderer

Renders with templates with Apache Velocity Project.

Since:

1.0

Author:

Sergio del Amo, graemerocher

See Also:

http://velocity.apache.org

Field Summary

Fields

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

Fields inherited from interface io.micronaut.views.ViewsRenderer

EXTENSION_SEPARATOR, FILE_SEPARATOR

Method Summary

Modifier and Type	Method and Description
boolean	exists(String viewName)
Writable	render(String view, Object data)

Methods inherited from class java.lang.Object

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

Field Detail

velocityEngine

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

viewsConfiguration

protected final ViewsConfiguration viewsConfiguration

velocityConfiguration

protected final VelocityViewsRendererConfiguration velocityConfiguration

Method Detail

render

public Writable render(String view,
                       @Nullable
                       Object data)

Specified by:

render in interface ViewsRenderer

Parameters:

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

Specified by:

exists in interface ViewsRenderer

Parameters:

viewName - view name to be render

Returns:

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