org.trimou.engine.locator

Class ClassPathTemplateLocator

java.lang.Object

org.trimou.engine.locator.PathTemplateLocator

org.trimou.engine.locator.ClassPathTemplateLocator

All Implemented Interfaces:

TemplateLocator, WithPriority

public class ClassPathTemplateLocator
extends PathTemplateLocator

Non-recursive classpath template locator. Note that for WAR archive, the classpath root is WEB-INF/classes (other parts of the archive are not available).

Author:

Martin Kouba

Field Summary

Fields inherited from interface org.trimou.engine.locator.TemplateLocator

DEFAULT_SYSTEM_TEMPLATE_LOCATOR_PRIORITY

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
ClassPathTemplateLocator(int priority, String rootPath)
ClassPathTemplateLocator(int priority, String rootPath, String suffix)

Method Summary

Methods

Modifier and Type	Method and Description
Set<String>	getAllAvailableNames()
Reader	locate(String templateName)

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

addSuffix, getPathSeparator, getPriority, getRootPath, getSuffix, stripSuffix, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathTemplateLocator

public ClassPathTemplateLocator(int priority,
                        String rootPath)

Parameters:

priority -

rootPathname -

ClassPathTemplateLocator

public ClassPathTemplateLocator(int priority,
                        String rootPath,
                        String suffix)

Parameters:

priority -

suffix -

rootPathname -

Method Detail

locate

public Reader locate(String templateName)

Parameters:

templateName - The template name

Returns:

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

getAllAvailableNames

public Set<String> getAllAvailableNames()

Returns:

the set of names of all available templates

See Also:

Configuration#isPrecompileAllTemplates()