io.micronaut.views.thymeleaf

Class ThymeleafViewsRenderer<T>

java.lang.Object

io.micronaut.views.thymeleaf.ThymeleafViewsRenderer<T>

Type Parameters:

T - The model type

All Implemented Interfaces:

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

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

Renders templates Thymeleaf Java template engine.

Since:

1.0

Author:

Sergio del Amo, graemerocher

See Also:

https://www.thymeleaf.org

Field Summary

Fields

Modifier and Type	Field and Description
protected org.thymeleaf.TemplateEngine	engine
protected io.micronaut.http.server.util.locale.HttpLocaleResolver	httpLocaleResolver
protected io.micronaut.core.io.ResourceLoader	resourceLoader
protected org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver	templateResolver

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
ThymeleafViewsRenderer(org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver templateResolver, org.thymeleaf.TemplateEngine templateEngine, io.micronaut.core.io.scan.ClassPathResourceLoader resourceLoader) Deprecated. Use ThymeleafViewsRenderer(AbstractConfigurableTemplateResolver, TemplateEngine, ClassPathResourceLoader, HttpLocaleResolver) instead
ThymeleafViewsRenderer(org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver templateResolver, org.thymeleaf.TemplateEngine templateEngine, io.micronaut.core.io.scan.ClassPathResourceLoader resourceLoader, io.micronaut.http.server.util.locale.HttpLocaleResolver httpLocaleResolver)

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String viewName)
void	render(java.lang.String viewName, org.thymeleaf.context.IContext context, java.io.Writer writer) Passes the arguments as is to TemplateEngine.process(String, IContext, Writer).
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

templateResolver

protected final org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver templateResolver

engine

protected final org.thymeleaf.TemplateEngine engine

httpLocaleResolver

protected final io.micronaut.http.server.util.locale.HttpLocaleResolver httpLocaleResolver

resourceLoader

protected io.micronaut.core.io.ResourceLoader resourceLoader

Constructor Detail

ThymeleafViewsRenderer

@Inject
public ThymeleafViewsRenderer(org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver templateResolver,
                                      org.thymeleaf.TemplateEngine templateEngine,
                                      io.micronaut.core.io.scan.ClassPathResourceLoader resourceLoader,
                                      io.micronaut.http.server.util.locale.HttpLocaleResolver httpLocaleResolver)

Parameters:

templateResolver - The template resolver

templateEngine - The template engine

resourceLoader - The resource loader

httpLocaleResolver - The locale resolver

ThymeleafViewsRenderer

@Deprecated
public ThymeleafViewsRenderer(org.thymeleaf.templateresolver.AbstractConfigurableTemplateResolver templateResolver,
                                          org.thymeleaf.TemplateEngine templateEngine,
                                          io.micronaut.core.io.scan.ClassPathResourceLoader resourceLoader)

Deprecated. Use ThymeleafViewsRenderer(AbstractConfigurableTemplateResolver, TemplateEngine, ClassPathResourceLoader, HttpLocaleResolver) instead

Parameters:

templateResolver - The template resolver

templateEngine - The template engine

resourceLoader - The resource loader

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.

render

public void render(java.lang.String viewName,
                   org.thymeleaf.context.IContext context,
                   java.io.Writer writer)

Passes the arguments as is to TemplateEngine.process(String, IContext, Writer).

Parameters:

viewName - The view name

context - The context

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.