io.micronaut.views

Interface ViewsRenderer

All Known Implementing Classes:

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 String	normalizeFile(String path, String extension) Returns a path that is converted to unix style file separators and never starts with a "\".
default String	normalizeFolder(String path) Returns a path with unix style folder separators that starts and ends with a "\".
Writable	render(String viewName, Object data)

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.

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.

normalizeFolder

@Nonnull
default String normalizeFolder(@Nullable
                                        String path)

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
default String normalizeFile(@Nonnull
                                      String path,
                                      String extension)

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