Package freemarker.template

Allows Java servlets and applications to generate HTML pages or other text output based on templates, so that graphic design and other presentation details can be kept separate from application logic.

See:
          Description

Interface Summary
TemplateCache An interface for caches that store compiled templates.
TemplateCollectionModel This interface can be implemented to make a variable "foreach-able", i.e.
TemplateHashModel Hashes in a template data model must implement this interface.
TemplateHashModelEx An extended hash interface with a couple of extra hooks.
TemplateListModel Deprecated. This interface is deprecated because it has inherent design problems.
TemplateMethodModel Method calls in a template data model must implement this interface.
TemplateMethodModelEx A subinterface of TemplateMethodModel that acts on models, rather than on strings.
TemplateModel A template's data model must be a tree of objects, each of which implements a subinterface of TemplateModel.
TemplateModelIterator This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel.
TemplateModelRoot The root node of a template data model must implement this interface.
TemplateNumberModel Scalar values in a template data model must implement this interface.
TemplateScalarModel Scalar 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, which essentially has a single interface that returns the i-th element.
TemplateTransformModel Transformations in a template data model must implement this interface.
 

Class Summary
FileTemplateCache A Cache that loads templates from the filesystem or via the Class.getResource() mechanism.
LocaleUtil A holder for some locale-related routines.
NumericalRange A class that represents a Range between two integers.
SimpleHash A simple implementation of the TemplateHashModelEx and TemplateModelRoot interfaces, using an underlying HashMap.
SimpleIterator This is a simple adapter that wraps any java.util.Iterator as a freemarker.template.TemplateModelIterator.
SimpleList Deprecated. Use SimpleSequence instead.
SimpleNumber A simple implementation of the TemplateNumberModel interface.
SimpleScalar A simple implementation of the TemplateScalarModel interface, using a String or a boolean.
SimpleSequence A convenient implementation of a list.
Template An application or servlet can instantiate a subclass of Template to compile and process an HTML template.
 

Exception Summary
TemplateException The FreeMarker classes use this exception internally.
TemplateModelException Template model implementation classes should throw this exception if requested data cannot be retrieved.
 

Package freemarker.template Description

Allows Java servlets and applications to generate HTML pages or other text output based on templates, so that graphic design and other presentation details can be kept separate from application logic.

The source code for a template is an HTML or other text document that contains instructions for including dynamically-generated data. These instructions are simple and unobtrusive (so the graphic designers can still do their work), but powerful enough to let you use data structures of arbitrary complexity. It's easy to generate tables of data, and you can use "if/elseif/else" and "switch" statements to generate conditional HTML.

The Template class compiles a template file into an efficient data structure for later use. A servlet can compile its template(s) in its init() method, then use the Template object(s) to process each request. Processing of compiled templates is very fast.

For complete instructions on how to use this package, please see the manual.