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.
-
Interface Summary Interface Description CacheStorage Cache storage abstracts away the storage aspects of a cache - associating an object with a key, retrieval and removal via the key.CacheStorageWithGetSize A cache storage that has agetSize()
method for returning the current number of cache entries.ConcurrentCacheStorage An optional interface for cache storage that knows whether it can be concurrently accessible without synchronization.StatefulTemplateLoader Interface that can be implemented byTemplateLoader
-s that maintain some sort of internal state (i.e.TemplateLoader 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). -
Class Summary Class Description AndMatcher Logical "and" operation among the given matchers.ByteArrayTemplateLoader ClassTemplateLoader ATemplateLoader
that can load templates from the "classpath".ConditionalTemplateConfigurationFactory Returns the givenTemplateConfiguration
directly, or anotherTemplateConfigurationFactory
's result, when the specified matcher matches the template source.FileExtensionMatcher Matches the file extension; unlike other matchers, by default case insensitive.FileNameGlobMatcher As opposed toPathGlobMatcher
, it only compares the "file name" part (the part after the last/
) of the source name with the given glob.FileTemplateLoader ATemplateLoader
that uses files inside a specified directory as the source of templates.FirstMatchTemplateConfigurationFactory Returns the first non-null
result of the child factories, ignoring all further child factories.MergingTemplateConfigurationFactory Returns the merged results of all the child factories.MruCacheStorage A cache storage that implements a two-level Most Recently Used cache.MultiTemplateLoader ATemplateLoader
that uses a set of other loaders to load the templates.NotMatcher Logical "not" operation on the given matcher.NullCacheStorage A cache storage that doesn't store anything.OrMatcher Logical "or" operation among the given matchers.PathGlobMatcher Matches the whole template source name (also known as template source path) with the given glob.PathRegexMatcher Matches the whole template source name (also known as template source path) with the given regular expression.SoftCacheStorage 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.StringTemplateLoader StrongCacheStorage Strong cache storage is a cache storage that simply wraps aMap
.TemplateCache Performs caching and on-demand loading of the templates.TemplateCache.MaybeMissingTemplate Used for the return value ofTemplateCache.getTemplate(String, Locale, Object, String, boolean)
.TemplateConfigurationFactory Creates (or returns)TemplateConfiguration
-s for template sources.TemplateLookupContext Used as the parameter ofTemplateLookupStrategy.lookup(TemplateLookupContext)
.TemplateLookupResult The return value ofTemplateLookupStrategy.lookup(TemplateLookupContext)
and similar lookup methods.TemplateLookupStrategy Finds theTemplateLoader
-level (storage-level) template source for the template name with which the template was requested (as inConfiguration.getTemplate(String)
).TemplateNameFormat Symbolizes a template name format, which defines the basic syntax of names through algorithms such as normalization.TemplateSourceMatcher URLTemplateLoader This is an abstract template loader that can load templates whose location can be described by an URL.WebappTemplateLoader ATemplateLoader
that uses streams reachable throughServletContext.getResource(String)
as its source of templates. -
Exception Summary Exception Description TemplateConfigurationFactoryException Non-I/O exception thrown byTemplateConfigurationFactory
-s.