io.micronaut.views.handlebars

Class HandlebarsViewsRenderer

java.lang.Object

io.micronaut.views.handlebars.HandlebarsViewsRenderer

All Implemented Interfaces:

ViewsRenderer

@Produces(value="text/html")
 @Requires(property="micronaut.views.handlebars.enabled",notEquals="false") @Requires(classes=com.github.jknack.handlebars.Handlebars.class)
 @Singleton
public class HandlebarsViewsRenderer
extends Object
implements ViewsRenderer

Renders Views with with Handlebars.java.

Since:

1.0

Author:

Sergio del Amo

See Also:

http://jknack.github.io/handlebars.java/

Field Summary

Fields

Modifier and Type	Field and Description
protected String	folder
protected com.github.jknack.handlebars.Handlebars	handlebars
protected HandlebarsViewsRendererConfiguration	handlebarsViewsRendererConfiguration
protected ResourceLoader	resourceLoader
protected ViewsConfiguration	viewsConfiguration

Fields inherited from interface io.micronaut.views.ViewsRenderer

EXTENSION_SEPARATOR, FILE_SEPARATOR

Constructor Summary

Constructors

Constructor and Description
HandlebarsViewsRenderer(ViewsConfiguration viewsConfiguration, ClassPathResourceLoader resourceLoader, HandlebarsViewsRendererConfiguration handlebarsViewsRendererConfiguration) Deprecated.
HandlebarsViewsRenderer(ViewsConfiguration viewsConfiguration, ClassPathResourceLoader resourceLoader, HandlebarsViewsRendererConfiguration handlebarsViewsRendererConfiguration, com.github.jknack.handlebars.Handlebars handlebars)

Method Summary

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

Methods inherited from class java.lang.Object

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

Methods inherited from interface io.micronaut.views.ViewsRenderer

modelOf, normalizeFile, normalizeFolder, render

Field Detail

viewsConfiguration

protected final ViewsConfiguration viewsConfiguration

resourceLoader

protected final ResourceLoader resourceLoader

handlebarsViewsRendererConfiguration

protected HandlebarsViewsRendererConfiguration handlebarsViewsRendererConfiguration

handlebars

protected com.github.jknack.handlebars.Handlebars handlebars

folder

protected String folder

Constructor Detail

HandlebarsViewsRenderer

@Deprecated
public HandlebarsViewsRenderer(ViewsConfiguration viewsConfiguration,
                                           ClassPathResourceLoader resourceLoader,
                                           HandlebarsViewsRendererConfiguration handlebarsViewsRendererConfiguration)

Deprecated.

Parameters:

viewsConfiguration - Views Configuration

resourceLoader - Resource Loader

handlebarsViewsRendererConfiguration - Handlebars ViewRenderer Configuration.

HandlebarsViewsRenderer

@Inject
public HandlebarsViewsRenderer(ViewsConfiguration viewsConfiguration,
                                       ClassPathResourceLoader resourceLoader,
                                       HandlebarsViewsRendererConfiguration handlebarsViewsRendererConfiguration,
                                       com.github.jknack.handlebars.Handlebars handlebars)

Parameters:

viewsConfiguration - Views Configuration

resourceLoader - Resource Loader

handlebarsViewsRendererConfiguration - Handlebars ViewRenderer Configuration.

handlebars - Handlebars Engine

Method Detail

render

@Nonnull
public Writable render(@Nonnull
                                String viewName,
                                @Nullable
                                Object data)

Specified by:

render in interface ViewsRenderer

Parameters:

viewName - 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(@Nonnull
                      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.