Package io.micronaut.views.jte

Class JteViewsRendererConfigurationProperties

java.lang.Object

io.micronaut.views.jte.JteViewsRendererConfigurationProperties

All Implemented Interfaces:

JteViewsRendererConfiguration

@ConfigurationProperties("micronaut.views.jte")
public final class JteViewsRendererConfigurationProperties
extends Object
implements JteViewsRendererConfiguration

ConfigurationProperties for JTE.

Since:

3.1.0

Author:

edward3h

Field Summary

Fields

Modifier and Type	Field	Description
static final boolean	DEFAULT_BINARY_STATIC_CONTENT
static final boolean	DEFAULT_DYNAMIC	The default dynamic value.
static final String	DEFAULT_DYNAMIC_PATH	The default dynamic value.
static final String	PREFIX

Constructor Summary

Constructors

Constructor	Description
JteViewsRendererConfigurationProperties()

Method Summary

Modifier and Type	Method	Description
String	getDynamicPath()	When using dynamic templates, the root directory to write generated source and classes under.
String	getDynamicSourcePath()	When using dynamic templates, the root source directory to search.
boolean	isBinaryStaticContent()	When using dynamic templates, build them with binary content (see https://github.com/casid/jte/blob/master/DOCUMENTATION.md#binary-rendering-for-max-throughput).
boolean	isDynamic()	Use dynamic/hot reload templates.
void	setBinaryStaticContent(boolean binaryStaticContent)	Enable building binary content for templates.
void	setDynamic(boolean dynamic)	Whether to enable dynamic reloading of templates.
void	setDynamicPath(String path)	Root directory under which to write generated source and class files.
void	setDynamicSourcePath(String path)	When using dynamic templates, the root source directory to search.

Methods inherited from class java.lang.Object

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

Field Details

PREFIX

public static final String PREFIX

See Also:

• Constant Field Values

DEFAULT_DYNAMIC

public static final boolean DEFAULT_DYNAMIC

The default dynamic value.

See Also:

• Constant Field Values

DEFAULT_DYNAMIC_PATH

public static final String DEFAULT_DYNAMIC_PATH

The default dynamic value.

See Also:

• Constant Field Values

DEFAULT_BINARY_STATIC_CONTENT

public static final boolean DEFAULT_BINARY_STATIC_CONTENT

See Also:

• Constant Field Values

Constructor Details

JteViewsRendererConfigurationProperties

public JteViewsRendererConfigurationProperties()

Method Details

setDynamic

public void setDynamic(boolean dynamic)

Whether to enable dynamic reloading of templates. Default value (false).

Parameters:

dynamic - true to enable dynamic reloading

isDynamic

public boolean isDynamic()

Description copied from interface: JteViewsRendererConfiguration

Use dynamic/hot reload templates.

Specified by:

isDynamic in interface JteViewsRendererConfiguration

Returns:

true to enable reloading templates.

setDynamicPath

public void setDynamicPath(String path)

Root directory under which to write generated source and class files. . Default value ("build/jte-classes").

Parameters:

path - the directory

getDynamicPath

public String getDynamicPath()

Description copied from interface: JteViewsRendererConfiguration

When using dynamic templates, the root directory to write generated source and classes under.

Specified by:

getDynamicPath in interface JteViewsRendererConfiguration

Returns:

the directory

getDynamicSourcePath

public String getDynamicSourcePath()

Description copied from interface: JteViewsRendererConfiguration

When using dynamic templates, the root source directory to search. If not specified, jte will search src/main/jte and src/main/resources/<folder> where folder is ViewsConfiguration.getFolder().

Specified by:

getDynamicSourcePath in interface JteViewsRendererConfiguration

Returns:

the directory

setDynamicSourcePath

public void setDynamicSourcePath(String path)

When using dynamic templates, the root source directory to search. If not specified, jte will search src/<sourceset>/jte and src/<sourceset>/resources/<folder> where 'folder' is ViewsConfiguration.getFolder(). In cases where the source directory cannot be found, jte will use classpath loading instead, and will not dynamically reload templates.

Parameters:

path - the directory

isBinaryStaticContent

public boolean isBinaryStaticContent()

Description copied from interface: JteViewsRendererConfiguration

When using dynamic templates, build them with binary content (see https://github.com/casid/jte/blob/master/DOCUMENTATION.md#binary-rendering-for-max-throughput). (When using precompiled templates, this setting is determined by the build configuration.)

Specified by:

isBinaryStaticContent in interface JteViewsRendererConfiguration

Returns:

true to enable building binary content

setBinaryStaticContent

public void setBinaryStaticContent(boolean binaryStaticContent)

Enable building binary content for templates. Default value (false). (Only has an effect when 'dynamic' is true. To use with precompiled templates, enable it in the build plugin)

Parameters:

binaryStaticContent - true to enable binary content