org.trimou.engine.locator

Class MapTemplateLocator

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.engine.locator.AbstractTemplateLocator

org.trimou.engine.locator.MapTemplateLocator

All Implemented Interfaces:

ConfigurationAware, TemplateLocator, WithPriority

public class MapTemplateLocator
extends AbstractTemplateLocator

Template locator backed by a Map.

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

Constructor Summary

Constructors

Constructor and Description
MapTemplateLocator(int priority, java.util.Map<java.lang.String,java.lang.String> templates)
MapTemplateLocator(java.util.Map<java.lang.String,java.lang.String> templates)

Method Summary

Methods

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

Methods inherited from class org.trimou.engine.locator.AbstractTemplateLocator

getPriority

Methods inherited from class org.trimou.engine.config.AbstractConfigurationAware

getConfigurationKeys, checkNotInitialized, init

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

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

getConfigurationKeys, init

Constructor Detail

MapTemplateLocator

public MapTemplateLocator(int priority,
                  java.util.Map<java.lang.String,java.lang.String> templates)

MapTemplateLocator

public MapTemplateLocator(java.util.Map<java.lang.String,java.lang.String> templates)

Method Detail

locate

public java.io.Reader locate(java.lang.String templateName)

Description copied from interface: TemplateLocator

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

Parameters:

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

public 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

toString

public java.lang.String toString()

Overrides:

toString in class java.lang.Object