io.micronaut.views.pebble

Class PebbleViewsRenderer<T>

java.lang.Object

io.micronaut.views.pebble.PebbleViewsRenderer<T>

Type Parameters:

T - The model type

All Implemented Interfaces:

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

@Singleton
 @Requires(property="micronaut.views.pebble.enabled",notEquals="false") @Requires(classes=com.mitchellbosecke.pebble.PebbleEngine.class)
public class PebbleViewsRenderer<T>
extends java.lang.Object
implements ViewsRenderer<T>

Renders Views with Pebble.

Since:

2.2.0

Author:

Ecmel Ercan

See Also:

https://pebbletemplates.io/

Field Summary

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

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

Constructor Summary

Constructors

Constructor and Description
PebbleViewsRenderer(PebbleConfiguration configuration, com.mitchellbosecke.pebble.PebbleEngine engine) Deprecated. Use PebbleViewsRenderer(PebbleEngine, LocaleResolver) instead.
PebbleViewsRenderer(com.mitchellbosecke.pebble.PebbleEngine engine) Deprecated. Use PebbleViewsRenderer(PebbleEngine, LocaleResolver) instead.
PebbleViewsRenderer(com.mitchellbosecke.pebble.PebbleEngine engine, io.micronaut.core.util.LocaleResolver<io.micronaut.http.HttpRequest<?>> httpLocaleResolver)

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String name)
io.micronaut.core.io.Writable	render(java.lang.String name, 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

Constructor Detail

PebbleViewsRenderer

@Inject
public PebbleViewsRenderer(com.mitchellbosecke.pebble.PebbleEngine engine,
                                   io.micronaut.core.util.LocaleResolver<io.micronaut.http.HttpRequest<?>> httpLocaleResolver)

Parameters:

engine - Pebble Engine

httpLocaleResolver - The locale resolver

PebbleViewsRenderer

@Deprecated
public PebbleViewsRenderer(com.mitchellbosecke.pebble.PebbleEngine engine)

Deprecated. Use PebbleViewsRenderer(PebbleEngine, LocaleResolver) instead.

Parameters:

engine - Pebble Engine

PebbleViewsRenderer

@Deprecated
public PebbleViewsRenderer(PebbleConfiguration configuration,
                                       com.mitchellbosecke.pebble.PebbleEngine engine)

Deprecated. Use PebbleViewsRenderer(PebbleEngine, LocaleResolver) instead.

Parameters:

configuration - Pebble Configuration

engine - Pebble Engine

Method Detail

render

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

Specified by:

render in interface ViewsRenderer<T>

Parameters:

name - 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 name)

Specified by:

exists in interface ViewsRenderer<T>

Parameters:

name - view name to be rendered

Returns:

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