Uses of Package
freemarker.template

Packages that use freemarker.template

Package	Description
freemarker.cache	Contains classes and interfaces that deal with template loading and caching.
freemarker.core	This package contains FreeMarker's core parsing/rendering functionality; most casual users do not need to be aware of the classes in this package, and can restrict their attention to the freemarker.template package.
freemarker.debug
freemarker.ext.beans	Provides model implementations that allow access to arbitrary Java objects.
freemarker.ext.dom
freemarker.ext.jdom	Provides adapter for JDOM including support for writing XML fragments, listing nodes, traversal, copying, and filtering, and a full XPath support.
freemarker.ext.jsp	Classes for two-way FreeMarker-JSP integration.
freemarker.ext.jython	Provides model implementations that allow access to arbitrary Jython objects.
freemarker.ext.rhino	Rhino (ECMAScript) support
freemarker.ext.servlet	Provides a generic purpose servlet that generates dynamic response using FreeMarker.
freemarker.ext.util
freemarker.ext.xml	Provides data model adapter for DOM, dom4j and JDOM; three widely used XML document object models.
freemarker.template	This package contains the core API's that most users will use.
freemarker.template.utility	Utility classes that may be used to customize aspects of FreeMarker.

Classes in freemarker.template used by freemarker.cache

Class and Description
Configuration Main entry point into the FreeMarker API, this class encapsulates the various configuration parameters with which FreeMarker is run, as well as serves as a central template loading and caching point.
Template A core FreeMarker API that represents a compiled template.

Classes in freemarker.template used by freemarker.core

Class and Description
Configuration Main entry point into the FreeMarker API, this class encapsulates the various configuration parameters with which FreeMarker is run, as well as serves as a central template loading and caching point.
ObjectWrapper An object that knows how to "wrap" a java object as a TemplateModel instance.
SimpleHash A simple implementation of the TemplateHashModelEx interface, using an underlying Map or SortedMap.
Template A core FreeMarker API that represents a compiled template.
TemplateCollectionModel This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateDirectiveModel Objects that implement this interface can be used as user-defined directives (much like macros).
TemplateException The FreeMarker classes usually use this exception and its descendants to signal FreeMarker specific exceptions.
TemplateExceptionHandler An API for objects that handle exceptions that are thrown during template rendering.
TemplateHashModel Hashes in a data model must implement this interface.
TemplateHashModelEx An extended hash interface with a couple of extra hooks.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateModelIterator This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel.
TemplateNodeModel Describes objects that are nodes in a tree.
TemplateSequenceModel List values in a template data model whose elements are accessed by the index operator should implement this interface.
WrappingTemplateModel A base class for containers that wrap arbitrary Java objects into TemplateModel instances.

Classes in freemarker.template used by freemarker.debug

Class and Description
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.

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

Class and Description
AdapterTemplateModel Supplemental interface that can be implemented by classes that also implement any of the TemplateModel interfaces.
ObjectWrapper An object that knows how to "wrap" a java object as a TemplateModel instance.
TemplateBooleanModel Objects that will be interpreted as true/false in the appropriate context must implement this interface.
TemplateCollectionModel This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateDateModel Date values in a template data model must implement this interface.
TemplateException The FreeMarker classes usually use this exception and its descendants to signal FreeMarker specific exceptions.
TemplateHashModel Hashes in a data model must implement this interface.
TemplateHashModelEx An extended hash interface with a couple of extra hooks.
TemplateMethodModel Objects that act as methods in a template data model must implement this interface.
TemplateMethodModelEx A subinterface of TemplateMethodModel that acts on models, rather than on strings.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelAdapter Implemented by classes that serve as adapters for template model objects in some other object model.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateModelIterator This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel.
TemplateNumberModel Numeric values in a template data model must implement this interface.
TemplateScalarModel String values in a template data model must implement this interface.
TemplateSequenceModel List values in a template data model whose elements are accessed by the index operator should implement this interface.
WrappingTemplateModel A 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 Supplemental interface that can be implemented by classes that also implement any of the TemplateModel interfaces.
TemplateHashModel Hashes in a data model must implement this interface.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateNodeModel Describes objects that are nodes in a tree.
TemplateSequenceModel List values in a template data model whose elements are accessed by the index operator should implement this interface.

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

Class and Description
TemplateCollectionModel This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateHashModel Hashes in a data model must implement this interface.
TemplateMethodModel Objects that act as methods in a template data model must implement this interface.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateModelIterator This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel.
TemplateScalarModel String values in a template data model must implement this interface.
TemplateSequenceModel List values in a template data model whose elements are accessed by the index operator should implement this interface.

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

Class and Description
TemplateHashModel Hashes in a data model must implement this interface.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.

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

Class and Description
AdapterTemplateModel Supplemental interface that can be implemented by classes that also implement any of the TemplateModel interfaces.
ObjectWrapper An object that knows how to "wrap" a java object as a TemplateModel instance.
TemplateBooleanModel Objects that will be interpreted as true/false in the appropriate context must implement this interface.
TemplateCollectionModel This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateHashModel Hashes in a data model must implement this interface.
TemplateHashModelEx An extended hash interface with a couple of extra hooks.
TemplateMethodModel Objects that act as methods in a template data model must implement this interface.
TemplateMethodModelEx A subinterface of TemplateMethodModel that acts on models, rather than on strings.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateModelIterator This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel.
TemplateNumberModel Numeric values in a template data model must implement this interface.
TemplateScalarModel String values in a template data model must implement this interface.
TemplateSequenceModel List values in a template data model whose elements are accessed by the index operator should implement this interface.

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

Class and Description
AdapterTemplateModel Supplemental interface that can be implemented by classes that also implement any of the TemplateModel interfaces.
ObjectWrapper An object that knows how to "wrap" a java object as a TemplateModel instance.
TemplateBooleanModel Objects that will be interpreted as true/false in the appropriate context must implement this interface.
TemplateCollectionModel This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateHashModel Hashes in a data model must implement this interface.
TemplateHashModelEx An extended hash interface with a couple of extra hooks.
TemplateMethodModel Objects that act as methods in a template data model must implement this interface.
TemplateMethodModelEx A subinterface of TemplateMethodModel that acts on models, rather than on strings.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateNumberModel Numeric values in a template data model must implement this interface.
TemplateScalarModel String values in a template data model must implement this interface.
TemplateSequenceModel List values in a template data model whose elements are accessed by the index operator should implement this interface.

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

Class and Description
Configuration Main entry point into the FreeMarker API, this class encapsulates the various configuration parameters with which FreeMarker is run, as well as serves as a central template loading and caching point.
ObjectWrapper An object that knows how to "wrap" a java object as a TemplateModel instance.
SimpleHash A simple implementation of the TemplateHashModelEx interface, using an underlying Map or SortedMap.
Template A core FreeMarker API that represents a compiled template.
TemplateCollectionModel This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateDirectiveBody Represents the body of a directive invocation.
TemplateDirectiveModel Objects that implement this interface can be used as user-defined directives (much like macros).
TemplateException The FreeMarker classes usually use this exception and its descendants to signal FreeMarker specific exceptions.
TemplateHashModel Hashes in a data model must implement this interface.
TemplateHashModelEx An extended hash interface with a couple of extra hooks.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.
WrappingTemplateModel A 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 An object that knows how to "wrap" a java object as a TemplateModel instance.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.

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

Class and Description
TemplateNodeModel Describes objects that are nodes in a tree.

Classes in freemarker.template used by freemarker.template

Class and Description
Configuration Main entry point into the FreeMarker API, this class encapsulates the various configuration parameters with which FreeMarker is run, as well as serves as a central template loading and caching point.
DefaultObjectWrapper The default implementation of the ObjectWrapper interface.
EmptyMap
LocalizedString An abstract base class for scalars that vary by locale.
ObjectWrapper An object that knows how to "wrap" a java object as a TemplateModel instance.
SimpleHash A simple implementation of the TemplateHashModelEx interface, using an underlying Map or SortedMap.
SimpleSequence A convenient implementation of a list.
Template A core FreeMarker API that represents a compiled template.
TemplateBooleanModel Objects that will be interpreted as true/false in the appropriate context must implement this interface.
TemplateCollectionModel This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateDateModel Date values in a template data model must implement this interface.
TemplateDirectiveBody Represents the body of a directive invocation.
TemplateException The FreeMarker classes usually use this exception and its descendants to signal FreeMarker specific exceptions.
TemplateExceptionHandler An API for objects that handle exceptions that are thrown during template rendering.
TemplateHashModel Hashes in a data model must implement this interface.
TemplateHashModelEx An extended hash interface with a couple of extra hooks.
TemplateMethodModel Objects that act as methods in a template data model must implement this interface.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateModelIterator This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel.
TemplateNodeModel Describes objects that are nodes in a tree.
TemplateNumberModel Numeric values in a template data model must implement this interface.
TemplateScalarModel String values in a template data model must implement this interface.
TemplateSequenceModel List values in a template data model whose elements are accessed by the index operator should implement this interface.
WrappingTemplateModel A 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 Objects that will be interpreted as true/false in the appropriate context must implement this interface.
TemplateCollectionModel This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateHashModel Hashes in a data model must implement this interface.
TemplateHashModelEx An extended hash interface with a couple of extra hooks.
TemplateMethodModel Objects that act as methods in a template data model must implement this interface.
TemplateMethodModelEx A subinterface of TemplateMethodModel that acts on models, rather than on strings.
TemplateModel This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateModelIterator This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel.
TemplateNumberModel Numeric values in a template data model must implement this interface.
TemplateScalarModel String values in a template data model must implement this interface.
TemplateSequenceModel List values in a template data model whose elements are accessed by the index operator should implement this interface.
TemplateTransformModel Objects that implement this interface can be used as user-defined directives (much like macros); you should rather use the newer TemplateDirectiveModel instead.