Package freemarker.cache
package freemarker.cache
Template loading and caching.
Beside the actual template cache, it contains loaders that can load template files from the file system, from the
classpath, or from a web application context. If you have specific needs, you can plug custom template loaders into
the system by implementing the template loader interface.
-
InterfaceDescriptionCache storage abstracts away the storage aspects of a cache - associating an object with a key, retrieval and removal via the key.A cache storage that has a
getSize()
method for returning the current number of cache entries.An optional interface for cache storage that knows whether it can be concurrently accessible without synchronization.Interface that can be implemented byTemplateLoader
-s that maintain some sort of internal state (i.e.FreeMarker loads template "files" through objects that implement this interface, thus the templates need not be real files, and can come from any kind of data source (like classpath, servlet context, database, etc). -
ClassDescriptionLogical "and" operation among the given matchers.A
TemplateLoader
that can load templates from the "classpath".Returns the givenTemplateConfiguration
directly, or anotherTemplateConfigurationFactory
's result, when the specified matcher matches the template source.Matches the file extension; unlike other matchers, by default case insensitive.As opposed toPathGlobMatcher
, it only compares the "file name" part (the part after the last/
) of the source name with the given glob.ATemplateLoader
that uses files inside a specified directory as the source of templates.Returns the first non-null
result of the child factories, ignoring all further child factories.Returns the merged results of all the child factories.A cache storage that implements a two-level Most Recently Used cache.ATemplateLoader
that uses a set of other loaders to load the templates.Logical "not" operation on the given matcher.A cache storage that doesn't store anything.Logical "or" operation among the given matchers.Matches the whole template source name (also known as template source path) with the given glob.Matches the whole template source name (also known as template source path) with the given regular expression.Soft cache storage is a cache storage that usesSoftReference
objects to hold the objects it was passed, therefore allows the garbage collector to purge the cache when it determines that it wants to free up memory.Strong cache storage is a cache storage that simply wraps aMap
.Performs caching and on-demand loading of the templates.Used for the return value ofTemplateCache.getTemplate(String, Locale, Object, String, boolean)
.Creates (or returns)TemplateConfiguration
-s for template sources.Used as the parameter ofTemplateLookupStrategy.lookup(TemplateLookupContext)
.The return value ofTemplateLookupStrategy.lookup(TemplateLookupContext)
and similar lookup methods.Finds theTemplateLoader
-level (storage-level) template source for the template name with which the template was requested (as inConfiguration.getTemplate(String)
).Symbolizes a template name format, which defines the basic syntax of names through algorithms such as normalization.This is an abstract template loader that can load templates whose location can be described by an URL.Wraps aURL
, and implements methods required for a typical template source.ATemplateLoader
that uses streams reachable throughServletContext.getResource(String)
as its source of templates.