Package | Description |
---|---|
freemarker.cache |
Template loading and caching.
|
freemarker.core |
The seldom used or advanced parts of the fundamental FreeMarker API, compared to
freemarker.template . |
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.) |
Modifier and Type | Method and Description |
---|---|
Configuration |
TemplateConfigurationFactory.getConfiguration()
Returns the configuration this object belongs to, or
null if it isn't yet bound to a
Configuration . |
Constructor and Description |
---|
TemplateCache(TemplateLoader templateLoader,
CacheStorage cacheStorage,
Configuration config)
|
TemplateCache(TemplateLoader templateLoader,
CacheStorage cacheStorage,
TemplateLookupStrategy templateLookupStrategy,
TemplateNameFormat templateNameFormat,
Configuration config)
Same as
TemplateCache.TemplateCache(TemplateLoader, CacheStorage, TemplateLookupStrategy, TemplateNameFormat,
TemplateConfigurationFactory, Configuration) with null for templateConfigurations -s. |
TemplateCache(TemplateLoader templateLoader,
CacheStorage cacheStorage,
TemplateLookupStrategy templateLookupStrategy,
TemplateNameFormat templateNameFormat,
TemplateConfigurationFactory templateConfigurations,
Configuration config) |
TemplateCache(TemplateLoader templateLoader,
Configuration config)
Same as
TemplateCache.TemplateCache(TemplateLoader, CacheStorage, Configuration) with a new SoftCacheStorage
as the 2nd parameter. |
Modifier and Type | Method and Description |
---|---|
Configuration |
Environment.getConfiguration() |
Configuration |
TemplateConfiguration.getParentConfiguration()
Returns the parent
Configuration , or null if none was associated yet. |
Modifier and Type | Method and Description |
---|---|
java.lang.Object |
CustomAttribute.get(Configuration cfg)
Gets the value of a
Configuration -scope attribute from the given Configuration . |
void |
CustomAttribute.set(java.lang.Object value,
Configuration cfg)
Sets the value of a
Configuration -scope attribute in the given Configuration . |
void |
TemplateConfiguration.setParentConfiguration(Configuration cfg)
Associates this instance with a
Configuration ; usually you don't call this, as it's called internally
when this instance is added to a Configuration . |
Modifier and Type | Method and Description |
---|---|
protected Configuration |
FreemarkerServlet.createConfiguration()
Creates the FreeMarker
Configuration singleton and (when overidden) maybe sets its defaults. |
protected Configuration |
FreemarkerServlet.getConfiguration()
Returns the
Configuration object used by this servlet. |
Modifier and Type | Method and Description |
---|---|
Configuration |
Template.getConfiguration()
Returns the Configuration object associated with this template.
|
static Configuration |
Configuration.getDefaultConfiguration()
Deprecated.
The usage of the static singleton (the "default")
Configuration instance can easily cause erroneous, unpredictable
behavior. This is because multiple independent software components may use
FreeMarker internally inside the same application, so they will interfere
because of the common Configuration instance. Each such component
should use its own private Configuration object instead, that it
typically creates with new Configuration() when the component
is initialized. |
Modifier and Type | Method and Description |
---|---|
static Template |
Template.getPlainTextTemplate(java.lang.String name,
java.lang.String content,
Configuration config)
Same as
Template.getPlainTextTemplate(String, String, String, Configuration) with null sourceName
argument. |
static Template |
Template.getPlainTextTemplate(java.lang.String name,
java.lang.String sourceName,
java.lang.String content,
Configuration config)
Creates (not "get"-s) a
Template that only contains a single block of static text, no dynamic content. |
static void |
Configuration.setDefaultConfiguration(Configuration config)
Deprecated.
Using the "default"
Configuration instance can
easily lead to erroneous, unpredictable behaviour.
See more here... . |
Constructor and Description |
---|
Template(java.lang.String name,
java.io.Reader reader,
Configuration cfg)
|
Template(java.lang.String name,
java.io.Reader reader,
Configuration cfg,
java.lang.String encoding)
Convenience constructor for
Template(name, null,
reader, cfg, encoding) . |
Template(java.lang.String name,
java.lang.String sourceCode,
Configuration cfg)
Convenience constructor for
Template(name, new StringReader(reader), cfg) . |
Template(java.lang.String name,
java.lang.String sourceName,
java.io.Reader reader,
Configuration cfg)
Constructs a template from a character stream.
|
Template(java.lang.String name,
java.lang.String sourceName,
java.io.Reader reader,
Configuration cfg,
ParserConfiguration customParserConfiguration,
java.lang.String encoding)
Same as
Template.Template(String, String, Reader, Configuration, String) , but also specifies a
TemplateConfiguration . |
Template(java.lang.String name,
java.lang.String sourceName,
java.io.Reader reader,
Configuration cfg,
java.lang.String encoding)
Same as
Template.Template(String, String, Reader, Configuration) , but also specifies the template's encoding (not
recommended). |