Uses of Class freemarker.cache.TemplateLookupStrategy (FreeMarker 2.3.23 API)

+ + + + + + + + + + + + + + + + +

Packages that use TemplateLookupStrategy
Package	Description
freemarker.cache	+ Template loading and caching. +
freemarker.template	+ The fundamental, most commonly used API-s of FreeMarker; +start with `Configuration` (see also the +Getting Stared in the Manual.) +

+ + +

Uses of TemplateLookupStrategy in freemarker.cache

+ + + + + + + + + + + + +

Fields in freemarker.cache declared as TemplateLookupStrategy
Modifier and Type	Field and Description
`static TemplateLookupStrategy`	TemplateLookupStrategy.`DEFAULT_2_3_0` + + The default lookup strategy of FreeMarker. +

+ + + + + + + + + + + + +

Methods in freemarker.cache that return TemplateLookupStrategy
Modifier and Type	Method and Description
`TemplateLookupStrategy`	TemplateCache.`getTemplateLookupStrategy()`

+ + + + + + + + + + +

Constructors in freemarker.cache with parameters of type TemplateLookupStrategy
Constructor and Description
`TemplateCache(TemplateLoader templateLoader, + CacheStorage cacheStorage, + TemplateLookupStrategy templateLookupStrategy, + TemplateNameFormat templateNameFormat, + Configuration config)`

+ + +

Uses of TemplateLookupStrategy in freemarker.template

+ + + + + + + + + + + + +

Methods in freemarker.template that return TemplateLookupStrategy
Modifier and Type	Method and Description
`TemplateLookupStrategy`	Configuration.`getTemplateLookupStrategy()` + The getter pair of `Configuration.setTemplateLookupStrategy(TemplateLookupStrategy)`. +

+ + + + + + + + + + + + +

Methods in freemarker.template with parameters of type TemplateLookupStrategy
Modifier and Type	Method and Description
`void`	Configuration.`setTemplateLookupStrategy(TemplateLookupStrategy templateLookupStrategy)` + Sets a `TemplateLookupStrategy` that is used to look up templates based on the requested name; as a side + effect the template cache will be emptied. +

+ + + + + + + + + + + + + + + + +

Packages that use TemplateNameFormat
Package	Description
freemarker.cache	+ Template loading and caching. +
freemarker.template	+ The fundamental, most commonly used API-s of FreeMarker; +start with `Configuration` (see also the +Getting Stared in the Manual.) +

+ + +

Uses of TemplateNameFormat in freemarker.cache

+ + + + + + + + + + + + + + + + +

Fields in freemarker.cache declared as TemplateNameFormat
Modifier and Type	Field and Description
`static TemplateNameFormat`	TemplateNameFormat.`DEFAULT_2_3_0` + The default template name format when `incompatible_improvements` is + below 2.4.0. +
`static TemplateNameFormat`	TemplateNameFormat.`DEFAULT_2_4_0` + The default template name format only when `incompatible_improvements` + is set to 2.4.0 (or higher). +

+ + + + + + + + + + + + +

Methods in freemarker.cache that return TemplateNameFormat
Modifier and Type	Method and Description
`TemplateNameFormat`	TemplateCache.`getTemplateNameFormat()`

+ + + + + + + + + + +

Constructors in freemarker.cache with parameters of type TemplateNameFormat
Constructor and Description
`TemplateCache(TemplateLoader templateLoader, + CacheStorage cacheStorage, + TemplateLookupStrategy templateLookupStrategy, + TemplateNameFormat templateNameFormat, + Configuration config)`

+ + +

Uses of TemplateNameFormat in freemarker.template

+ + + + + + + + + + + + +

Methods in freemarker.template that return TemplateNameFormat
Modifier and Type	Method and Description
`TemplateNameFormat`	Configuration.`getTemplateNameFormat()` + The getter pair of `Configuration.setTemplateNameFormat(TemplateNameFormat)`. +

+ + + + + + + + + + + + +

Methods in freemarker.template with parameters of type TemplateNameFormat
Modifier and Type	Method and Description
`void`	Configuration.`setTemplateNameFormat(TemplateNameFormat templateNameFormat)` + Sets the template name format used. +

Subclasses of URLTemplateLoader in freemarker.cache
Modifier and Type	Class and Description
`class`	`ClassTemplateLoader` + A `TemplateLoader` that can load templates from the "classpath". +

freemarker.cache

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + +

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 a `getSize()` 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 by template loaders 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
ClassTemplateLoader	+ A `TemplateLoader` that can load templates from the "classpath". +
FileTemplateLoader	+ A `TemplateLoader` that uses files inside a specified directory as the source of templates. +
MruCacheStorage	+ A cache storage that implements a two-level Most Recently Used cache. +
MultiTemplateLoader	+ A `TemplateLoader` that uses a set of other loaders to load the templates. +
NullCacheStorage	+ A cache storage that doesn't store anything. +
SoftCacheStorage	+ Soft cache storage is a cache storage that uses `SoftReference` + 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	+ A `TemplateLoader` that uses a Map with Strings as its source of + templates. +
StrongCacheStorage	+ Strong cache storage is a cache storage that simply wraps a `Map`. +
TemplateCache	+ Performs caching and on-demand loading of the templates. +
TemplateCache.MaybeMissingTemplate	+ Used for the return value of `TemplateCache.getTemplate(String, Locale, Object, String, boolean)`. +
TemplateLookupContext	+ Used as the parameter of `TemplateLookupStrategy.lookup(TemplateLookupContext)`. +
TemplateLookupResult	+ The return value of `TemplateLookupStrategy.lookup(TemplateLookupContext)` and similar lookup methods. +
TemplateLookupStrategy	+ Finds the `TemplateLoader`-level (storage-level) template source for the template name witch which the template + was requested (as in `Configuration.getTemplate(String)`). +
TemplateNameFormat	+ Symbolized template name format. +
URLTemplateLoader	+ This is an abstract template loader that can load templates whose + location can be described by an URL. +
WebappTemplateLoader	+ A `TemplateLoader` that uses streams reachable through `ServletContext.getResource(String)` as its source + of templates. +

+ + + +

Package freemarker.cache Description

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. +

Class Hierarchy

java.lang.Object +
- freemarker.cache.FileTemplateLoader (implements freemarker.cache.TemplateLoader)
- freemarker.cache.MruCacheStorage (implements freemarker.cache.CacheStorageWithGetSize)
- freemarker.cache.MultiTemplateLoader (implements freemarker.cache.StatefulTemplateLoader)
- freemarker.cache.NullCacheStorage (implements freemarker.cache.CacheStorageWithGetSize, freemarker.cache.ConcurrentCacheStorage)
- freemarker.cache.SoftCacheStorage (implements freemarker.cache.CacheStorageWithGetSize, freemarker.cache.ConcurrentCacheStorage)
- freemarker.cache.StringTemplateLoader (implements freemarker.cache.TemplateLoader)
- freemarker.cache.StrongCacheStorage (implements freemarker.cache.CacheStorageWithGetSize, freemarker.cache.ConcurrentCacheStorage)
- freemarker.cache.TemplateCache
- freemarker.cache.TemplateCache.MaybeMissingTemplate
- freemarker.cache.TemplateLookupContext
- freemarker.cache.TemplateLookupResult
- freemarker.cache.TemplateLookupStrategy
- freemarker.cache.TemplateNameFormat
- freemarker.cache.URLTemplateLoader (implements freemarker.cache.TemplateLoader) +
  - freemarker.cache.ClassTemplateLoader
  +
- freemarker.cache.WebappTemplateLoader (implements freemarker.cache.TemplateLoader)
+

Interface Hierarchy

freemarker.cache.CacheStorage +
- freemarker.cache.CacheStorageWithGetSize
- freemarker.cache.ConcurrentCacheStorage
+
freemarker.cache.TemplateLoader +
- freemarker.cache.StatefulTemplateLoader
+

+ + + + + + + + + + + + + + + + + + + + +

Packages that use freemarker.cache
Package	Description
freemarker.cache	+ Template loading and caching. +
freemarker.ext.servlet	+ Servlet for legacy "Model 2" frameworks that allows using FreeMarker +templates instead of JSP as the MVC View +(see in the Manual). +
freemarker.template	+ The fundamental, most commonly used API-s of FreeMarker; +start with `Configuration` (see also the +Getting Stared in the Manual.) +

+ + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +

Classes in freemarker.cache used by freemarker.cache
Class and 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 a `getSize()` 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. +
NullCacheStorage + A cache storage that doesn't store anything. +
StatefulTemplateLoader + Interface that can be implemented by template loaders that maintain some + sort of internal state (i.e. +
TemplateCache.MaybeMissingTemplate + Used for the return value of `TemplateCache.getTemplate(String, Locale, Object, String, boolean)`. +
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). +
TemplateLookupContext + Used as the parameter of `TemplateLookupStrategy.lookup(TemplateLookupContext)`. +
TemplateLookupResult + The return value of `TemplateLookupStrategy.lookup(TemplateLookupContext)` and similar lookup methods. +
TemplateLookupStrategy + Finds the `TemplateLoader`-level (storage-level) template source for the template name witch which the template + was requested (as in `Configuration.getTemplate(String)`). +
TemplateNameFormat + Symbolized template name format. +
URLTemplateLoader + This is an abstract template loader that can load templates whose + location can be described by an URL. +

+ + + + + + + + + + + + +

Classes in freemarker.cache used by freemarker.ext.servlet
Class and Description
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). +

+ + + + + + + + + + + + + + + + + + + + + +

Classes in freemarker.cache used by freemarker.template
Class and Description
CacheStorage + Cache storage abstracts away the storage aspects of a cache - associating + an object with a key, retrieval and removal via the key. +
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). +
TemplateLookupStrategy + Finds the `TemplateLoader`-level (storage-level) template source for the template name witch which the template + was requested (as in `Configuration.getTemplate(String)`). +
TemplateNameFormat + Symbolized template name format. +