org.trimou.engine.locator

Interface TemplateLocator

All Superinterfaces:

ConfigurationAware, WithPriority

All Known Implementing Classes:

AbstractTemplateLocator, ClassPathTemplateLocator, FilePathTemplateLocator, FileSystemTemplateLocator, MapTemplateLocator, PathTemplateLocator

Functional Interface:

This is a functional interface and can therefore be used as the assignment target for a lambda expression or method reference.

@FunctionalInterface
public interface TemplateLocator
extends WithPriority, ConfigurationAware

Automatically locates the template contents for the given template identifier. The form of the template identifier is not defined, however in most cases the id will represent a template name or virtual path. Implementation must be thread-safe.

Author:

Martin Kouba

Field Summary

Fields

Modifier and Type	Field and Description
static int	DEFAULT_PRIORITY

Method Summary

Modifier and Type	Method and Description
default Set<String>	getAllIdentifiers() This method should return an empty set if it's not possible to collect the names/identifiers.
default int	getPriority()
Reader	locate(String name) The reader is always closed by the engine right after the template source is read.

Methods inherited from interface org.trimou.engine.config.ConfigurationAware

getConfigurationKeys, init

Field Detail

DEFAULT_PRIORITY

static final int DEFAULT_PRIORITY

See Also:

Constant Field Values

Method Detail

locate

Reader locate(String name)

The reader is always closed by the engine right after the template source is read.

Parameters:

name - The template identifier

Returns:

the reader object for a template with the given name or null if no available template with the given name exists

See Also:

Mustache.getName()

getAllIdentifiers

default Set<String> getAllIdentifiers()

This method should return an empty set if it's not possible to collect the names/identifiers.

Returns:

the set of names of all available template identifiers (i.e. all available templates)

See Also:

EngineConfigurationKey.PRECOMPILE_ALL_TEMPLATES

getPriority

default int getPriority()

Specified by:

getPriority in interface WithPriority

Returns:

the priority value