Package freemarker.template

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

See:
          Description

Interface Summary
CacheListener An interface for classes that listen for CacheEvents.
ListenerAdapter An interface for adapters that GenericEventMulticaster can use to fire an event.
TemplateCache An interface for self-updating caches of compiled Templates.
TemplateHashModel Hashes in a template data model must implement this interface.
TemplateListModel List values in a template data model must implement this interface, which is essentially the Iterator interface plus a rewind() method that allows the list to be read again.
TemplateMethodModel Method calls in a template data model must implement this interface.
TemplateModel A template's data model must be a tree of objects, each of which implements a subinterface of TemplateModel.
TemplateModelRoot The root node of a template data model must implement this interface.
TemplateProcessor Objects representing compiled templates must implement this interface.
TemplateScalarModel Scalar values in a template data model must implement this interface.
Updatable An interface for objects that need to be reminded to update themselves from time to time.
 

Class Summary
CacheEvent An event fired by self-updating caches.
FileTemplateCache A TemplateCache that loads templates from a filesystem.
GenericEventMulticaster A generic event multicaster class.
SimpleHash A simple implementation of the TemplateHashModel and TemplateModelRoot interfaces, using a HashMap.
SimpleList A simple implementation of the TemplateListModel interface, using a LinkedList.
SimpleScalar A simple implementation of the TemplateScalarModel interface, using a String.
Template An application or servlet can instantiate a subclass of Template to compile and process an HTML template.
TemplateServletUtils A class containing static utility methods to facilitate using templates with servlets.
UpdateTimer A timer for objects that implement Updatable.
 

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

Package freemarker.template Description

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

The source code for a template is an HTML 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" 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. Click here for notes on the source code.

Version:
1.5.2
Author:
Benjamin Geer, Mike Bayer