All Classes Interface Summary Class Summary Exception Summary
Class |
Description |
AdapterTemplateModel |
A TemplateModel that can be unwrapped and then it considers a provided desired (hint) class.
|
AllHttpScopesHashModel |
An extension of SimpleHash that looks up keys in the hash, then in the
request, session, and servlet context scopes.
|
ArithmeticEngine |
Class to perform arithmetic operations.
|
ArithmeticEngine.BigDecimalEngine |
This is the default arithmetic engine in FreeMarker.
|
ArithmeticEngine.ConservativeEngine |
An arithmetic engine that conservatively widens the operation arguments
to extent that they can hold the result of the operation.
|
ArrayModel |
|
BeanModel |
A class that will wrap an arbitrary object into TemplateHashModel
interface allowing calls to arbitrary property getters and invocation of
accessible methods on the object from a template using the
object.foo to access properties and object.bar(arg1, arg2) to
invoke methods on it.
|
BeansModelCache |
|
BeansWrapper |
ObjectWrapper that is able to expose the Java API of arbitrary Java objects.
|
BeansWrapper.MethodAppearanceDecision |
|
BeansWrapper.MethodAppearanceDecisionInput |
|
BeansWrapperBuilder |
Gets/creates a BeansWrapper singleton instance that's already configured as specified in the properties of
this object; this is recommended over using the BeansWrapper constructors.
|
BeansWrapperConfiguration |
Holds BeansWrapper configuration settings and defines their defaults.
|
BooleanModel |
|
Breakpoint |
Represents a breakpoint location consisting of a template name and a line number.
|
BugException |
An unexpected state was reached that is certainly caused by a bug in FreeMarker.
|
CacheStorage |
Cache storage abstracts away the storage aspects of a cache - associating
an object with a key, retrieval and removal via the key.
|
CacheStorageWithGetSize |
A cache storage that has a getSize() method for returning the current number of cache entries.
|
CallPlaceCustomDataInitializationException |
|
CaptureOutput |
Deprecated.
|
ClassTemplateLoader |
|
ClassUtil |
|
CollectionModel |
|
Collections12 |
Deprecated.
|
CollectionUtils |
|
CommandLine |
Deprecated.
|
ConcurrentCacheStorage |
An optional interface for cache storage that knows whether it can be
concurrently accessible without synchronization.
|
Configurable |
|
Configurable.SettingValueAssignmentException |
The setting name was recognized, but its value couldn't be parsed or the setting couldn't be set for some
other reason.
|
Configurable.UnknownSettingException |
The setting name was not recognized.
|
Configuration |
The main entry point into the FreeMarker API; encapsulates the configuration settings of FreeMarker,
also serves as a central template-loading and caching service.
|
Constants |
|
CustomAttribute |
|
DateModel |
Wraps arbitrary subclass of Date into a reflective model.
|
DateUtil |
Date and time related utilities.
|
DateUtil.CalendarFieldsToDateConverter |
Used internally by DateUtil ; don't use its implementations for anything else.
|
DateUtil.DateParseException |
|
DateUtil.DateToISO8601CalendarFactory |
Used internally by DateUtil ; don't use its implementations for
anything else.
|
DateUtil.TrivialCalendarFieldsToDateConverter |
Non-thread-safe implementation that hard-references a calendar internally.
|
DateUtil.TrivialDateToISO8601CalendarFactory |
Non-thread-safe factory that hard-references a calendar internally.
|
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.
|
DeepUnwrap |
|
DefaultArrayAdapter |
|
DefaultIteratorAdapter |
|
DefaultListAdapter |
|
DefaultMapAdapter |
|
DefaultNonListCollectionAdapter |
|
DefaultObjectWrapper |
|
DefaultObjectWrapperBuilder |
|
DefaultObjectWrapperConfiguration |
|
DirectiveCallPlace |
Gives information about the place where a directive is called from, also lets you attach a custom data object to that
place.
|
DOMNodeModel |
A convenient wrapper class for wrapping a Node in the W3C DOM API.
|
EnumerationModel |
|
Environment |
Object that represents the runtime environment during template processing.
|
EnvironmentSuspendedEvent |
Event describing a suspension of an environment (ie because it hit a
breakpoint).
|
EventForwarding |
An instance of this class should be registered as a <listener> in
the web.xml descriptor in order to correctly dispatch events to
event listeners that are specified in TLD files.
|
Execute |
Gives FreeMarker the the ability to execute external commands.
|
FileTemplateLoader |
A TemplateLoader that uses files inside a specified directory as the source of templates.
|
FreemarkerServlet |
FreeMarker MVC View servlet that can be used similarly to JSP views.
|
FreemarkerTag |
Simple implementation of JSP tag to allow use of FreeMarker templates in
JSP.
|
FreeMarkerTree |
Deprecated.
|
FreemarkerXmlTask |
Deprecated.
|
HashAdapter |
|
HtmlEscape |
Performs an HTML escape of a given template fragment.
|
HttpRequestHashModel |
TemplateHashModel wrapper for a HttpServletRequest attributes.
|
HttpRequestParametersHashModel |
TemplateHashModel wrapper for a HttpServletRequest parameters.
|
HttpSessionHashModel |
TemplateHashModel wrapper for a HttpSession attributes.
|
IdentityHashMap |
|
IncludePage |
A model that when invoked with a 'path' parameter will perform a servlet
include.
|
InvalidPropertyException |
An exception thrown when there is an attempt to access
an invalid bean property when we are in a "strict bean" mode
|
InvalidReferenceException |
A subclass of TemplateException that says that an FTL expression has evaluated to null or it refers
to something that doesn't exist.
|
IteratorModel |
|
JythonAntTask |
Used internally, public for technical reasons only.
|
JythonHashModel |
|
JythonModel |
Generic model for arbitrary Jython objects.
|
JythonNumberModel |
|
JythonRuntime |
A crude first pass at an embeddable Jython interpreter
|
JythonSequenceModel |
Model for Jython sequence objects ( PySequence descendants).
|
JythonVersionAdapter |
Functions that has a different implementation depending on the Jython version
used.
|
JythonWrapper |
An object wrapper that wraps Jython objects into FreeMarker template models
and vice versa.
|
LocalizedString |
An abstract base class for scalars that vary by locale.
|
Logger |
Delegates logger creation to an actual logging library.
|
MalformedTemplateNameException |
Indicates that the template name given was malformed according the TemplateNameFormat in use.
|
MapModel |
|
MethodAppearanceFineTuner |
|
ModelCache |
Internally used by various wrapper implementations to implement model
caching.
|
ModelFactory |
Interface used to create various wrapper models in the ModelCache .
|
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.
|
NodeListModel |
Deprecated.
|
NodeListModel |
Deprecated.
|
NodeModel |
A base class for wrapping a W3C DOM Node as a FreeMarker template model.
|
NonBooleanException |
|
NonDateException |
Indicates that a TemplateDateModel value was expected, but the value had a different type.
|
NonExtendedHashException |
|
NonHashException |
Indicates that a TemplateHashModel value was expected, but the value had a different type.
|
NonMethodException |
|
NonNodeException |
Indicates that a TemplateNodeModel value was expected, but the value had a different type.
|
NonNumericalException |
|
NonSequenceException |
|
NonSequenceOrCollectionException |
|
NonStringException |
Indicates that a TemplateScalarModel value was expected (or maybe something that can be automatically coerced
to that), but the value had a different type.
|
NormalizeNewlines |
Transformer that supports FreeMarker legacy behavior: all newlines appearing
within the transformed area will be transformed into the platform's default
newline.
|
NullArgumentException |
Indicates that an argument that must be non-null was null .
|
NullCacheStorage |
A cache storage that doesn't store anything.
|
NullWriter |
A Writer that simply drops what it gets.
|
NumberModel |
Wraps arbitrary subclass of Number into a reflective model.
|
NumberUtil |
Number- and math-related utilities.
|
ObjectConstructor |
An object that you can make available in a template
to instantiate arbitrary beans-wrapped objects in a template.
|
ObjectFactory |
Used for the trivial cases of the factory pattern.
|
ObjectWrapper |
Maps Java objects to the type-system of FreeMarker Template Language (see the TemplateModel
interfaces).
|
ObjectWrapperAndUnwrapper |
|
ObjectWrapperWithAPISupport |
Experimental - subject to change: Implemented by ObjectWrapper -s to help TemplateModel -s to
implement the someValue?api operation.
|
OptimizerUtil |
|
OptInTemplateClassResolver |
|
OverloadedMethodsModel |
Wraps a set of same-name overloaded methods behind TemplateMethodModel interface,
like if it was a single method, chooses among them behind the scenes on call-time based on the argument values.
|
ParseException |
Parsing-time exception in a template (as opposed to a runtime exception, a TemplateException ).
|
ResourceBundleLocalizedString |
|
ResourceBundleModel |
A hash model that wraps a resource bundle.
|
RhinoFunctionModel |
|
RhinoScriptableModel |
|
RhinoWrapper |
|
RichObjectWrapper |
Experimental - subject to change: Union of the interfaces that a typical feature rich ObjectWrapper is
expected to implement.
|
SecurityUtilities |
|
ServletContextHashModel |
TemplateHashModel wrapper for a ServletContext attributes.
|
SimpleCollection |
|
SimpleDate |
A simple implementation of the TemplateDateModel
interface.
|
SimpleHash |
|
SimpleList |
Deprecated.
|
SimpleMapModel |
Model used by BeansWrapper when simpleMapWrapper
mode is enabled.
|
SimpleMethodModel |
|
SimpleNumber |
A simple implementation of the TemplateNumberModel
interface.
|
SimpleObjectWrapper |
A restricted object wrapper that will not expose arbitrary object, just those that directly correspond to the
TemplateModel sub-interfaces ( String , Map and such).
|
SimpleScalar |
A simple implementation of the TemplateScalarModel
interface, using a String.
|
SimpleSequence |
|
SingletonCustomizer |
Marker interface useful when used together with MethodAppearanceFineTuner and such customizer objects, to
indicate that it doesn't contain reference to the ObjectWrapper (so beware with non-static inner
classes) and can be and should be used in call introspection cache keys.
|
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.
|
StandardCompress |
A filter that compresses each sequence of consecutive whitespace
to a single line break (if the sequence contains a line break) or a
single space.
|
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.
|
StringModel |
|
StringTemplateLoader |
A TemplateLoader that uses a Map with Strings as its source of
templates.
|
StringUtil |
Some text related utilities.
|
StrongCacheStorage |
Strong cache storage is a cache storage that simply wraps a Map .
|
TaglibFactory |
A hash model associated with a servlet context that can load JSP tag libraries associated with that servlet context.
|
TaglibFactory.ClasspathMetaInfTldSource |
To search TLD-s under META-INF/** /*.tld inside classpath root containers, that is, in directories
and jar-s that are in the classpath (or are visible for the class loader otherwise).
|
TaglibFactory.ClearMetaInfTldSource |
|
TaglibFactory.MetaInfTldSource |
A location within which we will look for META-INF/** /*.tld -s.
|
TaglibFactory.WebInfPerLibJarMetaInfTldSource |
To search TLD-s under sevletContext:/WEB-INF/lib/*.{jar,zip}/META-INF/**/*.tld, as requested by
the JSP specification.
|
Template |
Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from
multiple threads.
|
Template.WrongEncodingException |
Thrown by the Template constructors that specify a non- null encoding whoch doesn't match the
encoding specified in the #ftl header of the template.
|
TemplateBooleanModel |
"boolean" template language data type; same as in Java; either true or false .
|
TemplateCache |
Performs caching and on-demand loading of the templates.
|
TemplateCache.MaybeMissingTemplate |
|
TemplateClassResolver |
Used by built-ins and other template language features that get a class
based on a string.
|
TemplateCollectionModel |
"collection" template language data type: a collection of values that can be enumerated, but can't be or not meant to
be accessed by index or key.
|
TemplateCollectionModelEx |
Experimental - subject to change: "extended collection" template language data type: Adds size/emptiness
querybility and "contains" test to TemplateCollectionModel .
|
TemplateDateModel |
"date", "time" and "date-time" template language data types: corresponds to Date .
|
TemplateDirectiveBody |
|
TemplateDirectiveModel |
"directive" template language data type: used as user-defined directives
(much like macros) in templates.
|
TemplateException |
Runtime exception in a template (as opposed to a parsing-time exception: ParseException ).
|
TemplateExceptionHandler |
|
TemplateHashModel |
"hash" template language data type: an object that contains other objects accessible through string keys
(sub-variable names).
|
TemplateHashModelEx |
"extended hash" template language data type; extends TemplateHashModel by allowing
iterating through its keys and values.
|
TemplateLoader |
FreeMarker loads template "files" through objects that implement this interface,
thus the templates need not be real files, and can come from any kind of data source
(like classpath, servlet context, database, etc).
|
TemplateLookupContext |
|
TemplateLookupResult |
|
TemplateLookupStrategy |
|
TemplateMethodModel |
Deprecated.
|
TemplateMethodModelEx |
"extended method" template language data type: Objects that act like functions.
|
TemplateModel |
The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.
|
TemplateModelAdapter |
Implemented by classes that serve as adapters for template model objects in
some other object model.
|
TemplateModelException |
TemplateModel methods throw this exception if the requested data can't be retrieved.
|
TemplateModelIterator |
|
TemplateModelListSequence |
|
TemplateModelWithAPISupport |
Experimental - subject to change: A TemplateModel on which the ?api operation can be applied.
|
TemplateNameFormat |
Symbolized template name format.
|
TemplateNodeModel |
"node" template language data type: an object that is a node in a tree.
|
TemplateNotFoundException |
|
TemplateNumberModel |
"number" template language data type; an object that stores a number.
|
TemplateScalarModel |
"string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.
|
TemplateSequenceModel |
"sequence" template language data type; an object that contains other objects accessible through an integer 0-based
index.
|
TemplateTransformModel |
"transform" template language data type: user-defined directives
(much like macros) specialized on filtering output; you should rather use the newer TemplateDirectiveModel
instead.
|
ToCanonical |
Deprecated.
|
Transform |
Deprecated.
|
TransformControl |
|
UndeclaredThrowableException |
The equivalent of JDK 1.3 UndeclaredThrowableException.
|
UnexpectedTypeException |
The type of a value differs from what was expected.
|
UnlinkedJythonOperationsImpl |
Used internally, public for technical reasons only.
|
UnrecognizedTimeZoneException |
Indicates that the time zone name is not recognized.
|
UnsupportedNumberClassException |
Thrown when FreeMarker runs into a Number subclass that it doesn't yet support.
|
URLTemplateLoader |
This is an abstract template loader that can load templates whose
location can be described by an URL.
|
Version |
Represents a version number plus the further qualifiers and build info.
|
WebappTemplateLoader |
A TemplateLoader that uses streams reachable through ServletContext.getResource(String) as its source
of templates.
|
WrapperTemplateModel |
A generic interface for template models that wrap some underlying
object, and wish to provide access to that wrapped object.
|
WrappingTemplateModel |
Convenience base-class for containers that wrap their contained arbitrary Java objects into TemplateModel
instances.
|
WriteProtectable |
Implemented by objects that can be made permanently read-only.
|
XmlEscape |
Performs an XML escaping of a given template fragment.
|
XPathSupport |
|