org.trimou.engine.locator

Class ClassPathTemplateLocator

java.lang.Object

org.trimou.engine.config.AbstractConfigurationAware

org.trimou.engine.locator.AbstractTemplateLocator

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

org.trimou.engine.locator.FilePathTemplateLocator

org.trimou.engine.locator.ClassPathTemplateLocator

All Implemented Interfaces:

ConfigurationAware, TemplateLocator, WithPriority

public class ClassPathTemplateLocator
extends FilePathTemplateLocator

Classpath template locator. There is a special ClassPathTemplateLocator.Builder for convenience. Note that for WAR archive, the classpath root is WEB-INF/classes (other parts of the archive are not available).

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 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, java.lang.String rootPath)
ClassPathTemplateLocator(int priority, java.lang.String rootPath, java.lang.ClassLoader classLoader)
ClassPathTemplateLocator(int priority, java.lang.String rootPath, java.lang.String suffix)
ClassPathTemplateLocator(int priority, java.lang.String rootPath, java.lang.String suffix, java.lang.ClassLoader classLoader)

Method Summary

Methods

Modifier and Type	Method and Description
static ClassPathTemplateLocator.Builder	builder(int priority)
java.util.Set<java.lang.String>	getAllIdentifiers()
protected java.io.File	getRootDir()
java.io.Reader	locateRealPath(java.lang.String realPath)

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

constructVirtualPath, checkRootDir, isDirectoryUsable, isFileUsable, listFiles, locate

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

Methods inherited from class java.lang.Object

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

Constructor Detail

ClassPathTemplateLocator

public ClassPathTemplateLocator(int priority,
                        java.lang.String rootPath)

Parameters:

priority -

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

ClassPathTemplateLocator

public ClassPathTemplateLocator(int priority,
                        java.lang.String rootPath,
                        java.lang.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,
                        java.lang.String rootPath,
                        java.lang.ClassLoader classLoader)

Parameters:

priority -

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

classLoader - Must not be null

ClassPathTemplateLocator

public ClassPathTemplateLocator(int priority,
                        java.lang.String rootPath,
                        java.lang.String suffix,
                        java.lang.ClassLoader classLoader)

Parameters:

priority -

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

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

classLoader - Must not be null

Method Detail

getAllIdentifiers

public java.util.Set<java.lang.String> getAllIdentifiers()

Specified by:

getAllIdentifiers in interface TemplateLocator

Overrides:

getAllIdentifiers in class FilePathTemplateLocator

Returns:

the set of names of all available template identifiers (i.e. all available templates)

See Also:

EngineConfigurationKey.PRECOMPILE_ALL_TEMPLATES

locateRealPath

public java.io.Reader locateRealPath(java.lang.String realPath)

Specified by:

locateRealPath in class FilePathTemplateLocator

Returns:

the reader for the given path

getRootDir

protected java.io.File getRootDir()

Specified by:

getRootDir in class FilePathTemplateLocator

Returns:

the root directory

See Also:

PathTemplateLocator.getRootPath()

builder

public static ClassPathTemplateLocator.Builder builder(int priority)

Parameters:

priority -

Returns:

a new instance of builder