Uses of Package
freemarker.template
-
Packages that use freemarker.template Package Description freemarker.cache Template loading and caching.freemarker.core The seldom used or advanced parts of the fundamental FreeMarker API, compared tofreemarker.template
.freemarker.debug Debugging API; experimental status, might change! This is to support debugging in IDE-s.freemarker.ext.beans Thedefault object wrapper
of FreeMarker uses this to expose Java Beans and POJO-s to templates, but it can also be used in itself as a better alternativeObjectWrapper
.freemarker.ext.dom Exposes DOM XML nodes to templates as easily traversable trees; see in the Manual.freemarker.ext.jdom Deprecated, use W3C DOM (freemarker.ext.dom
) instead; Exposes JDOM XML nodes to templates.freemarker.ext.jsp Classes for two-way FreeMarker-JSP integration.freemarker.ext.jython Exposes Jython objects to templates.freemarker.ext.rhino Exposes Rhino (ECMAScript) objects to templates.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.ext.util Various classes used byfreemarker.ext
but might be useful outside it too.freemarker.ext.xml Deprecated, use W3C DOM withfreemarker.ext.dom
instead; Exposes XML from DOM, dom4j or JDOM nodes, uniformly.freemarker.template The fundamental, most commonly used API-s of FreeMarker; start withConfiguration
(see also the Getting Stared in the Manual.)freemarker.template.utility Various classes used by core FreeMarker code but might be useful outside of it too. -
Classes in freemarker.template used by freemarker.cache Class Description Configuration The main entry point into the FreeMarker API; encapsulates the configuration settings of FreeMarker, also serves as a central template-loading and caching service.Template Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple threads. -
Classes in freemarker.template used by freemarker.core Class Description Configuration The main entry point into the FreeMarker API; encapsulates the configuration settings of FreeMarker, also serves as a central template-loading and caching service.MalformedTemplateNameException Indicates that the template name given was malformed according theTemplateNameFormat
in use.ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).SimpleHash A simple implementation of theTemplateHashModelEx
interface, using its own underlyingMap
orSortedMap
for storing the hash entries.Template Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple threads.TemplateDirectiveModel "directive" template language data type: used as user-defined directives (much like macros) in templates.TemplateException Runtime exception in a template (as opposed to a parsing-time exception:ParseException
).TemplateExceptionHandler Used for thetemplate_exception_handler
configuration setting; seeConfigurable.setTemplateExceptionHandler(TemplateExceptionHandler)
for more.TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateHashModelEx "extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved.TemplateNodeModel "node" template language data type: an object that is a node in a tree.Version Represents a version number plus the further qualifiers and build info.WrappingTemplateModel Convenience base-class for containers that wrap their contained arbitrary Java objects intoTemplateModel
instances. -
Classes in freemarker.template used by freemarker.debug Class Description TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved. -
Classes in freemarker.template used by freemarker.ext.beans Class Description AdapterTemplateModel ATemplateModel
that can be unwrapped and then it considers a provided desired (hint) class.ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).ObjectWrapperAndUnwrapper Experimental - subject to change: Adds functionality toObjectWrapper
that creates a plain Java object from aTemplateModel
.TemplateBooleanModel "boolean" template language data type; same as in Java; eithertrue
orfalse
.TemplateCollectionModel "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.TemplateDateModel "date", "time" and "date-time" template language data types: corresponds toDate
.TemplateException Runtime exception in a template (as opposed to a parsing-time exception:ParseException
).TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateHashModelEx "extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.TemplateMethodModel Deprecated.UseTemplateMethodModelEx
instead.TemplateMethodModelEx "extended method" template language data type: Objects that act like functions.TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelAdapter Implemented by classes that serve as adapters for template model objects in some other object model.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved.TemplateModelIterator Used to iterate over a set of template models once; usually returned fromTemplateCollectionModel.iterator()
.TemplateModelWithAPISupport Experimental - subject to change: ATemplateModel
on which the?api
operation can be applied.TemplateNumberModel "number" template language data type; an object that stores a number.TemplateScalarModel "string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.TemplateSequenceModel "sequence" template language data type; an object that contains other objects accessible through an integer 0-based index.Version Represents a version number plus the further qualifiers and build info.WrappingTemplateModel Convenience base-class for containers that wrap their contained arbitrary Java objects intoTemplateModel
instances. -
Classes in freemarker.template used by freemarker.ext.dom Class Description AdapterTemplateModel ATemplateModel
that can be unwrapped and then it considers a provided desired (hint) class.TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved.TemplateNodeModel "node" template language data type: an object that is a node in a tree.TemplateSequenceModel "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.jdom Class Description TemplateCollectionModel "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.TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateMethodModel Deprecated.UseTemplateMethodModelEx
instead.TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved.TemplateModelIterator Used to iterate over a set of template models once; usually returned fromTemplateCollectionModel.iterator()
.TemplateScalarModel "string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.TemplateSequenceModel "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.jsp Class Description ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved. -
Classes in freemarker.template used by freemarker.ext.jython Class Description AdapterTemplateModel ATemplateModel
that can be unwrapped and then it considers a provided desired (hint) class.ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).TemplateBooleanModel "boolean" template language data type; same as in Java; eithertrue
orfalse
.TemplateCollectionModel "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.TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateHashModelEx "extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.TemplateMethodModel Deprecated.UseTemplateMethodModelEx
instead.TemplateMethodModelEx "extended method" template language data type: Objects that act like functions.TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved.TemplateModelIterator Used to iterate over a set of template models once; usually returned fromTemplateCollectionModel.iterator()
.TemplateNumberModel "number" template language data type; an object that stores a number.TemplateScalarModel "string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.TemplateSequenceModel "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.rhino Class Description AdapterTemplateModel ATemplateModel
that can be unwrapped and then it considers a provided desired (hint) class.ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).ObjectWrapperAndUnwrapper Experimental - subject to change: Adds functionality toObjectWrapper
that creates a plain Java object from aTemplateModel
.TemplateBooleanModel "boolean" template language data type; same as in Java; eithertrue
orfalse
.TemplateCollectionModel "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.TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateHashModelEx "extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.TemplateMethodModel Deprecated.UseTemplateMethodModelEx
instead.TemplateMethodModelEx "extended method" template language data type: Objects that act like functions.TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved.TemplateNumberModel "number" template language data type; an object that stores a number.TemplateScalarModel "string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.TemplateSequenceModel "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.servlet Class Description Configuration The main entry point into the FreeMarker API; encapsulates the configuration settings of FreeMarker, also serves as a central template-loading and caching service.ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).SimpleHash A simple implementation of theTemplateHashModelEx
interface, using its own underlyingMap
orSortedMap
for storing the hash entries.Template Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple threads.TemplateCollectionModel "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.TemplateDirectiveBody Represents the nested content of a directive (TemplateDirectiveModel
) invocation.TemplateDirectiveModel "directive" template language data type: used as user-defined directives (much like macros) in templates.TemplateException Runtime exception in a template (as opposed to a parsing-time exception:ParseException
).TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateHashModelEx "extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved.WrappingTemplateModel Convenience base-class for containers that wrap their contained arbitrary Java objects intoTemplateModel
instances. -
Classes in freemarker.template used by freemarker.ext.util Class Description ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).TemplateModel 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.xml Class Description TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateMethodModel Deprecated.UseTemplateMethodModelEx
instead.TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved.TemplateNodeModel "node" template language data type: an object that is a node in a tree.TemplateScalarModel "string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.TemplateSequenceModel "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.template Class Description AdapterTemplateModel ATemplateModel
that can be unwrapped and then it considers a provided desired (hint) class.Configuration The main entry point into the FreeMarker API; encapsulates the configuration settings of FreeMarker, also serves as a central template-loading and caching service.DefaultArrayAdapter Adapts anarray
of a non-primitive elements to the correspondingTemplateModel
interface(s), most importantly toTemplateHashModelEx
.DefaultIteratorAdapter Adapts anIterator
to the correspondingTemplateModel
interface(s), most importantly toTemplateCollectionModel
.DefaultListAdapter Adapts aList
to the correspondingTemplateModel
interface(s), most importantly toTemplateSequenceModel
.DefaultMapAdapter Adapts aMap
to the correspondingTemplateModel
interface(s), most importantly toTemplateHashModelEx
.DefaultNonListCollectionAdapter Experimental - subject to change: Adapts a non-List
JavaCollection
to the correspondingTemplateModel
interface(s), most importantly toTemplateCollectionModelEx
.DefaultObjectWrapper The default implementation of theObjectWrapper
interface.DefaultObjectWrapperConfiguration HoldsDefaultObjectWrapper
configuration settings and defines their defaults.LocalizedString An abstract base class for scalars that vary by locale.MalformedTemplateNameException Indicates that the template name given was malformed according theTemplateNameFormat
in use.ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).ObjectWrapperAndUnwrapper Experimental - subject to change: Adds functionality toObjectWrapper
that creates a plain Java object from aTemplateModel
.SimpleHash A simple implementation of theTemplateHashModelEx
interface, using its own underlyingMap
orSortedMap
for storing the hash entries.SimpleScalar A simple implementation of the TemplateScalarModel interface, using a String.SimpleSequence A simple implementation of theTemplateSequenceModel
interface, using its own underlyingList
for storing the list items.Template Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple threads.TemplateBooleanModel "boolean" template language data type; same as in Java; eithertrue
orfalse
.TemplateCollectionModel "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.TemplateCollectionModelEx Experimental - subject to change: "extended collection" template language data type: Adds size/emptiness querybility and "contains" test toTemplateCollectionModel
.TemplateDateModel "date", "time" and "date-time" template language data types: corresponds toDate
.TemplateDirectiveBody Represents the nested content of a directive (TemplateDirectiveModel
) invocation.TemplateException Runtime exception in a template (as opposed to a parsing-time exception:ParseException
).TemplateExceptionHandler Used for thetemplate_exception_handler
configuration setting; seeConfigurable.setTemplateExceptionHandler(TemplateExceptionHandler)
for more.TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateHashModelEx "extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.TemplateMethodModel Deprecated.UseTemplateMethodModelEx
instead.TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved.TemplateModelIterator Used to iterate over a set of template models once; usually returned fromTemplateCollectionModel.iterator()
.TemplateModelWithAPISupport Experimental - subject to change: ATemplateModel
on which the?api
operation can be applied.TemplateNodeModel "node" template language data type: an object that is a node in a tree.TemplateNotFoundException Thrown whenConfiguration.getTemplate(String)
(or similar) doesn't find a template.TemplateNumberModel "number" template language data type; an object that stores a number.TemplateScalarModel "string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.TemplateSequenceModel "sequence" template language data type; an object that contains other objects accessible through an integer 0-based index.Version Represents a version number plus the further qualifiers and build info.WrappingTemplateModel Convenience base-class for containers that wrap their contained arbitrary Java objects intoTemplateModel
instances. -
Classes in freemarker.template used by freemarker.template.utility Class Description ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see theTemplateModel
interfaces).ObjectWrapperAndUnwrapper Experimental - subject to change: Adds functionality toObjectWrapper
that creates a plain Java object from aTemplateModel
.TemplateBooleanModel "boolean" template language data type; same as in Java; eithertrue
orfalse
.TemplateCollectionModel "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.TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).TemplateHashModelEx "extended hash" template language data type; extendsTemplateHashModel
by allowing iterating through its keys and values.TemplateMethodModel Deprecated.UseTemplateMethodModelEx
instead.TemplateMethodModelEx "extended method" template language data type: Objects that act like functions.TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.TemplateModelException TemplateModel
methods throw this exception if the requested data can't be retrieved.TemplateModelIterator Used to iterate over a set of template models once; usually returned fromTemplateCollectionModel.iterator()
.TemplateNumberModel "number" template language data type; an object that stores a number.TemplateScalarModel "string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.TemplateSequenceModel "sequence" template language data type; an object that contains other objects accessible through an integer 0-based index.TemplateTransformModel "transform" template language data type: user-defined directives (much like macros) specialized on filtering output; you should rather use the newerTemplateDirectiveModel
instead.