io.micronaut.views

Interface ViewsRenderer

All Known Implementing Classes:

FreemarkerViewsRenderer, HandlebarsViewsRenderer, RockerViewsRenderer, SoySauceViewsRenderer, ThymeleafViewsRenderer, VelocityViewsRenderer

public interface ViewsRenderer

Interface to be implemented by View Engines implementations.

Since:

1.0

Author:

Sergio del Amo

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EXTENSION_SEPARATOR The extension separator.

Method Summary

Modifier and Type	Method and Description
boolean	exists(java.lang.String viewName)
default java.util.Map<java.lang.String,java.lang.Object>	modelOf(java.lang.Object data) Creates a view model for the given data.
io.micronaut.core.io.Writable	render(java.lang.String viewName, java.lang.Object data)
default io.micronaut.core.io.Writable	render(java.lang.String viewName, java.lang.Object data, io.micronaut.http.HttpRequest<?> request)

Field Detail

EXTENSION_SEPARATOR

static final java.lang.String EXTENSION_SEPARATOR

The extension separator.

See Also:

Constant Field Values

Method Detail

render

@NonNull
io.micronaut.core.io.Writable render(@NonNull
                                              java.lang.String viewName,
                                              @Nullable
                                              java.lang.Object data)

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.

render

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

Parameters:

viewName - view name to be render

data - response body to render it with a view

request - HTTP request

Returns:

A writable where the view will be written to.

exists

boolean exists(@NonNull
               java.lang.String viewName)

Parameters:

viewName - view name to be render

Returns:

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

modelOf

@NonNull
default java.util.Map<java.lang.String,java.lang.Object> modelOf(@Nullable
                                                                          java.lang.Object data)

Creates a view model for the given data.

Parameters:

data - The data

Returns:

The model