EngineConfigurationKey (trimou-core 2.3.0.Final API)

java.lang.Object
- java.lang.Enum<EngineConfigurationKey>
- - org.trimou.engine.config.EngineConfigurationKey

All Implemented Interfaces:

Serializable, Comparable<EngineConfigurationKey>, ConfigurationKey
```
public enum EngineConfigurationKey
extends Enum<EngineConfigurationKey>
implements ConfigurationKey
```
Engine configuration keys.

Author:

Martin Kouba

Enum Constant Summary

Enum Constants
Enum Constant and Description
`CACHE_SECTION_LITERAL_BLOCK` `true` in case of the section-based literal blocks should be cached (useful to optimize some lambdas processing scenarios, but memory intensive), `false` otherwise.
`DEBUG_MODE` `true` in case of debug mode should be enabled, `false` otherwise.
`DEFAULT_FILE_ENCODING` The encoding every template locator should use if reading template from a file.
`END_DELIMITER` The default end delimiter (e.g.
`HANDLEBARS_SUPPORT_ENABLED` If set to `true` handlebars-like helpers are supported.
`ITERATION_METADATA_ALIAS` The alias for iteration metadata object available inside an iteration block.
`NESTED_TEMPLATE_SUPPORT_ENABLED` If set to `true` the nested templates are supported.
`NO_VALUE_INDICATES_PROBLEM` Deprecated. see also `MissingValueHandler`
`PRECOMPILE_ALL_TEMPLATES` `true` if precompilation of all available templates is required, `false` otherwise.
`REMOVE_STANDALONE_LINES` `true` if standalone lines should be removed (see also Mustache spec), `false` otherwise.
`REMOVE_UNNECESSARY_SEGMENTS` `true` if unnecessary segments should be removed (e.g.
`RESOLVER_HINTS_ENABLED` If set to `true` a hint may be used to skip the resolver chain for some parts of the key during evaluation of variables.
`REUSE_LINE_SEPARATOR_SEGMENTS` If set to `true` line separators will be reused within template to conserve memory.
`SKIP_VALUE_ESCAPING` If set to `true` interpolated values are never escaped, i.e.
`START_DELIMITER` The default start delimiter (e.g.
`TEMPLATE_CACHE_ENABLED` If set to `true` the template cache is enabled.
`TEMPLATE_CACHE_EXPIRATION_TIMEOUT` The template cache expiration timeout in seconds.
`TEMPLATE_CACHE_USED_FOR_SOURCE` If set to `true` the template cache is also used for template sources.
`TEMPLATE_RECURSIVE_INVOCATION_LIMIT` The limit of recursive template invocation; 0 - recursive invocation is forbidden.

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`String`	`get()`
`Object`	`getDefaultValue()` The set of supported value types which can be automatically converted consist of `String`, `Boolean`, `Integer` and `Long`.
`static EngineConfigurationKey`	`valueOf(String name)` Returns the enum constant of this type with the specified name.
`static EngineConfigurationKey[]`	`values()` Returns an array containing the constants of this enum type, in the order they are declared.

Methods inherited from class java.lang.Enum
clone, compareTo, equals, finalize, getDeclaringClass, hashCode, name, ordinal, toString, valueOf

Methods inherited from class java.lang.Object
getClass, notify, notifyAll, wait, wait, wait

- Enum Constant Detail
  - START_DELIMITER
```
public static final EngineConfigurationKey START_DELIMITER
```
    The default start delimiter (e.g. {{).
  - END_DELIMITER
```
public static final EngineConfigurationKey END_DELIMITER
```
    The default end delimiter (e.g. }}).
  - PRECOMPILE_ALL_TEMPLATES
```
public static final EngineConfigurationKey PRECOMPILE_ALL_TEMPLATES
```
    true if precompilation of all available templates is required, false otherwise.
  - REMOVE_STANDALONE_LINES
```
public static final EngineConfigurationKey REMOVE_STANDALONE_LINES
```
    true if standalone lines should be removed (see also Mustache spec), false otherwise.
  - REMOVE_UNNECESSARY_SEGMENTS
```
public static final EngineConfigurationKey REMOVE_UNNECESSARY_SEGMENTS
```
    true if unnecessary segments should be removed (e.g. comments), false otherwise.
  - NO_VALUE_INDICATES_PROBLEM
```
@Deprecated
public static final EngineConfigurationKey NO_VALUE_INDICATES_PROBLEM
```
    Deprecated. see also MissingValueHandler
    
    true if lookup miss should result in exception, false otherwise.
  - DEBUG_MODE
```
public static final EngineConfigurationKey DEBUG_MODE
```
    true in case of debug mode should be enabled, false otherwise. Debug mode disables the template cache and provides some more logging during template rendering.
  - CACHE_SECTION_LITERAL_BLOCK
```
public static final EngineConfigurationKey CACHE_SECTION_LITERAL_BLOCK
```
    true in case of the section-based literal blocks should be cached (useful to optimize some lambdas processing scenarios, but memory intensive), false otherwise.
  - TEMPLATE_RECURSIVE_INVOCATION_LIMIT
```
public static final EngineConfigurationKey TEMPLATE_RECURSIVE_INVOCATION_LIMIT
```
    The limit of recursive template invocation; 0 - recursive invocation is forbidden.
  - SKIP_VALUE_ESCAPING
```
public static final EngineConfigurationKey SKIP_VALUE_ESCAPING
```
    If set to true interpolated values are never escaped, i.e. org.trimou.engine.text.TextSupport.escapeHtml(String) is never called.
  - DEFAULT_FILE_ENCODING
```
public static final EngineConfigurationKey DEFAULT_FILE_ENCODING
```
    The encoding every template locator should use if reading template from a file.
  - TEMPLATE_CACHE_ENABLED
```
public static final EngineConfigurationKey TEMPLATE_CACHE_ENABLED
```
    If set to true the template cache is enabled.
  - TEMPLATE_CACHE_EXPIRATION_TIMEOUT
```
public static final EngineConfigurationKey TEMPLATE_CACHE_EXPIRATION_TIMEOUT
```
    The template cache expiration timeout in seconds. Zero and negative values mean no timeout.
  - HANDLEBARS_SUPPORT_ENABLED
```
public static final EngineConfigurationKey HANDLEBARS_SUPPORT_ENABLED
```
    If set to true handlebars-like helpers are supported.
    
    See Also:
    
    Helper
  - REUSE_LINE_SEPARATOR_SEGMENTS
```
public static final EngineConfigurationKey REUSE_LINE_SEPARATOR_SEGMENTS
```
    If set to true line separators will be reused within template to conserve memory. Note that AbstractSegment.getOrigin() will not display the correct info.
  - ITERATION_METADATA_ALIAS
```
public static final EngineConfigurationKey ITERATION_METADATA_ALIAS
```
    The alias for iteration metadata object available inside an iteration block. {{#each items}} {{iter.index}} {{/each}}
  - RESOLVER_HINTS_ENABLED
```
public static final EngineConfigurationKey RESOLVER_HINTS_ENABLED
```
    If set to true a hint may be used to skip the resolver chain for some parts of the key during evaluation of variables.
    
    See Also:
    
    EnhancedResolver.Hint
  - NESTED_TEMPLATE_SUPPORT_ENABLED
```
public static final EngineConfigurationKey NESTED_TEMPLATE_SUPPORT_ENABLED
```
    If set to true the nested templates are supported. Otherwise any start tag of a nested template definition is considered to be a regular variable tag.
  - TEMPLATE_CACHE_USED_FOR_SOURCE
```
public static final EngineConfigurationKey TEMPLATE_CACHE_USED_FOR_SOURCE
```
    If set to true the template cache is also used for template sources.
    
    See Also:
    
    MustacheEngine.getMustacheSource(String)
- Method Detail
  - values
```
public static EngineConfigurationKey[] values()
```
    Returns an array containing the constants of this enum type, in the order they are declared. This method may be used to iterate over the constants as follows:
```
for (EngineConfigurationKey c : EngineConfigurationKey.values())
    System.out.println(c);
```
    Returns:
    
    an array containing the constants of this enum type, in the order they are declared
  - valueOf
```
public static EngineConfigurationKey valueOf(String name)
```
    Returns the enum constant of this type with the specified name. The string must match exactly an identifier used to declare an enum constant in this type. (Extraneous whitespace characters are not permitted.)
    
    Parameters:
    
    name - the name of the enum constant to be returned.
    
    Returns:
    
    the enum constant with the specified name
    
    Throws:
    
    IllegalArgumentException - if this enum type has no constant with the specified name
    
    NullPointerException - if the argument is null
  - get
```
public String get()
```
    Specified by:
    
    get in interface ConfigurationKey
    
    Returns:
    
    the key itself
  - getDefaultValue
```
public Object getDefaultValue()
```
    Description copied from interface: ConfigurationKey
    
    The set of supported value types which can be automatically converted consist of String, Boolean, Integer and Long.
    
    Specified by:
    
    getDefaultValue in interface ConfigurationKey
    
    Returns:
    
    the default value

Enum EngineConfigurationKey

Enum Constant Summary

Method Summary

Methods inherited from class java.lang.Enum

Methods inherited from class java.lang.Object

Enum Constant Detail

START_DELIMITER

END_DELIMITER

PRECOMPILE_ALL_TEMPLATES

REMOVE_STANDALONE_LINES

REMOVE_UNNECESSARY_SEGMENTS

NO_VALUE_INDICATES_PROBLEM

DEBUG_MODE

CACHE_SECTION_LITERAL_BLOCK

TEMPLATE_RECURSIVE_INVOCATION_LIMIT

SKIP_VALUE_ESCAPING

DEFAULT_FILE_ENCODING

TEMPLATE_CACHE_ENABLED

TEMPLATE_CACHE_EXPIRATION_TIMEOUT

HANDLEBARS_SUPPORT_ENABLED

REUSE_LINE_SEPARATOR_SEGMENTS

ITERATION_METADATA_ALIAS

RESOLVER_HINTS_ENABLED

NESTED_TEMPLATE_SUPPORT_ENABLED

TEMPLATE_CACHE_USED_FOR_SOURCE

Method Detail

values

valueOf

get

getDefaultValue