org.trimou.engine.locator

Class FilePathTemplateLocator

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.engine.locator.AbstractTemplateLocator

org.trimou.engine.locator.PathTemplateLocator<File>

org.trimou.engine.locator.FilePathTemplateLocator

All Implemented Interfaces:

ConfigurationAware, TemplateLocator, WithPriority

Direct Known Subclasses:

FileSystemTemplateLocator

public abstract class FilePathTemplateLocator
extends PathTemplateLocator<File>

Abstract file-based template locator.

Author:

Martin Kouba

Field Summary

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

VIRTUAL_PATH_SEPARATOR_KEY

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

configuration

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

DEFAULT_PRIORITY

Constructor Summary

Constructors

Constructor and Description
FilePathTemplateLocator(int priority, String rootPath)
FilePathTemplateLocator(int priority, String rootPath, String suffix)

Method Summary

Modifier and Type	Method and Description
protected String	constructVirtualPath(File source)
Set<String>	getAllIdentifiers() This method should return an empty set if it's not possible to collect the names/identifiers.
protected abstract File	getRootDir()
protected void	checkRootDir()
Reader	locate(String filePath) The reader is always closed by the engine right after the template source is read.
protected abstract Reader	locateRealPath(String realPath)

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

addSuffix, getConfigurationKeys, getDefaultFileEncoding, getRealPathSeparator, getRootPath, getSuffix, getVirtualPathSeparator, init, stripSuffix, toRealPath, toString

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

getPriority

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

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

init

Constructor Detail

FilePathTemplateLocator

public FilePathTemplateLocator(int priority,
                               String rootPath)

Parameters:

priority -

rootPath -

FilePathTemplateLocator

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

Parameters:

priority -

rootPath -

suffix -

Method Detail

locate

public Reader locate(String filePath)

Description copied from interface: TemplateLocator

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

Parameters:

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

public Set<String> getAllIdentifiers()

Description copied from interface: TemplateLocator

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

constructVirtualPath

protected String constructVirtualPath(File source)

Specified by:

constructVirtualPath in class PathTemplateLocator<File>

Returns:

the virtual path of the template

getRootDir

protected abstract File getRootDir()

Returns:

the root directory

See Also:

PathTemplateLocator.getRootPath()

locateRealPath

protected abstract Reader locateRealPath(String realPath)

Parameters:

realPath -

Returns:

the reader for the given path

checkRootDir

protected void checkRootDir()