All Classes

Class	Description
AbstractScope	An abstract scope with no variable storage mechanism of its own; only provides enclosing scope and operations related to enclosing scope.
AdapterTemplateModel	Supplemental interface that can be implemented by classes that also implement any of the TemplateModel interfaces.
BaseScope	A basic scope that stores variables locally in a hash map.
BlockScope
BreakException	An exception used to break out of a loop
Breakpoint	Represents a breakpoint location consisting of a template name and a line number.
CacheStorage	Cache storage abstracts away the storage aspects of a cache - associating an object with a key, retrieval and removal via the key.
ClassTemplateLoader	A TemplateLoader that uses streams reachable through Class.getResourceAsStream(String) as its source of templates.
CommandLine	FreeMarker command-line utility, the Main-Class of freemarker.jar.
ConcurrentCacheStorage	An optional interface for cache storage that knows whether it can be concurrently accessible without synchronization.
Configurable	This is a common superclass of Configuration, Template, and Environment classes.
Configurable.UnknownSettingException
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.
CustomAttribute	A class that allows one to associate custom data with a configuration, a template, or environment.
DebuggedEnvironment	Represents the debugger-side mirror of a debugged Environment object in the remote VM.
Debugger	The main debugger interface.
DebuggerClient	A utility class that allows you to connect to the FreeMarker debugger service running on a specific host and port.
DebuggerListener	An interface for components that wish to receive debugging events.
DebugModel	Represents the debugger-side mirror of a TemplateModel object, a Template object, or a Configuration object.
DefaultObjectWrapper	The default implementation of the ObjectWrapper interface.
Environment	Object that represents the runtime environment during template processing.
EnvironmentSuspendedEvent	Event describing a suspension of an environment (ie because it hit a breakpoint).
FileTemplateLoader	A TemplateLoader that uses files in a specified directory as the source of templates.
FreeMarkerPermission	A class representing all FreeMarker-related permissions.
IncludedTemplateNamespace	This class is used for the scope of an included template.
InvalidReferenceException	A subclass of TemplateException that says there is no value associated with a given expression.
LazilyEvaluatableArguments	A marker interface that tells the FreeMarker that the method arguments can be lazily evaluated.
LocalizedString	An abstract base class for scalars that vary by locale.
Logger	The FreeMarker logging facility.
LoopContext	Represents the local context of an iterator block
MacroContext	Represents the context or scope of the execution of an FTL macro.
MacroInvocationBodyContext	Represents the context or scope when a macro executes the body of a macro invocation via [#nested]
MruCacheStorage	A cache storage that implements a two-level Most Recently Used cache.
MultiTemplateLoader	A TemplateLoader that uses a set of other loaders to load the templates.
ObjectWrapper	An object that knows how to "wrap" a java object as a TemplateModel instance.
Parameters	An annotation that indicates what the parameters an FTL transform or method can take.
ParserTestCase	Test case for parser.
PerformanceTest	This class executes a FreeMarker template repeatedly in an endless loop.
PostParseVisitor	A class that visits the AST after the parsing step proper, and makes various checks and adjustments.
ResourceBundleLocalizedString	A concrete implementation of LocalizedString that gets a localized string from a ResourceBundle
ReturnException	An exception used to jump out of a macro or function
Scope	Represents a variable resolution context in FTL.
SecureRenderer
SecureRendererImpl
SecureTemplateLoader	A template loader that is able to provide a code source for the template.
SimpleCollection	A simple implementation of TemplateCollectionModel.
SimpleDate	A simple implementation of the TemplateDateModel interface.
SimpleHash	A simple implementation of the TemplateHashModelEx interface, using an underlying Map or SortedMap.
SimpleList	Deprecated. Use SimpleSequence instead.
SimpleNumber	A simple implementation of the TemplateNumberModel interface.
SimpleObjectWrapper	The default implementation of the ObjectWrapper interface.
SimpleScalar	A simple implementation of the TemplateScalarModel interface, using a String.
SimpleSequence	A convenient implementation of a list.
SLF4JLoggerFactory
SoftCacheStorage	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.
StatefulTemplateLoader	Interface that can be implemented by template loaders that maintain some sort of internal state (i.e.
StopException	This exception is thrown when a <stop> directive is encountered.
StringTemplateLoader	A TemplateLoader that uses a Map with Strings as its source of templates.
StrongCacheStorage	Strong cache storage is a cache storage that simply wraps a Map.
Template	A core FreeMarker API that represents a compiled template.
Template.WrongEncodingException
TemplateBooleanModel	Objects that will be interpreted as true/false in the appropriate context must implement this interface.
TemplateCache	A class that performs caching and on-demand loading of the templates.
TemplateCacheTest
TemplateCollectionModel	This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateCore	Abstract base class for Template.
TemplateDateModel	Date values in a template data model must implement this interface.
TemplateDirectiveBody	Represents the body of a directive invocation.
TemplateDirectiveModel	Objects that implement this interface can be used as user-defined directives (much like macros).
TemplateException	The FreeMarker classes usually use this exception and its descendants to signal FreeMarker specific exceptions.
TemplateExceptionHandler	An API for objects that handle exceptions that are thrown during template rendering.
TemplateHashModel	Hashes in a data model must implement this interface.
TemplateHashModelEx	An extended hash interface with a couple of extra hooks.
TemplateLoader	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.
TemplateMethodModel	Objects that act as methods in a template data model must implement this interface.
TemplateMethodModelEx	A subinterface of TemplateMethodModel that acts on models, rather than on strings.
TemplateModel	This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModel.InvalidExpressionModel
TemplateModel.JavaNull	The type of the TemplateModel.JAVA_NULL object.
TemplateModelAdapter	Implemented by classes that serve as adapters for template model objects in some other object model.
TemplateModelException	Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateModelIterator	This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel.
TemplateModelListSequence	Sequence that wraps a java.util.List of already wrapped objects directly, with minimal resource usage.
TemplateNamespace	Represents the namespace associated with a template
TemplateNodeModel	Describes objects that are nodes in a tree.
TemplateNumberModel	Numeric values in a template data model must implement this interface.
TemplateRunnable<T>
TemplateScalarModel	String 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.
TemplateTestCase
TemplateTestCase.TestBean
TemplateTestSuite	Test suite for FreeMarker.
TemplateTransformModel	Deprecated. Use TemplateDirectiveModel instead.
TransformControl	An interface that can be implemented by writers returned from TemplateTransformModel.getWriter(java.io.Writer, java.util.Map).
UndeclaredVariableException	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.
URLTemplateLoader	This is an abstract template loader that can load templates whose location can be described by an URL.
WebappTemplateLoader	A TemplateLoader that uses streams reachable through ServletContext.getResource(String) as its source of templates.
WhitespaceAdjuster
WrappingTemplateModel	A base class for containers that wrap arbitrary Java objects into TemplateModel instances.