| freemarker.template.utility | Utility classes that may be used to customize aspects of FreeMarker. |
| AdapterTemplateModel | Supplemental interface that can be implemented by classes that also implement any of the TemplateModel interfaces. | code | html |
| ObjectWrapper | An object that knows how to "wrap" a java object as a TemplateModel instance. |
code | html |
| TemplateBooleanModel | Objects that will be interpreted as true/false in the appropriate context must implement this interface. | code | html |
| TemplateCollectionModel | This interface can be implemented by a class to make a variable "foreach-able", i.e. | code | html |
| TemplateDateModel | Date values in a template data model must implement this interface. | code | html |
| TemplateDirectiveBody | Represents the body of a directive invocation. | code | html |
| TemplateDirectiveModel | Objects that implement this interface can be used as user-defined directives (much like macros). | code | html |
| TemplateExceptionHandler | An API for objects that handle exceptions that are thrown during template rendering. | code | html |
| TemplateHashModel | Hashes in a data model must implement this interface. | code | html |
| TemplateHashModelEx | An extended hash interface with a couple of extra hooks. |
code | html |
| TemplateMethodModel | Objects that act as methods in a template data model must implement this interface. | code | html |
| TemplateMethodModelEx | A subinterface of TemplateMethodModel that acts on models, rather than on strings. | code | html |
| TemplateModel | This is a marker interface that indicates that an object can be put in a template's data model. |
code | html |
| TemplateModelAdapter | Implemented by classes that serve as adapters for template model objects in some other object model. | code | html |
| TemplateModelIterator | This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel . | code | html |
| TemplateNodeModel | Describes objects that are nodes in a tree. | code | html |
| TemplateNumberModel | Numeric values in a template data model must implement this interface. | code | html |
| TemplateScalarModel | String values in a template data model must implement this interface. | code | html |
| TemplateSequenceModel | List values in a template data model whose elements are accessed by the index operator should implement this interface. | code | html |
| TemplateTransformModel | Objects that implement this interface can be used as user-defined directives (much like macros); you should rather use the newer TemplateDirectiveModel instead. | code | html |
| TransformControl | An interface that can be implemented by writers returned from TemplateTransformModel#getWriter(java.io.Writer, java.util.Map) . | code | html |
| LocalizedString | An abstract base class for scalars that vary by locale. | code | html |
| WrappingTemplateModel | A base class for containers that wrap arbitrary Java objects into TemplateModel instances. | code | html |
| 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. | code | html |
| DefaultObjectWrapper | The default implementation of the ObjectWrapper interface. |
code | html |
| EmptyMap | code | html | |
| GeneralPurposeNothing | Singleton object representing nothing, used by ?if_exists built-in. | code | html |
| ResourceBundleLocalizedString | A concrete implementation of LocalizedString that gets a localized string from a java.util.ResourceBundle | code | html |
| SettingStringParser | Helper class for parsing setting values given with string. | code | html |
| SimpleCollection | A simple implementation of TemplateCollectionModel . | code | html |
| SimpleCollection.SimpleTemplateModelIterator | code | html | |
| SimpleDate | A simple implementation of the TemplateDateModel interface. | code | html |
| SimpleHash | A simple implementation of the TemplateHashModelEx interface, using an underlying Map or SortedMap . This class is thread-safe if you don't call the put or remove methods after you have made the object available for multiple threads. |
code | html |
| SimpleHash.SynchronizedHash | code | html | |
| SimpleList | This is a trivial subclass that exists for backward compatibility with the SimpleList from FreeMarker Classic. | code | html |
| SimpleNumber | A simple implementation of the TemplateNumberModel interface. | code | html |
| SimpleObjectWrapper | The default implementation of the ObjectWrapper interface. |
code | html |
| SimpleScalar | A simple implementation of the TemplateScalarModel interface, using a String. | code | html |
| SimpleSequence | A convenient implementation of a list. |
code | html |
| SimpleSequence.SynchronizedSequence | code | html | |
| Template | A core FreeMarker API that represents a compiled template. |
code | html |
| Template.LineTableBuilder | This is a helper class that builds up the line table info for us. | code | html |
| Template.WrongEncodingException | code | html | |
| TemplateException | The FreeMarker classes usually use this exception and its descendants to signal FreeMarker specific exceptions. | code | html |
| TemplateModelException | Template model implementation classes should throw this exception if requested data cannot be retrieved. | code | html |
| TemplateModelListSequence | Sequence that wraps a java.util.List of already wrapped objects
directly, with minimal resource usage. |
code | html |
This package contains the core API's that most users will use.
The typical usage pattern is to be vended freemarker.template.Template objects by the freemarker.template.Configuration object. The Template class represents a template file compiled into an efficient data structure for later use. Processing of compiled templates is very fast.
For complete instructions on how to use this package, please see the manual.