io.micronaut.views.pebble

Class PebbleConfigurationProperties

java.lang.Object

io.micronaut.views.pebble.PebbleConfigurationProperties

All Implemented Interfaces:

io.micronaut.core.util.Toggleable, PebbleConfiguration

@ConfigurationProperties(value="micronaut.views.pebble")
public class PebbleConfigurationProperties
extends java.lang.Object
implements PebbleConfiguration

ConfigurationProperties implementation of PebbleConfiguration.

Since:

2.2.0

Author:

Ecmel Ercan

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	DEFAULT_ALLOW_OVERRIDE_CORE_OPERATORS
static boolean	DEFAULT_AUTO_ESCAPING
static boolean	DEFAULT_CACHE_ACTIVE
static boolean	DEFAULT_ENABLED
static java.lang.String	DEFAULT_ESCAPING_STRATEGY
static java.lang.String	DEFAULT_EXTENSION
static boolean	DEFAULT_GREEDY_MATCH_METHOD
static boolean	DEFAULT_LITERAL_DECIMALS_AS_INTEGERS
static boolean	DEFAULT_LITERAL_NUMBERS_AS_BIG_DECIMALS
static boolean	DEFAULT_NEW_LINE_TRIMMING
static boolean	DEFAULT_STRICT_VARIABLES
static java.lang.String	ENABLED
static java.lang.String	PREFIX

Constructor Summary

Constructors

Constructor and Description
PebbleConfigurationProperties()

Method Summary

Modifier and Type	Method and Description
java.lang.String	getDefaultEscapingStrategy()
java.lang.String	getDefaultExtension()
boolean	isAllowOverrideCoreOperators()
boolean	isAutoEscaping()
boolean	isCacheActive()
boolean	isEnabled()
boolean	isGreedyMatchMethod()
boolean	isLiteralDecimalsAsIntegers()
boolean	isLiteralNumbersAsBigDecimals()
boolean	isNewLineTrimming()
boolean	isStrictVariables()
void	setAllowOverrideCoreOperators(boolean allowOverrideCoreOperators) Sets whether or not core operators overrides should be allowed.
void	setAutoEscaping(boolean autoEscaping) Sets whether or not escaping should be performed automatically.
void	setCacheActive(boolean cacheActive) Enable/disable all caches, i.e.
void	setDefaultEscapingStrategy(java.lang.String defaultEscapingStrategy) Sets the default escaping strategy of the built-in escaper extension.
void	setDefaultExtension(java.lang.String defaultExtension) The default extension.
void	setEnabled(boolean enabled) Sets whether the component is enabled.
void	setGreedyMatchMethod(boolean greedyMatchMethod) Enable/disable greedy matching mode for finding java method.
void	setLiteralDecimalsAsIntegers(boolean literalDecimalsAsIntegers) Enable/disable treat literal decimal as Integer.
void	setLiteralNumbersAsBigDecimals(boolean literalNumbersAsBigDecimals) Enable/disable treat literal numbers as BigDecimals.
void	setNewLineTrimming(boolean newLineTrimming) Changes the newLineTrimming setting of the PebbleEngine.
void	setStrictVariables(boolean strictVariables) Changes the strictVariables setting of the PebbleEngine.

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

ENABLED

public static final java.lang.String ENABLED

See Also:

Constant Field Values

DEFAULT_ENABLED

public static final boolean DEFAULT_ENABLED

See Also:

Constant Field Values

DEFAULT_EXTENSION

public static final java.lang.String DEFAULT_EXTENSION

See Also:

Constant Field Values

DEFAULT_CACHE_ACTIVE

public static final boolean DEFAULT_CACHE_ACTIVE

See Also:

Constant Field Values

DEFAULT_NEW_LINE_TRIMMING

public static final boolean DEFAULT_NEW_LINE_TRIMMING

See Also:

Constant Field Values

DEFAULT_AUTO_ESCAPING

public static final boolean DEFAULT_AUTO_ESCAPING

See Also:

Constant Field Values

DEFAULT_ESCAPING_STRATEGY

public static final java.lang.String DEFAULT_ESCAPING_STRATEGY

See Also:

Constant Field Values

DEFAULT_STRICT_VARIABLES

public static final boolean DEFAULT_STRICT_VARIABLES

See Also:

Constant Field Values

DEFAULT_GREEDY_MATCH_METHOD

public static final boolean DEFAULT_GREEDY_MATCH_METHOD

See Also:

Constant Field Values

DEFAULT_ALLOW_OVERRIDE_CORE_OPERATORS

public static final boolean DEFAULT_ALLOW_OVERRIDE_CORE_OPERATORS

See Also:

Constant Field Values

DEFAULT_LITERAL_DECIMALS_AS_INTEGERS

public static final boolean DEFAULT_LITERAL_DECIMALS_AS_INTEGERS

See Also:

Constant Field Values

DEFAULT_LITERAL_NUMBERS_AS_BIG_DECIMALS

public static final boolean DEFAULT_LITERAL_NUMBERS_AS_BIG_DECIMALS

See Also:

Constant Field Values

Constructor Detail

PebbleConfigurationProperties

public PebbleConfigurationProperties()

Method Detail

isEnabled

public boolean isEnabled()

Specified by:

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

setEnabled

public void setEnabled(boolean enabled)

Sets whether the component is enabled. Default value (true).

Parameters:

enabled - Whether or not component is enabled

getDefaultExtension

public java.lang.String getDefaultExtension()

Specified by:

getDefaultExtension in interface PebbleConfiguration

Returns:

Gets defaultExtension property

setDefaultExtension

public void setDefaultExtension(java.lang.String defaultExtension)

The default extension. Default value ("html").

Parameters:

defaultExtension - The extension

isCacheActive

public boolean isCacheActive()

Specified by:

isCacheActive in interface PebbleConfiguration

Returns:

Gets cacheActive property

setCacheActive

public void setCacheActive(boolean cacheActive)

Enable/disable all caches, i.e. cache used by the engine to store compiled PebbleTemplate instances and tags cache. Default value (true).

Parameters:

cacheActive - toggle to enable/disable all caches

isNewLineTrimming

public boolean isNewLineTrimming()

Specified by:

isNewLineTrimming in interface PebbleConfiguration

Returns:

Gets newLineTrimming property

setNewLineTrimming

public void setNewLineTrimming(boolean newLineTrimming)

Changes the newLineTrimming setting of the PebbleEngine. By default, Pebble will trim a new line that immediately follows a Pebble tag. If set to false, then the first newline following a Pebble tag won't be trimmed. All newlines will be preserved. Default value (true).

Parameters:

newLineTrimming - Whether or not the newline should be trimmed.

isAutoEscaping

public boolean isAutoEscaping()

Specified by:

isAutoEscaping in interface PebbleConfiguration

Returns:

Gets autoEscaping property

setAutoEscaping

public void setAutoEscaping(boolean autoEscaping)

Sets whether or not escaping should be performed automatically. Default value (true).

Parameters:

autoEscaping - The auto escaping setting

getDefaultEscapingStrategy

public java.lang.String getDefaultEscapingStrategy()

Specified by:

getDefaultEscapingStrategy in interface PebbleConfiguration

Returns:

Gets defaultEscapingStrategy property

setDefaultEscapingStrategy

public void setDefaultEscapingStrategy(java.lang.String defaultEscapingStrategy)

Sets the default escaping strategy of the built-in escaper extension. Default value ("html").

Parameters:

defaultEscapingStrategy - The name of the default escaping strategy

isStrictVariables

public boolean isStrictVariables()

Specified by:

isStrictVariables in interface PebbleConfiguration

Returns:

Gets strictVariables property

setStrictVariables

public void setStrictVariables(boolean strictVariables)

Changes the strictVariables setting of the PebbleEngine. Default value (false).

Parameters:

strictVariables - Whether or not strict variables is used

isGreedyMatchMethod

public boolean isGreedyMatchMethod()

Specified by:

isGreedyMatchMethod in interface PebbleConfiguration

Returns:

Gets greedyMatchMethod property

setGreedyMatchMethod

public void setGreedyMatchMethod(boolean greedyMatchMethod)

Enable/disable greedy matching mode for finding java method. Default is disabled. If enabled, when can not find perfect method (method name, parameter length and parameter type are all satisfied), reduce the limit of the parameter type, try to find other method which has compatible parameter types. Default value (false).

Parameters:

greedyMatchMethod - toggle to enable/disable greedy match method

See Also:

com.mitchellbosecke.pebble.utils.TypeUtils#compatibleCast(Object, Class)

isAllowOverrideCoreOperators

public boolean isAllowOverrideCoreOperators()

Specified by:

isAllowOverrideCoreOperators in interface PebbleConfiguration

Returns:

Gets isAllowOverrideCoreOperators property

setAllowOverrideCoreOperators

public void setAllowOverrideCoreOperators(boolean allowOverrideCoreOperators)

Sets whether or not core operators overrides should be allowed. Default value (false).

Parameters:

allowOverrideCoreOperators - Whether or not core operators overrides should be allowed.

isLiteralDecimalsAsIntegers

public boolean isLiteralDecimalsAsIntegers()

Specified by:

isLiteralDecimalsAsIntegers in interface PebbleConfiguration

Returns:

Gets literalDecimalsAsInteger property

setLiteralDecimalsAsIntegers

public void setLiteralDecimalsAsIntegers(boolean literalDecimalsAsIntegers)

Enable/disable treat literal decimal as Integer. Default value (false), treated as Long.

Parameters:

literalDecimalsAsIntegers - toggle to enable/disable literal decimal treated as integer

isLiteralNumbersAsBigDecimals

public boolean isLiteralNumbersAsBigDecimals()

Specified by:

isLiteralNumbersAsBigDecimals in interface PebbleConfiguration

Returns:

Gets literalNumbersAsBigDecimals property

setLiteralNumbersAsBigDecimals

public void setLiteralNumbersAsBigDecimals(boolean literalNumbersAsBigDecimals)

Enable/disable treat literal numbers as BigDecimals. Default value (false), treated as Long/Double.

Parameters:

literalNumbersAsBigDecimals - toggle to enable/disable literal numbers treated as BigDecimals