io.micronaut.views

Interface ViewsRenderer

All Known Implementing Classes:

FreemarkerViewsRenderer, HandlebarsViewsRenderer, 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 String	EXTENSION_SEPARATOR The extension separator.
static String	FILE_SEPARATOR Deprecated. Use File.separator directly

Method Summary

Modifier and Type	Method and Description
boolean	exists(String viewName)
default Map<String,Object>	modelOf(Object data) Creates a view model for the given data.
default String	normalizeFile(String path, String extension) Deprecated. Use ViewUtils.normalizeFile(String, String) instead
default String	normalizeFolder(String path) Deprecated. Use ViewUtils.normalizeFolder(String) instead
Writable	render(String viewName, Object data)
default Writable	render(String viewName, Object data, HttpRequest<?> request)

Field Detail

FILE_SEPARATOR

@Deprecated
static final String FILE_SEPARATOR

Deprecated. Use File.separator directly

The file separator to use.

EXTENSION_SEPARATOR

static final String EXTENSION_SEPARATOR

The extension separator.

See Also:

Constant Field Values

Method Detail

render

@Nonnull
Writable render(@Nonnull
                         String viewName,
                         @Nullable
                         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 Writable render(@Nonnull
                                 String viewName,
                                 @Nullable
                                 Object data,
                                 @Nonnull
                                 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
               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 Map<String,Object> modelOf(@Nullable
                                            Object data)

Creates a view model for the given data.

Parameters:

data - The data

Returns:

The model

normalizeFolder

@Nonnull
 @Deprecated
default String normalizeFolder(@Nullable
                                                     String path)

Deprecated. Use ViewUtils.normalizeFolder(String) instead

Returns a path with unix style folder separators that starts and ends with a "\".

Parameters:

path - The path to normalizeFile

Returns:

The normalized path

normalizeFile

@Nonnull
 @Deprecated
default String normalizeFile(@Nonnull
                                                   String path,
                                                   String extension)

Deprecated. Use ViewUtils.normalizeFile(String, String) instead

Returns a path that is converted to unix style file separators and never starts with a "\". If an extension is provided and the path ends with the extension, the extension will be stripped. The extension parameter supports extensions that do and do not begin with a ".".

Parameters:

path - The path to normalizeFile

extension - The file extension

Returns:

The normalized path