Uses of Package
freemarker.template
Packages that use freemarker.template
Package
Description
Template loading and caching.
The seldom used or advanced parts of the fundamental FreeMarker API, compared to
freemarker.template
.Debugging API; experimental status, might change!
This is to support debugging in IDE-s.
The default object wrapper of FreeMarker uses
this to expose Java Beans and POJO-s to templates.
Exposes DOM XML nodes to templates as easily traversable trees;
see in the Manual.
Deprecated, use W3C DOM (
freemarker.ext.dom
) instead;
Exposes JDOM XML nodes to templates.
Classes for two-way FreeMarker-JSP integration.
Exposes Jython objects to templates.
Exposes Rhino (ECMAScript) objects to templates.
Servlet for legacy "Model 2" frameworks that allows using FreeMarker
templates instead of JSP as the MVC View
(see in the Manual).
Various classes used by
freemarker.ext
but might be useful outside it too.Deprecated, use W3C DOM with
freemarker.ext.dom
instead;
Exposes XML from DOM, dom4j or JDOM nodes, uniformly.The fundamental, most commonly used API-s of FreeMarker;
start with
Configuration
(see also the
Getting Started in the Manual.)Various classes used by core FreeMarker code but might be useful outside of it too.
-
Classes in freemarker.template used by freemarker.cacheClassDescriptionThe main entry point into the FreeMarker API; encapsulates the configuration settings of FreeMarker, also serves as a central template-loading and caching service.Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple threads.
-
Classes in freemarker.template used by freemarker.coreClassDescriptionUsed for the
attempt_exception_reported
configuration setting.The main entry point into the FreeMarker API; encapsulates the configuration settings of FreeMarker, also serves as a central template-loading and caching service.Indicates that the template name given was malformed according theTemplateNameFormat
in use.Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).A simple implementation of theTemplateHashModelEx
interface, using its own underlyingMap
orSortedMap
for storing the hash entries.Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple threads."date", "time" and "date-time" template language data types: corresponds toDate
."directive" template language data type: used as user-defined directives (much like macros) in templates.Runtime exception in a template (as opposed to a parsing-time exception:ParseException
).Used for thetemplate_exception_handler
configuration setting."hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names)."extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.Adds key-value pair listing capability toTemplateHashModelEx
.The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved."node" template language data type: an object that is a node in a tree."number" template language data type; an object that stores a number."string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.Represents a version number plus the further qualifiers and build info.Convenience base-class for containers that wrap their contained arbitrary Java objects intoTemplateModel
instances. -
Classes in freemarker.template used by freemarker.debugClassDescription
ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved. -
Classes in freemarker.template used by freemarker.ext.beansClassDescriptionA
TemplateModel
that can be unwrapped and then it considers a provided desired (hint) class.Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).Experimental - subject to change: Adds functionality toObjectWrapper
that creates a plain Java object from aTemplateModel
."boolean" template language data type; same as in Java; eithertrue
orfalse
."collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to be accessed by index or key, nor the number of elements in it is known."date", "time" and "date-time" template language data types: corresponds toDate
.Runtime exception in a template (as opposed to a parsing-time exception:ParseException
)."hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names)."extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.Adds key-value pair listing capability toTemplateHashModelEx
.Iterates over the key-value pairs in a hash.Deprecated."extended method" template language data type: Objects that act like functions.The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.Implemented by classes that serve as adapters for template model objects in some other object model.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved.Used to iterate over a set of template models once; usually returned fromTemplateCollectionModel.iterator()
.ATemplateModel
on which the?api
operation can be applied."number" template language data type; an object that stores a number."string" template language data-type; like in Java, an unmodifiable UNICODE character sequence."sequence" template language data type; an object that contains other objects accessible through an integer 0-based index.Represents a version number plus the further qualifiers and build info.Convenience base-class for containers that wrap their contained arbitrary Java objects intoTemplateModel
instances. -
Classes in freemarker.template used by freemarker.ext.domClassDescriptionA
TemplateModel
that can be unwrapped and then it considers a provided desired (hint) class."hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved."node" template language data type: an object that is a node in a tree.ATemplateNodeModel
that supports navigating to the previous and next sibling nodes."sequence" template language data type; an object that contains other objects accessible through an integer 0-based index. -
Classes in freemarker.template used by freemarker.ext.jdomClassDescription"collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to be accessed by index or key, nor the number of elements in it is known."hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).Deprecated.Use
TemplateMethodModelEx
instead.The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved.Used to iterate over a set of template models once; usually returned fromTemplateCollectionModel.iterator()
."string" template language data-type; like in Java, an unmodifiable UNICODE character sequence."sequence" template language data type; an object that contains other objects accessible through an integer 0-based index. -
Classes in freemarker.template used by freemarker.ext.jspClassDescriptionMaps Java objects to the type-system of FreeMarker Template Language (see the
TemplateModel
interfaces)."hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved. -
Classes in freemarker.template used by freemarker.ext.jythonClassDescriptionA
TemplateModel
that can be unwrapped and then it considers a provided desired (hint) class.Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces)."boolean" template language data type; same as in Java; eithertrue
orfalse
."collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to be accessed by index or key, nor the number of elements in it is known."hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names)."extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.Deprecated.UseTemplateMethodModelEx
instead."extended method" template language data type: Objects that act like functions.The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved.Used to iterate over a set of template models once; usually returned fromTemplateCollectionModel.iterator()
."number" template language data type; an object that stores a number."string" template language data-type; like in Java, an unmodifiable UNICODE character sequence."sequence" template language data type; an object that contains other objects accessible through an integer 0-based index. -
Classes in freemarker.template used by freemarker.ext.rhinoClassDescriptionA
TemplateModel
that can be unwrapped and then it considers a provided desired (hint) class.Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).Experimental - subject to change: Adds functionality toObjectWrapper
that creates a plain Java object from aTemplateModel
."boolean" template language data type; same as in Java; eithertrue
orfalse
."collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to be accessed by index or key, nor the number of elements in it is known."hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names)."extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.Deprecated.UseTemplateMethodModelEx
instead."extended method" template language data type: Objects that act like functions.The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved."number" template language data type; an object that stores a number."string" template language data-type; like in Java, an unmodifiable UNICODE character sequence."sequence" template language data type; an object that contains other objects accessible through an integer 0-based index. -
Classes in freemarker.template used by freemarker.ext.servletClassDescriptionThe main entry point into the FreeMarker API; encapsulates the configuration settings of FreeMarker, also serves as a central template-loading and caching service.Maps Java objects to the type-system of FreeMarker Template Language (see the
TemplateModel
interfaces).A simple implementation of theTemplateHashModelEx
interface, using its own underlyingMap
orSortedMap
for storing the hash entries.Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple threads."collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to be accessed by index or key, nor the number of elements in it is known.Represents the nested content of a directive (TemplateDirectiveModel
) invocation."directive" template language data type: used as user-defined directives (much like macros) in templates.Runtime exception in a template (as opposed to a parsing-time exception:ParseException
)."hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names)."extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.Adds key-value pair listing capability toTemplateHashModelEx
.The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved.Convenience base-class for containers that wrap their contained arbitrary Java objects intoTemplateModel
instances. -
Classes in freemarker.template used by freemarker.ext.utilClassDescriptionMaps Java objects to the type-system of FreeMarker Template Language (see the
TemplateModel
interfaces).The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types. -
Classes in freemarker.template used by freemarker.ext.xmlClassDescription"hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).Deprecated.Use
TemplateMethodModelEx
instead.The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved."node" template language data type: an object that is a node in a tree."string" template language data-type; like in Java, an unmodifiable UNICODE character sequence."sequence" template language data type; an object that contains other objects accessible through an integer 0-based index. -
Classes in freemarker.template used by freemarker.templateClassDescriptionA
TemplateModel
that can be unwrapped and then it considers a provided desired (hint) class.Used for theattempt_exception_reported
configuration setting.The main entry point into the FreeMarker API; encapsulates the configuration settings of FreeMarker, also serves as a central template-loading and caching service.Adapts anarray
of a non-primitive elements to the correspondingTemplateModel
interface(s), most importantly toTemplateHashModelEx
.Adapts anEnumeration
to the correspondingTemplateModel
interface(s), most importantly toTemplateCollectionModel
.Adapts anIterable
to the correspondingTemplateModel
interface(s), most importantly toTemplateCollectionModel
.Adapts anIterator
to the correspondingTemplateModel
interface(s), most importantly toTemplateCollectionModel
.Adapts aList
to the correspondingTemplateModel
interface(s), most importantly toTemplateSequenceModel
.Adapts aMap
to the correspondingTemplateModel
interface(s), most importantly toTemplateHashModelEx
.Adapts a non-List
JavaCollection
to the correspondingTemplateModel
interface(s), most importantly toTemplateCollectionModelEx
.The default implementation of theObjectWrapper
interface.HoldsDefaultObjectWrapper
configuration settings and defines their defaults.An abstract base class for scalars that vary by locale.Indicates that the template name given was malformed according theTemplateNameFormat
in use.Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).Experimental - subject to change: Adds functionality toObjectWrapper
that creates a plain Java object from aTemplateModel
.A simple implementation of theTemplateHashModelEx
interface, using its own underlyingMap
orSortedMap
for storing the hash entries.A simple implementation of the TemplateScalarModel interface, using a String.A simple implementation of theTemplateSequenceModel
interface, using its own underlyingList
for storing the list items.Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple threads."boolean" template language data type; same as in Java; eithertrue
orfalse
."collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to be accessed by index or key, nor the number of elements in it is known."collection" template language data type: Adds size/emptiness querybility toTemplateCollectionModel
."date", "time" and "date-time" template language data types: corresponds toDate
.Represents the nested content of a directive (TemplateDirectiveModel
) invocation.Runtime exception in a template (as opposed to a parsing-time exception:ParseException
).Used for thetemplate_exception_handler
configuration setting."hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names)."extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.Adds key-value pair listing capability toTemplateHashModelEx
.A key-value pair in a hash; used forTemplateHashModelEx2.KeyValuePairIterator
.Iterates over the key-value pairs in a hash.Deprecated.UseTemplateMethodModelEx
instead.The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved.Used to iterate over a set of template models once; usually returned fromTemplateCollectionModel.iterator()
.ATemplateModel
on which the?api
operation can be applied."node" template language data type: an object that is a node in a tree.ATemplateNodeModel
that supports navigating to the previous and next sibling nodes.Thrown whenConfiguration.getTemplate(String)
(or similar) doesn't find a template."number" template language data type; an object that stores a number."string" template language data-type; like in Java, an unmodifiable UNICODE character sequence."sequence" template language data type; an object that contains other objects accessible through an integer 0-based index.Represents a version number plus the further qualifiers and build info.Convenience base-class for containers that wrap their contained arbitrary Java objects intoTemplateModel
instances. -
Classes in freemarker.template used by freemarker.template.utilityClassDescriptionMaps Java objects to the type-system of FreeMarker Template Language (see the
TemplateModel
interfaces).Experimental - subject to change: Adds functionality toObjectWrapper
that creates a plain Java object from aTemplateModel
."boolean" template language data type; same as in Java; eithertrue
orfalse
."collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to be accessed by index or key, nor the number of elements in it is known."hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names)."extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.Adds key-value pair listing capability toTemplateHashModelEx
.Iterates over the key-value pairs in a hash.Deprecated.UseTemplateMethodModelEx
instead."extended method" template language data type: Objects that act like functions.The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.ObjectWrapper
-s may throw this when wrapping/unwrapping fails, orTemplateModel
methods throw this if the requested data can't be retrieved.Used to iterate over a set of template models once; usually returned fromTemplateCollectionModel.iterator()
."number" template language data type; an object that stores a number."string" template language data-type; like in Java, an unmodifiable UNICODE character sequence."sequence" template language data type; an object that contains other objects accessible through an integer 0-based index."transform" template language data type: user-defined directives (much like macros) specialized on filtering output; you should rather use the newerTemplateDirectiveModel
instead.
TemplateMethodModelEx
instead.