io.micronaut.views.soy

Class SoyViewsRendererConfigurationProperties

java.lang.Object

io.micronaut.views.soy.SoyViewsRendererConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, SoyViewsRendererConfiguration

@ConfigurationProperties(value="micronaut.views.soy")
public class SoyViewsRendererConfigurationProperties
extends java.lang.Object
implements SoyViewsRendererConfiguration

ConfigurationProperties implementation for SoyTofuViewsRenderer. Configured properties support a SoyFileSet, which is rendered via a from-source renderer. Template sources are provided via DI, using a SoyFileSetProvider.

Since:

1.2.1

Author:

Sam Gammon (sam@bloombox.io)

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ENABLED The default enable value.
static java.lang.String	DEFAULT_ENGINE The default Soy rendering engine.
static boolean	DEFAULT_RENAMING Whether to mount renaming maps.
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
SoyViewsRendererConfigurationProperties(ViewsConfiguration viewsConfiguration, SoyFileSetProvider fileSetProvider) Default constructor for Soy views renderer config properties.

Method Summary

Modifier and Type	Method and Description
com.google.template.soy.jbcsrc.api.SoySauce	getCompiledTemplates()
com.google.template.soy.SoyFileSet	getFileSet()
boolean	isEnabled()
boolean	isRenamingEnabled() Specifies whether renaming is enabled.
void	setEnabled(boolean enabled) Whether Soy-backed views are enabled.
void	setRenamingEnabled(boolean renaming) Turns renaming on or off.

Methods inherited from class java.lang.Object

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

Field Detail

PREFIX

public static final java.lang.String PREFIX

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

The default enable value.

See Also:

Constant Field Values

DEFAULT_ENGINE

public static final java.lang.String DEFAULT_ENGINE

The default Soy rendering engine.

See Also:

Constant Field Values

DEFAULT_RENAMING

public static final boolean DEFAULT_RENAMING

Whether to mount renaming maps.

See Also:

Constant Field Values

Constructor Detail

SoyViewsRendererConfigurationProperties

public SoyViewsRendererConfigurationProperties(ViewsConfiguration viewsConfiguration,
                                               SoyFileSetProvider fileSetProvider)

Default constructor for Soy views renderer config properties.

Parameters:

viewsConfiguration - The views configuration

fileSetProvider - Soy file set provider (template sources)

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

isEnabled in interface io.micronaut.core.util.Toggleable

setEnabled

public void setEnabled(boolean enabled)

Whether Soy-backed views are enabled.

Parameters:

enabled - True if they are.

isRenamingEnabled

public boolean isRenamingEnabled()

Specifies whether renaming is enabled. Defaults to `true`.

Specified by:

isRenamingEnabled in interface SoyViewsRendererConfiguration

Returns:

True if it is enabled.

setRenamingEnabled

public void setRenamingEnabled(boolean renaming)

Turns renaming on or off.

Specified by:

setRenamingEnabled in interface SoyViewsRendererConfiguration

Parameters:

renaming - Renaming status.

getFileSet

@Nullable
public com.google.template.soy.SoyFileSet getFileSet()

Specified by:

getFileSet in interface SoyViewsRendererConfiguration

Returns:

The Soy file set to render from

getCompiledTemplates

@Nullable
public com.google.template.soy.jbcsrc.api.SoySauce getCompiledTemplates()

Specified by:

getCompiledTemplates in interface SoyViewsRendererConfiguration

Returns:

Return a set of pre-compiled Soy templates, if supported