All Classes (FreeMarker 2.3.35 API)
Description: class index

# All Classes

Class
Description
AbstractJSONLikeFormat
Defines the methods in `CFormat` that are the same for all JSON-like languages.
AdapterTemplateModel
A `TemplateModel` that can be unwrapped and then it considers a provided desired (hint) class.
AliasTemplateDateFormatFactory
Creates an alias to another format, so that the format can be referred to with a simple name in the template, rather than as a concrete pattern or other kind of format string.
AliasTemplateNumberFormatFactory
Creates an alias to another format, so that the format can be referred to with a simple name in the template, rather than as a concrete pattern or other kind of format string.
AllHttpScopesHashModel
An extension of SimpleHash that looks up keys in the hash, then in the request, session, and servlet context scopes.
AllHttpScopesHashModel
An extension of SimpleHash that looks up keys in the hash, then in the request, session, and servlet context scopes.
AndMatcher
Logical "and" operation among the given matchers.
ArithmeticEngine
Used for implementing the arithmetic operations and number comparisons in the template language.
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
A class that will wrap an arbitrary array into `TemplateCollectionModel` and `TemplateSequenceModel` interfaces.
AttemptExceptionReporter
Used for the `attempt_exception_reported` configuration setting.
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
Used for `MethodAppearanceFineTuner.process(freemarker.ext.beans.BeansWrapper.MethodAppearanceDecisionInput, freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision)` to store the results; see there.
BeansWrapper.MethodAppearanceDecisionInput
Used for `MethodAppearanceFineTuner.process(freemarker.ext.beans.BeansWrapper.MethodAppearanceDecisionInput, freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision)` as input parameter; see there.
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.
BlacklistMemberAccessPolicy
Blacklist-based member access policy, that is, members that are matched by the listing will not be accessible, all others will be.
BooleanModel
A class that will wrap instances of `Boolean` into a `TemplateBooleanModel`.
BugException
An unexpected state was reached that is certainly caused by a bug in FreeMarker.
BuiltInForNodeEx
ByteArrayTemplateLoader
A `TemplateLoader` that uses a `Map` with `byte[]` as its source of templates.
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
Thrown by `DirectiveCallPlace.getOrCreateCustomData(Object, freemarker.template.utility.ObjectFactory)`
CaptureOutput
Deprecated.
Use block-assignments instead, like `<assign x>...</assign>`.
CFormat
Defines a format (usually a computer language) that's used by the `c`, `cn` built-ins, and for the `"c"` and `"computer"` `number_format`, and the `"c"` `boolean_format`.
ClassMemberAccessPolicy
Returned by `MemberAccessPolicy.forClass(Class)`.
ClassTemplateLoader
A `TemplateLoader` that can load templates from the "classpath".
ClassUtil
CollectionModel
A special case of `BeanModel` that can wrap Java collections and that implements the `TemplateCollectionModel` in order to be usable in a `<#list>` block.
Collections12
Deprecated.
Not needed anymore, as FreeMarker now requires higher than Java 1.3
CollectionUtils
CombinedMarkupOutputFormat
Represents two markup formats nested into each other.
CommonMarkupOutputFormat<MO extends CommonTemplateMarkupOutputModel>
Common superclass for implementing `MarkupOutputFormat`-s that use a `CommonTemplateMarkupOutputModel` subclass.
CommonTemplateMarkupOutputModel<MO extends CommonTemplateMarkupOutputModel<MO>>
Common superclass for implementing `TemplateMarkupOutputModel`-s that belong to a `CommonMarkupOutputFormat` subclass format.
ConcurrentCacheStorage
An optional interface for cache storage that knows whether it can be concurrently accessible without synchronization.
ConditionalTemplateConfigurationFactory
Returns the given `TemplateConfiguration` directly, or another `TemplateConfigurationFactory`'s result, when the specified matcher matches the template source.
Configurable
This is a common superclass of `Configuration`, `Template`, and `Environment` classes.
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
Frequently used constant `TemplateModel` values.
CSSOutputFormat
Represents the CSS output format (MIME type "text/css", name "CSS").
CustomAttribute
A class that allows one to associate custom data with a `Configuration`, a `Template`, or `Environment`.
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.
DeepUnwrap
Utility methods for unwrapping `TemplateModel`-s.
DefaultArrayAdapter
Adapts an `array` of a non-primitive elements to the corresponding `TemplateModel` interface(s), most importantly to `TemplateHashModelEx`.
DefaultEnumerationAdapter
Adapts an `Enumeration` to the corresponding `TemplateModel` interface(s), most importantly to `TemplateCollectionModel`.
DefaultIterableAdapter
Adapts an `Iterable` to the corresponding `TemplateModel` interface(s), most importantly to `TemplateCollectionModel`.
DefaultIteratorAdapter
Adapts an `Iterator` to the corresponding `TemplateModel` interface(s), most importantly to `TemplateCollectionModel`.
DefaultListAdapter
Adapts a `List` to the corresponding `TemplateModel` interface(s), most importantly to `TemplateSequenceModel`.
DefaultMapAdapter
Adapts a `Map` to the corresponding `TemplateModel` interface(s), most importantly to `TemplateHashModelEx`.
DefaultMemberAccessPolicy
Member access policy to implement the default behavior that's mostly compatible with pre-2.3.30 versions, but is somewhat safer; it still can't provide safety in practice, if you allow untrusted users to edit templates! Use `WhitelistMemberAccessPolicy` if you need stricter control.
DefaultNonListCollectionAdapter
Adapts a non-`List` Java `Collection` to the corresponding `TemplateModel` interface(s), most importantly to `TemplateCollectionModelEx`.
DefaultObjectWrapper
The default implementation of the `ObjectWrapper` interface.
DefaultObjectWrapperBuilder
Gets/creates a `DefaultObjectWrapper` singleton instance that's already configured as specified in the properties of this object; this is recommended over using the `DefaultObjectWrapper` constructors.
DefaultObjectWrapperConfiguration
Holds `DefaultObjectWrapper` configuration settings and defines their defaults.
DefaultTruncateBuiltinAlgorithm
The default `TruncateBuiltinAlgorithm` implementation; see `Configurable.setTruncateBuiltinAlgorithm(TruncateBuiltinAlgorithm)`.
DirectiveCallPlace
Gives information about the place where a directive is called from, also lets you attach a custom data object to that place.
DOMNodeModel
Deprecated.
Use `NodeModel` instead
EnumerationModel
A class that adds `TemplateModelIterator` functionality to the `Enumeration` interface implementers.
Environment
Object that represents the runtime environment during template processing.
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.
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.
FileExtensionMatcher
Matches the file extension; unlike other matchers, by default case insensitive.
FileNameGlobMatcher
As opposed to `PathGlobMatcher`, it only compares the "file name" part (the part after the last `/`) of the source name with the given glob.
FileTemplateLoader
A `TemplateLoader` that uses files inside a specified directory as the source of templates.
FirstMatchTemplateConfigurationFactory
Returns the first non-`null` result of the child factories, ignoring all further child factories.
FreemarkerServlet
FreeMarker MVC View servlet that can be used similarly to JSP views.
FreemarkerServlet
FreeMarker MVC View servlet that can be used similarly to JSP views.
FreemarkerTag
Deprecated.
This feature is not supported anymore, also, it uses the deprecated default `Configuration`.
FreemarkerTag
Deprecated.
This feature is not supported anymore, also, it uses the deprecated default `Configuration`.
FreeMarkerTree
Deprecated.
Will be removed, as Swing classes aren't accessible on Google App Engine.
FreemarkerXmlTask
Deprecated.
FMPP is a more complete solution.
GenericObjectModel
This is used for wrapping objects that has no special treatment (unlike `Map`-s, `Collection`-s, `Number`-s, `Boolean`-s, and some more, which have), hence they are just "generic" Java objects.
HashAdapter
HtmlEscape
Performs an HTML escape of a given template fragment.
HTMLOutputFormat
Represents the HTML output format (MIME type "text/html", name "HTML").
HttpRequestHashModel
TemplateHashModel wrapper for a HttpServletRequest attributes.
HttpRequestHashModel
TemplateHashModel wrapper for a HttpServletRequest attributes.
HttpRequestParametersHashModel
TemplateHashModel wrapper for a HttpServletRequest parameters.
HttpRequestParametersHashModel
TemplateHashModel wrapper for a HttpServletRequest parameters.
HttpSessionHashModel
TemplateHashModel wrapper for a HttpSession attributes.
HttpSessionHashModel
TemplateHashModel wrapper for a HttpSession attributes.
IdentityHashMap
Deprecated.
Use `IdentityHashMap` instead.
IncludePage
A model that when invoked with a 'path' parameter will perform a servlet include.
IncludePage
A model that when invoked with a 'path' parameter will perform a servlet include.
InvalidFormatParametersException
Used when creating `TemplateDateFormat`-s and `TemplateNumberFormat`-s to indicate that the parameters part of the format string (like some kind of pattern) is malformed.
InvalidFormatStringException
Used when creating `TemplateDateFormat`-s and `TemplateNumberFormat`-s to indicate that the format string (like the value of the `dateFormat` setting) is malformed.
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
A class that adds `TemplateModelIterator` functionality to the `Iterator` interface implementers.
JavaCFormat
"Java" `CFormat`.
JavaScriptCFormat
"JavaScript" `CFormat`, to be used when generating JavaScript (and not JSON), except, in most cases `JavaScriptOrJSONCFormat` is recommended over this.
JavaScriptOrJSONCFormat
"JavaScript or JSON" `CFormat`; for generating output that's compatible with both JSON and JavaScript.
JavaScriptOutputFormat
Represents the JavaScript output format (MIME type "application/javascript", name "JavaScript").
JSONCFormat
"JSON" `CFormat`; to be used when generating JSON (and not JavaScript), except, in most cases `JavaScriptOrJSONCFormat` is recommended over this.
JSONOutputFormat
Represents the JSON output format (MIME type "application/json", name "JSON").
JythonAntTask
Used internally, public for technical reasons only.
JythonHashModel
Model for Jython dictionaries (`PyDictionary` and `PyStringMap`).
JythonModel
Generic model for arbitrary Jython objects.
JythonNumberModel
Model for Jython numeric objects (`PyInteger`, `PyLong`, `PyFloat`).
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.
LegacyCFormat
Corresponds to the behavior of `?c` before 2.3.32 (when there were no `CFormat`-s yet).
LegacyDefaultMemberAccessPolicy
Legacy blacklist based member access policy, used only to keep old behavior, as it can't provide meaningful safety.
LocalizedString
An abstract base class for scalars that vary by locale.
Logger
Delegates logger creation to an actual logging library (this was written before SLF4J, or even Apache Commons Logging was widespread).
MalformedTemplateNameException
Indicates that the template name given was malformed according the `TemplateNameFormat` in use.
MapKeyValuePairIterator
Implementation of `TemplateHashModelEx2.KeyValuePairIterator` for a `TemplateHashModelEx2` that wraps or otherwise uses a `Map` internally.
MapModel
A special case of `BeanModel` that adds implementation for `TemplateMethodModelEx` on map objects that is a shortcut for the `Map.get()` method.
MarkupOutputFormat<MO extends TemplateMarkupOutputModel>
Superclass of `OutputFormat`-s that represent a "markup" format, which is any format where certain character sequences have special meaning, and thus may need escaping.
MemberAccessPolicy
Implement this to restrict what class members (methods, fields, constructors) are accessible from templates.
MemberSelectorListMemberAccessPolicy
Superclass for member-selector-list-based member access policies, like `WhitelistMemberAccessPolicy`.
MemberSelectorListMemberAccessPolicy.MemberSelector
A condition that matches some type members.
MergingTemplateConfigurationFactory
Returns the merged results of all the child factories.
MethodAppearanceFineTuner
Used for customizing how the Java methods are visible from templates, via `BeansWrapper.setMethodAppearanceFineTuner(MethodAppearanceFineTuner)`.
MethodCallAwareTemplateHashModel
Adds an extra getter method to `TemplateHashModel` that can return different result than `TemplateHashModel.get(String)`, knowing that the result of it will be called as a method.
MethodCallAwareTemplateHashModel.ShouldNotBeGetAsMethodException
Thrown by `MethodCallAwareTemplateHashModel.getBeforeMethodCall(String)`; see there.
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.
Use `NodeModel` instead.
NodeListModel
Deprecated.
Use `NodeModel` instead.
NodeModel
A base class for wrapping a single W3C DOM Node as a FreeMarker template model.
NonBooleanException
Indicates that a `TemplateBooleanModel` value was expected, but the value had a different type.
NonDateException
Indicates that a `TemplateDateModel` value was expected, but the value had a different type.
NonExtendedHashException
Indicates that a `TemplateHashModelEx` value was expected, but the value had a different type.
NonExtendedNodeException
Indicates that a `TemplateNodeModelEx` value was expected, but the value had a different type.
NonHashException
Indicates that a `TemplateHashModel` value was expected, but the value had a different type.
NonMarkupOutputException
Indicates that a `TemplateMarkupOutputModel` value was expected, but the value had a different type.
NonMethodException
Indicates that a `TemplateMethodModel` value was expected, but the value had a different type.
NonNodeException
Indicates that a `TemplateNodeModel` value was expected, but the value had a different type.
NonNumericalException
Indicates that a `TemplateNumberModel` value was expected, but the value had a different type.
NonSequenceException
Indicates that a `TemplateSequenceModel` value was expected, but the value had a different type.
NonSequenceOrCollectionException
Indicates that a `TemplateSequenceModel` or `TemplateCollectionModel` value was expected, but the value had a different type.
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.
NonStringOrTemplateOutputException
Indicates that a `TemplateScalarModel` (or maybe something that can be automatically coerced to that) or `TemplateMarkupOutputModel` value was expected, 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.
NotMatcher
Logical "not" operation on the given matcher.
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<T>
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
Experimental - subject to change: Adds functionality to `ObjectWrapper` that creates a plain Java object from a `TemplateModel`.
ObjectWrapperWithAPISupport
Experimental - subject to change: Implemented by `ObjectWrapper`-s to help `TemplateModel`-s to implement the `someValue?api` operation.
OptimizerUtil
OptInTemplateClassResolver
A `TemplateClassResolver` that resolves only the classes whose name was specified in the constructor.
OrMatcher
Logical "or" operation among the given matchers.
OutputFormat
Represents an output format.
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`).
ParserConfiguration
Don't implement this interface yourself; use the existing implementation(s).
ParsingNotSupportedException
Thrown when the `TemplateValueFormat` doesn't support parsing, and parsing was invoked.
PathGlobMatcher
Matches the whole template source name (also known as template source path) with the given glob.
PathRegexMatcher
Matches the whole template source name (also known as template source path) with the given regular expression.
PlainTextOutputFormat
Represents the plain text output format (MIME type "text/plain", name "plainText").
ResourceBundleLocalizedString
A concrete implementation of `LocalizedString` that gets a localized string from a `ResourceBundle`
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.
RTFOutputFormat
Represents the Rich Text Format output format (MIME type "application/rtf", name "RTF").
SecurityUtilities
ServletContextHashModel
TemplateHashModel wrapper for a ServletContext attributes.
ServletContextHashModel
TemplateHashModel wrapper for a ServletContext attributes.
SimpleCollection
A simple implementation of `TemplateCollectionModel`.
SimpleDate
A simple implementation of the `TemplateDateModel` interface.
SimpleHash
A simple implementation of the `TemplateHashModelEx` interface, using its own underlying `Map` or `SortedMap` for storing the hash entries.
SimpleList
Deprecated.
Use `SimpleSequence` instead.
SimpleMapModel
Model used by `BeansWrapper` when `simpleMapWrapper` mode is enabled.
SimpleMethodModel
A class that will wrap a reflected method call into a `TemplateMethodModel` interface.
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
A simple implementation of the `TemplateSequenceModel` interface, using its own underlying `List` for storing the list items.
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 `TemplateLoader`-s that maintain some sort of internal state (i.e.
StopException
This exception is thrown when a `#stop` directive is encountered.
StringModel
Deprecated.
Use `GenericObjectModel` instead, which implements `MethodCallAwareTemplateHashModel`.
StringTemplateLoader
A `TemplateLoader` that uses a `Map` with `String`-s as its source of templates.
StringUtil
Some text related utilities.
StringUtil.JsStringEncCompatibility
Used as the argument of `StringUtil.jsStringEnc(String, JsStringEncCompatibility, JsStringEncQuotation)`.
StringUtil.JsStringEncQuotation
Used as the argument of `StringUtil.jsStringEnc(String, JsStringEncCompatibility, JsStringEncQuotation)`.
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
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.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
When it occurs in the `TaglibFactory.MetaInfTldSource` list, all `TaglibFactory.MetaInfTldSource`-s before it will be disabled.
TaglibFactory.ClearMetaInfTldSource
When it occurs in the `TaglibFactory.MetaInfTldSource` list, all `TaglibFactory.MetaInfTldSource`-s before it will be disabled.
TaglibFactory.MetaInfTldSource
A location within which we will look for `META-INF/**``/*.tld`-s.
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.
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.
TemplateAccessible
Indicates that the the annotated member can be exposed to templates; if the annotated member will be actually exposed depends on the `ObjectWrapper` in use, and how that was configured.
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
Return value of `TemplateCache.getTemplate(String, Locale, Object, String, boolean)`.
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, nor the number of elements in it is known.
TemplateCollectionModelEx
"collection" template language data type: Adds size/emptiness querybility to `TemplateCollectionModel`.
TemplateCombinedMarkupOutputModel
Stores combined markup to be printed; used with `CombinedMarkupOutputFormat`.
TemplateConfiguration
Used for customizing the configuration settings for individual `Template`-s (or rather groups of templates), relatively to the common setting values coming from the `Configuration`.
TemplateConfigurationFactory
Creates (or returns) `TemplateConfiguration`-s for template sources.
TemplateConfigurationFactoryException
Non-I/O exception thrown by `TemplateConfigurationFactory`-s.
TemplateDateFormat
Represents a date/time/dateTime format; used in templates for formatting and parsing with that format.
TemplateDateFormatFactory
Factory for a certain kind of date/time/dateTime formatting (`TemplateDateFormat`).
TemplateDateModel
"date", "time" and "date-time" template language data types: corresponds to `Date`.
TemplateDirectiveBody
Represents the nested content of a directive (`TemplateDirectiveModel`) invocation.
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
Used for the `template_exception_handler` configuration setting.
TemplateFormatUtil
Utility classes for implementing `TemplateValueFormat`-s.
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.
TemplateHashModelEx2
Adds key-value pair listing capability to `TemplateHashModelEx`.
TemplateHashModelEx2.KeyValuePair
A key-value pair in a hash; used for `TemplateHashModelEx2.KeyValuePairIterator`.
TemplateHashModelEx2.KeyValuePairIterator
Iterates over the key-value pairs in a hash.
TemplateHTMLOutputModel
Stores HTML markup to be printed; used with `HTMLOutputFormat`.
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).
TemplateLoaderUtils
TemplateLookupContext
Used as the parameter of `TemplateLookupStrategy.lookup(TemplateLookupContext)`.
TemplateLookupResult
The return value of `TemplateLookupStrategy.lookup(TemplateLookupContext)` and similar lookup methods.
TemplateLookupStrategy
Finds the `TemplateLoader`-level (storage-level) template source for the template name with which the template was requested (as in `Configuration.getTemplate(String)`).
TemplateMarkupOutputModel<MO extends TemplateMarkupOutputModel<MO>>
"markup output" template language data-type; stores markup (some kind of "rich text" / structured format, as opposed to plain text) that meant to be printed as template output.
TemplateMethodModel
Deprecated.
Use `TemplateMethodModelEx` instead.
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
`ObjectWrapper`-s may throw this when wrapping/unwrapping fails, or `TemplateModel` methods throw this if the requested data can't be retrieved.
TemplateModelIterator
Used to iterate over a set of template models once; usually returned from `TemplateCollectionModel.iterator()`.
TemplateModelListSequence
A sequence that wraps a `List` of `TemplateModel`-s.
TemplateModelUtils
Static utility method related to `TemplateModel`-s that didn't fit elsewhere.
TemplateModelWithAPISupport
A `TemplateModel` on which the `?api` operation can be applied.
TemplateNameFormat
Symbolizes a template name format, which defines the basic syntax of names through algorithms such as normalization.
TemplateNodeModel
"node" template language data type: an object that is a node in a tree.
TemplateNodeModelEx
A `TemplateNodeModel` that supports navigating to the previous and next sibling nodes.
TemplateNotFoundException
Thrown when `Configuration.getTemplate(String)` (or similar) doesn't find a template.
TemplateNumberFormat
Represents a number format; used in templates for formatting and parsing with that format.
TemplateNumberFormatFactory
Factory for a certain kind of number formatting (`TemplateNumberFormat`).
TemplateNumberModel
"number" template language data type; an object that stores a number.
TemplateProcessingTracer
Hooks to monitor as templates run.
TemplateProcessingTracer.TracedElement
Information about the template element that we enter of exit; do NOT implement this (outside FreeMarker), as new methods can be added to this anytime!
TemplateRTFOutputModel
Stores RTF markup to be printed; used with `RTFOutputFormat`.
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.
TemplateSourceMatcher
TemplateTransformModel
"transform" template language data type: user-defined directives (much like macros) specialized on filtering output; you should rather use the newer `TemplateDirectiveModel` instead.
TemplateValueFormat
Superclass of all value format objects; objects that convert values to strings, or parse strings.
TemplateValueFormatException
Error while getting, creating or applying `TemplateValueFormat`-s (including its subclasses, like `TemplateNumberFormat`).
TemplateValueFormatFactory
Superclass of all format factories.
TemplateXHTMLOutputModel
Stores HTML markup to be printed; used with `HTMLOutputFormat`.
TemplateXMLOutputModel
Stores XML markup to be printed; used with `XMLOutputFormat`.
TransformControl
An interface that can be implemented by writers returned from `TemplateTransformModel.getWriter(java.io.Writer, java.util.Map)`.
TruncateBuiltinAlgorithm
Used for implementing the "truncate" family of built-ins.
UndeclaredThrowableException
The equivalent of JDK 1.3 UndeclaredThrowableException.
UndefinedCustomFormatException
UndefinedOutputFormat
Represents the output format used when the template output format is undecided.
UnexpectedTypeException
The type of a value differs from what was expected.
UnformattableValueException
Thrown when a `TemplateModel` can't be formatted because of the value/properties of it are outside of that the `TemplateValueFormat` supports.
UnknownDateTypeFormattingUnsupportedException
Thrown when a `TemplateDateModel` can't be formatted because its type is `TemplateDateModel.UNKNOWN`.
UnknownDateTypeParsingUnsupportedException
Thrown when a string can't be parsed to `TemplateDateModel`, because the provided target type is `TemplateDateModel.UNKNOWN`.
UnlinkedJythonOperationsImpl
Used internally, public for technical reasons only.
UnparsableValueException
Thrown when the content of the string that should be parsed by the `TemplateValueFormat` doesn't match what the format expects.
UnrecognizedTimeZoneException
Indicates that the time zone name is not recognized.
UnregisteredOutputFormatException
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.
URLTemplateSource
Wraps a `URL`, and implements methods required for a typical template source.
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.
WebappTemplateLoader
A `TemplateLoader` that uses streams reachable through `ServletContext.getResource(String)` as its source of templates.
WhitelistMemberAccessPolicy
Whitelist-based member access policy, that is, only members that are matched by the listing will be exposed.
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.
XHTMLOutputFormat
Represents the XML output format (MIME type "application/xhtml+xml", name "XHTML"); this behaves identically to `HTMLOutputFormat`, except that the name an the MIME Type differs.
XmlEscape
Performs an XML escaping of a given template fragment.
XMLOutputFormat
Represents the XML output format (MIME type "application/xml", name "XML").
XPathSupport
XSCFormat
"XS" `CFormat`, for outputting XML that follows the conventions of XML Schema.
ZeroArgumentNonVoidMethodPolicy
How to show 0 argument non-void public methods to templates.