io.micronaut.views

Interface ViewsRenderer

All Known Implementing Classes:

FreemarkerViewsRenderer, HandlebarsViewsRenderer, RockerViewsRenderer, SoySauceViewsRenderer, SoyTofuViewsRenderer, 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.
static java.lang.String	FILE_SEPARATOR Deprecated. Use File.separator directly

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.
default java.lang.String	normalizeFile(java.lang.String path, java.lang.String extension) Deprecated. Use ViewUtils.normalizeFile(String, String) instead
default java.lang.String	normalizeFolder(java.lang.String path) Deprecated. Use ViewUtils.normalizeFolder(String) instead
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

FILE_SEPARATOR

@Deprecated
static final java.lang.String FILE_SEPARATOR

Deprecated. Use File.separator directly

The file separator to use.

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

normalizeFolder

@Nonnull
 @Deprecated
default java.lang.String normalizeFolder(@Nullable
                                                               java.lang.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 java.lang.String normalizeFile(@Nonnull
                                                             java.lang.String path,
                                                             java.lang.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