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 to freemarker.template.
freemarker.debug	Debugging API; experimental status, might change!
freemarker.ext.beans	The default 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 alternative ObjectWrapper.
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 by freemarker.ext but might be useful outside it too.
freemarker.ext.xml	Deprecated, use W3C DOM with freemarker.ext.dom instead; Exposes XML from DOM, dom4j or JDOM nodes, uniformly.
freemarker.template	The fundamental, most commonly used API-s of FreeMarker; start with Configuration (also see 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 and 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 and 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 the TemplateModel interfaces).
SimpleHash A simple implementation of the TemplateHashModelEx interface, using an underlying Map or SortedMap.
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 the template_exception_handler configuration setting; see Configurable.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; extends TemplateHashModel by allowing iterating through its keys and values.
TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language 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.
WrappingTemplateModel Convenience base-class for containers that wrap arbitrary Java objects into TemplateModel instances.

Classes in freemarker.template used by freemarker.debug

Class and 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 and Description
AdapterTemplateModel A TemplateModel 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 the TemplateModel interfaces).
TemplateBooleanModel "boolean" template language data type; same as in Java; either true or false.
TemplateCollectionModel "collection" template language data type: a collection of values that can be enumerated, repeatedly (not just once).
TemplateDateModel "date" template language data type: similar to Date; a time-zone-independent date-only, time-only or date-time value.
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; extends TemplateHashModel by allowing iterating through its keys and values.
TemplateMethodModel Deprecated. Use TemplateMethodModelEx instead. This interface is from the old times when the only kind of value you could pass in was string.
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 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 from TemplateCollectionModel.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.
WrappingTemplateModel Convenience base-class for containers that wrap arbitrary Java objects into TemplateModel instances.

Classes in freemarker.template used by freemarker.ext.dom

Class and Description
AdapterTemplateModel A TemplateModel 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 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 and Description
TemplateCollectionModel "collection" template language data type: a collection of values that can be enumerated, repeatedly (not just once).
TemplateHashModel "hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).
TemplateMethodModel Deprecated. Use TemplateMethodModelEx instead. This interface is from the old times when the only kind of value you could pass in was string.
TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language 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 from TemplateCollectionModel.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 and Description
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 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 and Description
AdapterTemplateModel A TemplateModel 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 the TemplateModel interfaces).
TemplateBooleanModel "boolean" template language data type; same as in Java; either true or false.
TemplateCollectionModel "collection" template language data type: a collection of values that can be enumerated, repeatedly (not just once).
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; extends TemplateHashModel by allowing iterating through its keys and values.
TemplateMethodModel Deprecated. Use TemplateMethodModelEx instead. This interface is from the old times when the only kind of value you could pass in was string.
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 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 from TemplateCollectionModel.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 and Description
AdapterTemplateModel A TemplateModel 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 the TemplateModel interfaces).
TemplateBooleanModel "boolean" template language data type; same as in Java; either true or false.
TemplateCollectionModel "collection" template language data type: a collection of values that can be enumerated, repeatedly (not just once).
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; extends TemplateHashModel by allowing iterating through its keys and values.
TemplateMethodModel Deprecated. Use TemplateMethodModelEx instead. This interface is from the old times when the only kind of value you could pass in was string.
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 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 and 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 the TemplateModel interfaces).
SimpleHash A simple implementation of the TemplateHashModelEx interface, using an underlying Map or SortedMap.
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, repeatedly (not just once).
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; extends TemplateHashModel by allowing iterating through its keys and values.
TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language data types.
TemplateModelException TemplateModel methods throw this exception if the requested data can't be retrieved.
WrappingTemplateModel Convenience base-class for containers that wrap arbitrary Java objects into TemplateModel instances.

Classes in freemarker.template used by freemarker.ext.util

Class and Description
ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see the TemplateModel interfaces).
TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language data types.

Classes in freemarker.template used by freemarker.ext.xml

Class and Description
TemplateNodeModel "node" template language data type: an object that is a node in a tree.

Classes in freemarker.template used by freemarker.template

Class and 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.
DefaultObjectWrapper The default implementation of the ObjectWrapper interface.
LocalizedString An abstract base class for scalars that vary by locale.
ObjectWrapper Maps Java objects to the type-system of FreeMarker Template Language (see the TemplateModel interfaces).
SimpleHash A simple implementation of the TemplateHashModelEx interface, using an underlying Map or SortedMap.
SimpleSequence A convenient implementation of a list.
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; either true or false.
TemplateCollectionModel "collection" template language data type: a collection of values that can be enumerated, repeatedly (not just once).
TemplateDateModel "date" template language data type: similar to Date; a time-zone-independent date-only, time-only or date-time value.
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 the template_exception_handler configuration setting; see Configurable.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; extends TemplateHashModel by allowing iterating through its keys and values.
TemplateMethodModel Deprecated. Use TemplateMethodModelEx instead. This interface is from the old times when the only kind of value you could pass in was string.
TemplateModel The common super-interface of the interfaces that stand for the FreeMarker Template Language 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 from TemplateCollectionModel.iterator().
TemplateNodeModel "node" template language data type: an object that is a node in a tree.
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 into.
WrappingTemplateModel Convenience base-class for containers that wrap arbitrary Java objects into TemplateModel instances.

Classes in freemarker.template used by freemarker.template.utility

Class and Description
TemplateBooleanModel "boolean" template language data type; same as in Java; either true or false.
TemplateCollectionModel "collection" template language data type: a collection of values that can be enumerated, repeatedly (not just once).
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; extends TemplateHashModel by allowing iterating through its keys and values.
TemplateMethodModel Deprecated. Use TemplateMethodModelEx instead. This interface is from the old times when the only kind of value you could pass in was string.
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 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 from TemplateCollectionModel.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 newer TemplateDirectiveModel instead.