io.micronaut.views.soy

Class SoySauceViewsRenderer<T>

java.lang.Object

io.micronaut.views.soy.SoySauceViewsRenderer<T>

Type Parameters:

T - The model type

All Implemented Interfaces:

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

@Requires(classes=com.google.template.soy.jbcsrc.api.SoySauce.class)
 @Singleton
public class SoySauceViewsRenderer<T>
extends java.lang.Object
implements ViewsRenderer<T>

Renders views with a Soy engine.

Since:

1.2.1

Author:

Sam Gammon (sam@bloombox.io)

Field Summary

Fields

Modifier and Type	Field and Description
protected SoyNamingMapProvider	namingMapProvider
protected SoyViewsRendererConfigurationProperties	soyMicronautConfiguration
protected com.google.template.soy.jbcsrc.api.SoySauce	soySauce
protected ViewsConfiguration	viewsConfiguration

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
SoySauceViewsRenderer(ViewsConfiguration viewsConfiguration, CspConfiguration cspConfiguration, SoyNamingMapProvider namingMapProvider, SoyViewsRendererConfigurationProperties soyConfiguration)

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String view)
io.micronaut.core.io.Writable	render(java.lang.String viewName, T data, io.micronaut.http.HttpRequest<?> 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 Detail

viewsConfiguration

protected final ViewsConfiguration viewsConfiguration

soyMicronautConfiguration

protected final SoyViewsRendererConfigurationProperties soyMicronautConfiguration

namingMapProvider

protected final SoyNamingMapProvider namingMapProvider

soySauce

protected final com.google.template.soy.jbcsrc.api.SoySauce soySauce

Constructor Detail

SoySauceViewsRenderer

@Inject
public SoySauceViewsRenderer(ViewsConfiguration viewsConfiguration,
                                     @Nullable
                                     CspConfiguration cspConfiguration,
                                     @Nullable
                                     SoyNamingMapProvider namingMapProvider,
                                     SoyViewsRendererConfigurationProperties soyConfiguration)

Parameters:

viewsConfiguration - Views configuration properties.

cspConfiguration - Content-Security-Policy configuration.

namingMapProvider - Soy naming map provider

soyConfiguration - Soy configuration properties.

Method Detail

render

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

Specified by:

render in interface ViewsRenderer<T>

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
                      java.lang.String view)

Specified by:

exists in interface ViewsRenderer<T>

Parameters:

view - view name to be rendered

Returns:

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