org.trimou.engine

Interface MustacheEngine

public interface MustacheEngine

Mustache engine is the central point for template management. It has a dedicated Configuration and template cache. Implementation must be thread-safe.

Author:

Martin Kouba

Field Summary

Fields

Modifier and Type	Field and Description
static String	COMPUTING_CACHE_CONSUMER_ID

Method Summary

Modifier and Type	Method and Description
Mustache	compileMustache(String templateContent) Compile the given template.
Mustache	compileMustache(String name, String templateContent) Compile the given template.
Configuration	getConfiguration()
Mustache	getMustache(String name) Get the compiled template with the given id.
String	getMustacheSource(String name)
void	invalidateTemplateCache() Invalidate all the cache entries for both compiled and uncompiled templates.
void	invalidateTemplateCache(Predicate<String> predicate) Invalidate the cache entries whose template name is matching the given predicate.

Field Detail

COMPUTING_CACHE_CONSUMER_ID

static final String COMPUTING_CACHE_CONSUMER_ID

See Also:

ComputingCache

Method Detail

getMustache

Mustache getMustache(String name)

Get the compiled template with the given id.

This method involves all template locators to locate the template contents. Locators with higher priority are called first.

By default the compiled template is automatically put into the template cache so that no compilation happens the next time the template is requested.

Parameters:

name - The template identifier

Returns:

the compiled template with the given name or null if no such template exists

See Also:

Mustache.getName(), TemplateLocator, EngineConfigurationKey.TEMPLATE_CACHE_ENABLED, EngineConfigurationKey.TEMPLATE_CACHE_EXPIRATION_TIMEOUT

getMustacheSource

String getMustacheSource(String name)

Parameters:

name -

Returns:

uncompiled mustache template source.

See Also:

Mustache.getName()

compileMustache

Mustache compileMustache(String name,
                         String templateContent)

Compile the given template. The compiled template is not cached and so it's not available for partials and template inheritance.

Parameters:

name - The template identifier

templateContent -

Returns:

the compiled template

compileMustache

Mustache compileMustache(String templateContent)

Compile the given template. The compiled template is not cached and so it's not available for partials and template inheritance. Mustache.getName() is generated automatically.

Parameters:

templateContent -

Returns:

the compiled template

Since:

2.3

getConfiguration

Configuration getConfiguration()

Returns:

the engine configuration

invalidateTemplateCache

void invalidateTemplateCache()

Invalidate all the cache entries for both compiled and uncompiled templates.

See Also:

invalidateTemplateCache(Predicate)

invalidateTemplateCache

void invalidateTemplateCache(Predicate<String> predicate)

Invalidate the cache entries whose template name is matching the given predicate.

Parameters:

predicate -

See Also:

invalidateTemplateCache()