org.trimou.engine.locator

Class ClassPathTemplateLocator

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.engine.locator.AbstractTemplateLocator

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

org.trimou.engine.locator.ClassPathTemplateLocator

All Implemented Interfaces:

ConfigurationAware, TemplateLocator, WithPriority

public class ClassPathTemplateLocator
extends PathTemplateLocator<String>

Classpath template locator. There is a special ClassPathTemplateLocator.Builder for convenience.

Note that for a WAR archive, the classpath root is WEB-INF/classes (other parts of the archive are not available). Consider using org.trimou.servlet.locator.ServletContextTemplateLocator from the trimou-extension-servlet.

By default, the locator will attempt to scan the classpath to get all available template identifiers. However, only roots representing a directory on a filesystem will be processed. The scanning of JARs and other sources is not trivial. Moreover, it's legal for JARs to have no directory entries at all. Scanning can be entirely disabled - see also ClassPathTemplateLocator.Builder.setScanClasspath(boolean).

Author:

Martin Kouba

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	ClassPathTemplateLocator.Builder

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

Method Summary

Modifier and Type	Method and Description
static ClassPathTemplateLocator.Builder	builder()
static ClassPathTemplateLocator.Builder	builder(int priority)
protected String	constructVirtualPath(String source)
Set<String>	getAllIdentifiers() This method should return an empty set if it's not possible to collect the names/identifiers.
Reader	locate(String templateId) The reader is always closed by the engine right after the template source is read.

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

ClassPathTemplateLocator

public ClassPathTemplateLocator(int priority,
                                String rootPath)

Parameters:

priority -

rootPath - If null, no templates will be available for precompilation

ClassPathTemplateLocator

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

Parameters:

priority -

suffix - If null, a full template name must be used

rootPath - If null, no templates will be available for precompilation

ClassPathTemplateLocator

public ClassPathTemplateLocator(int priority,
                                String rootPath,
                                ClassLoader classLoader)

Parameters:

priority -

rootPath - If null, no templates will be available for precompilation

classLoader - If null, use the TCCL or the CL of this class

ClassPathTemplateLocator

public ClassPathTemplateLocator(int priority,
                                String rootPath,
                                String suffix,
                                ClassLoader classLoader,
                                boolean scanClasspath)

Parameters:

priority -

suffix - If null, a full template name must be used

rootPath - If null, no templates will be available for precompilation

classLoader - If null, use the TCCL or the CL of this class

scanClasspath - If set to true the locator will attempt to scan the classpath to get all available template identifiers.

Method Detail

locate

public Reader locate(String templateId)

Description copied from interface: TemplateLocator

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

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(String source)

Specified by:

constructVirtualPath in class PathTemplateLocator<String>

Returns:

the virtual path of the template

builder

public static ClassPathTemplateLocator.Builder builder()

Parameters:

priority -

Returns:

a new instance of builder

builder

public static ClassPathTemplateLocator.Builder builder(int priority)

Parameters:

priority -

Returns:

a new instance of builder