org.trimou.engine.locator

Interface TemplateLocator

All Superinterfaces:

ConfigurationAware, WithPriority

All Known Implementing Classes:

AbstractTemplateLocator, ClassPathTemplateLocator, FilePathTemplateLocator, FileSystemTemplateLocator, MapTemplateLocator, PathTemplateLocator

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 inherited from interface org.trimou.engine.priority.WithPriority

BUILTIN_RESOLVERS_DEFAULT_PRIORITY, BUILTIN_TEMPLATE_LOCATORS_DEFAULT_PRIORITY, EXTENSION_RESOLVERS_DEFAULT_PRIORITY

Method Summary

Methods

Modifier and Type	Method and Description
java.util.Set<java.lang.String>	getAllIdentifiers()
java.io.Reader	locate(java.lang.String templateId) The reader is always closed by the engine right after the template source is read.

Methods inherited from interface org.trimou.engine.priority.WithPriority

getPriority

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

getConfigurationKeys, init

Method Detail

locate

java.io.Reader locate(java.lang.String templateId)

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

Parameters:

templateId - 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

getAllIdentifiers

java.util.Set<java.lang.String> getAllIdentifiers()

Returns:

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

See Also:

EngineConfigurationKey.PRECOMPILE_ALL_TEMPLATES