| freemarker.cache.TemplateLoader
All known Subclasses: freemarker.cache.StringTemplateLoader, freemarker.cache.WebappTemplateLoader, freemarker.cache.URLTemplateLoader, freemarker.cache.FileTemplateLoader,
| TemplateLoader | | public interface TemplateLoader (Code) | | A template loader is an object that can find the source stream for a
template, can retrieve its time of last modification as well as the stream
itself. A template loader is plugged into the
TemplateCache to
provide concrete loading of the templates.
The implementations can be coded in a non-threadsafe manner as the natural
user of the template loader,
TemplateCache does the necessary
synchronization.
author:
Attila Szegedi, szegedia at freemail dot hu
version:
$Id: TemplateLoader.java,v 1.18 2004/03/01 01:13:30 ddekany Exp $ |
| closeTemplateSource | | public void closeTemplateSource(Object templateSource) throws IOException(Code) | | Closes the template source. This is the last method that is called by
the TemplateCache for a templateSource. The framework guarantees that
this method will be called on every object that is returned from
TemplateLoader.findTemplateSource(String) .
Parameters:
templateSource - the template source that should be closed. |
| findTemplateSource | | public Object findTemplateSource(String name) throws IOException(Code) | | Finds the object that acts as the source of the template with the
given name. This method is called by the TemplateCache when a template
is requested, before calling either
TemplateLoader.getLastModified(Object) or
TemplateLoader.getReader(Object,String) .
Parameters:
name - the name of the template, already localized and normalized bythe freemarker.cache.TemplateCache cache.It is completely up to the loader implementation to interpretthe name, however it should expect to receive hierarchical paths wherepath components are separated by a slash (not backslash). Backslashes(or any other OS specific separator character) are not considered as separators byFreeMarker, and thus they will not be replaced with slash before passing to this method,so it is up to the template loader to handle them (say, be throwing and exception thattells the user that the path (s)he has entered is invalid, as (s)he must use slash --typical mistake of Windows users).The passed names are always considered relative to some loader-defined rootlocation (often reffered as the "template root direcotry"), and will never start witha slash, nor will they contain a path component consisting of either a single or a doubledot -- these are all resolved by the template cache before passing the name to theloader. As a side effect, paths that trivially reach outside template root directory,such as ../my.ftl, will be rejected by the template cache, so they neverreach the template loader. Note again, that if the path uses backslash as path separatorinstead of slash as (the template loader should not accept that), the normalisation willnot properly happen, as FreeMarker (the cache) recognizes only the slashes as separators. an object representing the template source, which can besupplied in subsequent calls to TemplateLoader.getLastModified(Object) andTemplateLoader.getReader(Object,String). Null must be returned if the sourcefor the template can not be found (do not throw FileNotFoundException!).The returned object may will be compared with a cached template sourceobject for equality, using the equals method. Thus,objects returned for the same physical source must be equivalentaccording to equals method, otherwise template cachingcan become very ineffective! |
| getLastModified | | public long getLastModified(Object templateSource)(Code) | | Returns the time of last modification of the specified template source.
This method is called after findTemplateSource().
Parameters:
templateSource - an object representing a template source, obtainedthrough a prior call to TemplateLoader.findTemplateSource(String). the time of last modification of the specified template source,or -1 if the time is not known. |
| getReader | | public Reader getReader(Object templateSource, String encoding) throws IOException(Code) | | Returns the character stream of a template represented by the specified
template source. This method is called after getLastModified()
if it is determined that a cached copy of the template is unavailable
or stale.
Parameters:
templateSource - an object representing a template source, obtainedthrough a prior call to TemplateLoader.findTemplateSource(String).
Parameters:
encoding - the character encoding used to translate source bytesto characters. Some loaders may not have access to the byterepresentation of the template stream, and instead directly obtain a character stream. These loaders will - quite naturally - ignore the encoding parameter. a reader representing the template character stream. Theframework will call close().
throws:
IOException - if an I/O error occurs while accessing the stream. |
|
|