Class ViewUtils

java.lang.Object

io.micronaut.views.ViewUtils

public class ViewUtils
extends Object

Utility methods for views.

Since:

1.1.0

Author:

James Kleeh

Field Summary

Fields

Modifier and Type	Field	Description
static final String	EXTENSION_SEPARATOR	Extension separator.

Constructor Summary

Constructors

Constructor	Description
ViewUtils()

Method Summary

Modifier and Type	Method	Description
static @NonNull Map<String,Object>	modelOf(@Nullable Object data)	Creates a view model for the given data.
static @NonNull String	normalizeFile(@NonNull String path, String extension)	Returns a path that is converted to unix style file separators and never starts with a "/".
static @NonNull String	normalizeFolder(@Nullable String path)	Returns a path with unix style folder separators that starts and ends with a "/".
static @NonNull String	readResourceAsString(@NonNull io.micronaut.core.io.ResourceLoader resourceLoader, @NonNull String name, @NonNull Charset charset)	Loads a template resource as text.

Methods inherited from class Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Details

EXTENSION_SEPARATOR

public static final String EXTENSION_SEPARATOR

Extension separator.

See Also:

• Constant Field Values

Constructor Details

ViewUtils

public ViewUtils()

Method Details

modelOf

public static @NonNull Map<String,Object> modelOf(@Nullable Object data)

Creates a view model for the given data.

Parameters:

data - The data

Returns:

The model

normalizeFolder

public static @NonNull 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

public static @NonNull 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

readResourceAsString

public static @NonNull String readResourceAsString(@NonNull io.micronaut.core.io.ResourceLoader resourceLoader,
 @NonNull String name,
 @NonNull Charset charset)
                                            throws IOException

Loads a template resource as text.

Parameters:

resourceLoader - The resource loader

name - The template name

charset - The template character set

Returns:

The template text

Throws:

IOException - If the template cannot be read

Since:

6.2.0