freemarker.cache

Class TemplateCache

java.lang.Object

freemarker.cache.TemplateCache

public class TemplateCache
extends Object

Performs caching and on-demand loading of the templates. The actual template "file" loading is delegated to a TemplateLoader that you can specify in the constructor. Some aspects of caching is delegated to a CacheStorage that you can also specify in the constructor.

Typically you don't instantiate or otherwise use this class directly. The Configuration embeds an instance of this class, that you access indirectly through Configuration.getTemplate(String) and other Configuration API-s. Then TemplateLoader and CacheStorage can be set with Configuration.setTemplateLoader(TemplateLoader) and Configuration.setCacheStorage(CacheStorage).

Constructor Summary

Constructors

Constructor and Description
TemplateCache() Deprecated. Use TemplateCache(TemplateLoader) instead. The default loader is useless in most applications, also it can mean a security risk.
TemplateCache(TemplateLoader templateLoader) Deprecated. Use TemplateCache(TemplateLoader, CacheStorage, Configuration) instead.
TemplateCache(TemplateLoader templateLoader, CacheStorage cacheStorage) Deprecated. Use TemplateCache(TemplateLoader, CacheStorage, Configuration) instead.
TemplateCache(TemplateLoader templateLoader, CacheStorage cacheStorage, Configuration config)
TemplateCache(TemplateLoader defaultTemplateLoader, Configuration config) Creates an instance with the default CacheStorage.

Method Summary

Modifier and Type	Method and Description
void	clear() Removes all entries from the cache, forcing reloading of templates on subsequent getTemplate(String, Locale, String, boolean) calls.
protected static TemplateLoader	createLegacyDefaultTemplateLoader() Creates the default TemplateLoader used in 2.3.0-compatible mode.
CacheStorage	getCacheStorage()
long	getDelay() Gets the delay in milliseconds between checking for newer versions of a template source.
static String	getFullTemplatePath(Environment env, String currentTemplateDir, String targetTemplatePath) Resolves a path-like reference to a template (like the one used in #include or #import), assuming a current directory.
boolean	getLocalizedLookup() Returns if localized template lookup is enabled or not.
Template	getTemplate(String name, Locale locale, String encoding, boolean parseAsFTL) Retrieves the template with the given name (and according the specified further parameters) from the template cache, loading it into the cache first if it's missing/staled.
TemplateLoader	getTemplateLoader()
void	removeTemplate(String name, Locale locale, String encoding, boolean parse) Removes an entry from the cache, hence forcing the re-loading of it when it's next time requested.
void	setConfiguration(Configuration config) Deprecated. Use the TemplateCache(TemplateLoader, CacheStorage, Configuration) constructor.
void	setDelay(long delay) Sets the delay in milliseconds between checking for newer versions of a template sources.
void	setLocalizedLookup(boolean localizedLookup) Setis if localized template lookup is enabled or not.

Methods inherited from class java.lang.Object

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

Constructor Detail

TemplateCache

public TemplateCache()

Deprecated. Use TemplateCache(TemplateLoader) instead. The default loader is useless in most applications, also it can mean a security risk.

Returns a template cache that will first try to load a template from the file system relative to the current user directory (i.e. the value of the system property user.dir), then from the classpath.

TemplateCache

public TemplateCache(TemplateLoader templateLoader)

Deprecated. Use TemplateCache(TemplateLoader, CacheStorage, Configuration) instead.

TemplateCache

public TemplateCache(TemplateLoader templateLoader,
                     CacheStorage cacheStorage)

Deprecated. Use TemplateCache(TemplateLoader, CacheStorage, Configuration) instead.

TemplateCache

public TemplateCache(TemplateLoader defaultTemplateLoader,
                     Configuration config)

Creates an instance with the default CacheStorage.

Since:

2.3.21

TemplateCache

public TemplateCache(TemplateLoader templateLoader,
                     CacheStorage cacheStorage,
                     Configuration config)

Parameters:

templateLoader - The TemplateLoader to use. Can't be null.

cacheStorage - The CacheStorage to use. Can't be null.

config - The Configuration this cache will be used for. Can be null for backward compatibility, as it can be set with setConfiguration(Configuration) later.

Since:

2.3.21

Method Detail

createLegacyDefaultTemplateLoader

protected static TemplateLoader createLegacyDefaultTemplateLoader()

Creates the default TemplateLoader used in 2.3.0-compatible mode.

setConfiguration

public void setConfiguration(Configuration config)

Deprecated. Use the TemplateCache(TemplateLoader, CacheStorage, Configuration) constructor.

Sets the configuration object to which this cache belongs. This method is called by the configuration itself to establish the relation, and should not be called by users.

getTemplateLoader

public TemplateLoader getTemplateLoader()

getCacheStorage

public CacheStorage getCacheStorage()

getTemplate

public Template getTemplate(String name,
                            Locale locale,
                            String encoding,
                            boolean parseAsFTL)
                     throws IOException

Retrieves the template with the given name (and according the specified further parameters) from the template cache, loading it into the cache first if it's missing/staled.

For the meaning of the parameters see Configuration.getTemplate(String, Locale, String, boolean).

Returns:

the loaded template, or null if the template was not found.

Throws:

IOException

getDelay

public long getDelay()

Gets the delay in milliseconds between checking for newer versions of a template source.

Returns:

the current value of the delay

setDelay

public void setDelay(long delay)

Sets the delay in milliseconds between checking for newer versions of a template sources.

Parameters:

delay - the new value of the delay

getLocalizedLookup

public boolean getLocalizedLookup()

Returns if localized template lookup is enabled or not.

setLocalizedLookup

public void setLocalizedLookup(boolean localizedLookup)

Setis if localized template lookup is enabled or not.

clear

public void clear()

Removes all entries from the cache, forcing reloading of templates on subsequent getTemplate(String, Locale, String, boolean) calls. If the configured template loader is stateful, then its StatefulTemplateLoader.resetState() method is invoked as well.

removeTemplate

public void removeTemplate(String name,
                           Locale locale,
                           String encoding,
                           boolean parse)
                    throws IOException

Removes an entry from the cache, hence forcing the re-loading of it when it's next time requested. It doesn't delete the template file itself. This is to give the application finer control over cache updating than setDelay(long) alone does. For the meaning of the parameters, see getTemplate(String, Locale, String, boolean).

Throws:

IOException

getFullTemplatePath

public static String getFullTemplatePath(Environment env,
                                         String currentTemplateDir,
                                         String targetTemplatePath)

Resolves a path-like reference to a template (like the one used in #include or #import), assuming a current directory. This gives a full, even if non-normalized template name, that could be used for getTemplate(String, Locale, String, boolean). This is mostly used when a template refers to another template.

Parameters:

targetTemplatePath - If starts with "/" or contains "://", it's an absolute path and currentDir will be ignored, otherwise it's interpreted as relative to currentDir

currentTemplateDir - must end with "/", might contains "://".