org.trimou.engine.locator

Class FileSystemTemplateLocator

java.lang.Object

org.trimou.engine.locator.PathTemplateLocator

org.trimou.engine.locator.FileSystemTemplateLocator

All Implemented Interfaces:

TemplateLocator, WithPriority

public class FileSystemTemplateLocator
extends PathTemplateLocator

Non-recursive filesystem template locator.

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

Method Summary

Methods

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

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

addSuffix, getPriority, getRootPath, getSuffix, stripSuffix, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

FileSystemTemplateLocator

public FileSystemTemplateLocator(int priority,
                         String rootPath)

Parameters:

priority -

rootPath -

FileSystemTemplateLocator

public FileSystemTemplateLocator(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()

getPathSeparator

protected String getPathSeparator()

Overrides:

getPathSeparator in class PathTemplateLocator