Package freemarker.template
package freemarker.template
This package contains the core API's that most users will use.
The typical usage pattern is to be vended Template
objects by the 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.
-
ClassDescriptionSupplemental interface that can be implemented by classes that also implement any of the
TemplateModelinterfaces.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.The default implementation of the ObjectWrapper interface.A marker interface that tells the FreeMarker that the method arguments can be lazily evaluated.An abstract base class for scalars that vary by locale.An object that knows how to "wrap" a java object as a TemplateModel instance.An annotation that indicates what the parameters an FTL transform or method can take.A class that visits the AST after the parsing step proper, and makes various checks and adjustments.A concrete implementation ofLocalizedStringthat gets a localized string from aResourceBundleA simple implementation ofTemplateCollectionModel.A simple implementation of the TemplateDateModel interface.Deprecated.Use SimpleSequence instead.A simple implementation of the TemplateNumberModel interface.The default implementation of the ObjectWrapper interface.A simple implementation of the TemplateScalarModel interface, using a String.A convenient implementation of a list.A core FreeMarker API that represents a compiled template.Objects that will be interpreted as true/false in the appropriate context must implement this interface.This interface can be implemented by a class to make a variable "foreach-able", i.e.Date values in a template data model must implement this interface.Represents the body of a directive invocation.Objects that implement this interface can be used as user-defined directives (much like macros).The FreeMarker classes usually use this exception and its descendants to signal FreeMarker specific exceptions.An API for objects that handle exceptions that are thrown during template rendering.Hashes in a data model must implement this interface.An extended hash interface with a couple of extra hooks.Objects that act as methods in a template data model must implement this interface.A subinterface ofTemplateMethodModelthat acts on models, rather than on strings.This is a marker interface that indicates that an object can be put in a template's data model.The type of theTemplateModel.JAVA_NULLobject.Implemented by classes that serve as adapters for template model objects in some other object model.Template model implementation classes should throw this exception if requested data cannot be retrieved.This interface is used to iterate over a set of template models, and is usually returned from an instance ofTemplateCollectionModel.Sequence that wraps ajava.util.Listof already wrapped objects directly, with minimal resource usage.Describes objects that are nodes in a tree.Numeric values in a template data model must implement this interface.String values in a template data model must implement this interface.List values in a template data model whose elements are accessed by the index operator should implement this interface.Deprecated.UseTemplateDirectiveModelinstead.An interface that can be implemented by writers returned fromTemplateTransformModel.getWriter(java.io.Writer, java.util.Map).A base class for containers that wrap arbitrary Java objects intoTemplateModelinstances.