All Classes and Interfaces
Class
Description
An abstract scope with no variable storage mechanism of its own; only
provides enclosing scope and operations related to enclosing scope.
Supplemental interface that can be implemented by classes that also implement
any of the
TemplateModel interfaces.A basic scope that stores variables locally in a hash map.
An exception used to break out of a loop
Represents a breakpoint location consisting of a template name and a line number.
Cache storage abstracts away the storage aspects of a cache - associating
an object with a key, retrieval and removal via the key.
A
TemplateLoader that uses streams reachable through
Class.getResourceAsStream(String) as its source of templates.FreeMarker command-line utility, the Main-Class of freemarker.jar.
An optional interface for cache storage that knows whether it can be
concurrently accessible without synchronization.
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.
A class that allows one to associate custom data with a configuration,
a template, or environment.
Represents the debugger-side mirror of a debugged
Environment object in the remote VM.The main debugger interface.
A utility class that allows you to connect to the FreeMarker debugger service
running on a specific host and port.
An interface for components that wish to receive debugging events.
Represents the debugger-side mirror of a TemplateModel object, a Template
object, or a Configuration object.
The default implementation of the ObjectWrapper
interface.
Object that represents the runtime environment during template processing.
Event describing a suspension of an environment (ie because it hit a
breakpoint).
A
TemplateLoader that uses files in a specified directory as the
source of templates.A class representing all FreeMarker-related permissions.
This class is used for the scope of an included template.
A subclass of TemplateException that says there
is no value associated with a given expression.
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.
The FreeMarker logging facility.
Represents the local context of an iterator block
Represents the context or scope of the
execution of an FTL macro.
Represents the context or scope when a macro executes
the body of a macro invocation via [#nested]
A cache storage that implements a two-level Most Recently Used cache.
A
TemplateLoader that uses a set of other loaders to load the templates.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.
Test case for parser.
This class executes a FreeMarker template repeatedly in an endless loop.
A class that visits the AST after the parsing step proper,
and makes various checks and adjustments.
A concrete implementation of
LocalizedString that gets
a localized string from a ResourceBundleAn exception used to jump out of a macro or function
Represents a variable resolution context in FTL.
A template loader that is able to provide a code source for the template.
A simple implementation of
TemplateCollectionModel.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.
Soft cache storage is a cache storage that uses
SoftReference
objects to hold the objects it was passed, therefore allows the garbage
collector to purge the cache when it determines that it wants to free up
memory.Interface that can be implemented by template loaders that maintain some
sort of internal state (i.e.
This exception is thrown when a <stop>
directive is encountered.
A
TemplateLoader that uses a Map with Strings as its source of
templates.Strong cache storage is a cache storage that simply wraps a
Map.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.
A class that performs caching and on-demand loading of the templates.
This interface can be implemented by a class to make a variable "foreach-able",
i.e.
Abstract base class for
Template.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.
A template loader is an object that can find the source stream for a
template, can retrieve its time of last modification as well as the stream
itself.
Objects that act as methods in a template data model must implement this
interface.
A subinterface of
TemplateMethodModel that 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 the
TemplateModel.JAVA_NULL object.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 of
TemplateCollectionModel.Sequence that wraps a
java.util.List of already wrapped objects
directly, with minimal resource usage.Represents the namespace associated with a template
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.
Test suite for FreeMarker.
Deprecated.
Use
TemplateDirectiveModel instead.An interface that can be implemented by writers returned from
TemplateTransformModel.getWriter(java.io.Writer, java.util.Map).This exception is thrown when a set directive in the template
tries to set a variable which is not declared in that scope or
an enclosing one.
This is an abstract template loader that can load templates whose
location can be described by an URL.
A
TemplateLoader that uses streams reachable through
ServletContext.getResource(String) as its source of templates.A base class for containers that wrap arbitrary Java objects into
TemplateModel instances.