Skip navigation links
A B C D E F G H I J K L M N O P R S T U V W X Z _ 

A

ACCURACY_HOURS - Static variable in class freemarker.template.utility.DateUtil
Show hours (24h); always 2 digits, like 00, 05, etc.
ACCURACY_MILLISECONDS - Static variable in class freemarker.template.utility.DateUtil
Show hours, minutes and seconds and up to 3 fraction second digits, without trailing 0-s in the fraction part.
ACCURACY_MILLISECONDS_FORCED - Static variable in class freemarker.template.utility.DateUtil
Show hours, minutes and seconds and exactly 3 fraction second digits (even if it's 000)
ACCURACY_MINUTES - Static variable in class freemarker.template.utility.DateUtil
Show hours and minutes (even if minutes is 00).
ACCURACY_SECONDS - Static variable in class freemarker.template.utility.DateUtil
Show hours, minutes and seconds (even if seconds is 00).
adapt(Object, ObjectWrapperAndUnwrapper) - Static method in class freemarker.template.DefaultArrayAdapter
Factory method for creating new adapter instances.
adapt(Enumeration<?>, ObjectWrapper) - Static method in class freemarker.template.DefaultEnumerationAdapter
Factory method for creating new adapter instances.
adapt(Iterable<?>, ObjectWrapperWithAPISupport) - Static method in class freemarker.template.DefaultIterableAdapter
Factory method for creating new adapter instances.
adapt(Iterator, ObjectWrapper) - Static method in class freemarker.template.DefaultIteratorAdapter
Factory method for creating new adapter instances.
adapt(List, RichObjectWrapper) - Static method in class freemarker.template.DefaultListAdapter
Factory method for creating new adapter instances.
adapt(Map, ObjectWrapperWithAPISupport) - Static method in class freemarker.template.DefaultMapAdapter
Factory method for creating new adapter instances.
adapt(Collection, ObjectWrapperWithAPISupport) - Static method in class freemarker.template.DefaultNonListCollectionAdapter
Factory method for creating new adapter instances.
AdapterTemplateModel - Interface in freemarker.template
A TemplateModel that can be unwrapped and then it considers a provided desired (hint) class.
add(Number, Number) - Method in class freemarker.core.ArithmeticEngine
 
add(Number, Number) - Method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
add(Number, Number) - Method in class freemarker.core.ArithmeticEngine.ConservativeEngine
 
add(Object) - Method in class freemarker.template.SimpleSequence
Adds an arbitrary object to the end of this sequence.
add(boolean) - Method in class freemarker.template.SimpleSequence
Deprecated.
Use SimpleSequence.add(Object) instead, as this bypasses the ObjectWrapper.
add_escapes(String) - Method in exception freemarker.core.ParseException
Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.
addAutoImport(String, String) - Method in class freemarker.core.Configurable
Adds an invisible #import templateName as namespaceVarName at the beginning of the main template (that's the top-level template that wasn't included/imported from another template).
addAutoInclude(String) - Method in class freemarker.core.Configurable
Adds an invisible #include templateName at the beginning of the main template (that's the top-level template that wasn't included/imported from another template).
addBreakpoint(Breakpoint) - Method in interface freemarker.debug.Debugger
Adds a breakpoint
addConfiguredJython(JythonAntTask) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
 
addConfiguredPrepareEnvironment(JythonAntTask) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
 
addConfiguredPrepareModel(JythonAntTask) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
 
addDebuggerListener(DebuggerListener) - Method in interface freemarker.debug.Debugger
Adds a listener for debugger events.
addImport(LibraryLoad) - Method in class freemarker.template.Template
Deprecated.
Should only be used internally, and might will be removed later.
addMacro(Macro) - Method in class freemarker.template.Template
Deprecated.
Should only be used internally, and might will be removed later.
addPrefixNSMapping(String, String) - Method in class freemarker.template.Template
Deprecated.
Should only be used internally, and might will be removed later.
addText(String) - Method in class freemarker.ext.ant.JythonAntTask
 
afterBody() - Method in interface freemarker.template.TransformControl
Called after the body has been evaluated.
AliasTemplateDateFormatFactory - Class in freemarker.core
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.
AliasTemplateDateFormatFactory(String) - Constructor for class freemarker.core.AliasTemplateDateFormatFactory
 
AliasTemplateDateFormatFactory(String, Map<Locale, String>) - Constructor for class freemarker.core.AliasTemplateDateFormatFactory
 
AliasTemplateNumberFormatFactory - Class in freemarker.core
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(String) - Constructor for class freemarker.core.AliasTemplateNumberFormatFactory
 
AliasTemplateNumberFormatFactory(String, Map<Locale, String>) - Constructor for class freemarker.core.AliasTemplateNumberFormatFactory
 
AllHttpScopesHashModel - Class in freemarker.ext.servlet
An extension of SimpleHash that looks up keys in the hash, then in the request, session, and servlet context scopes.
AllHttpScopesHashModel(ObjectWrapper, ServletContext, HttpServletRequest) - Constructor for class freemarker.ext.servlet.AllHttpScopesHashModel
Creates a new instance of AllHttpScopesHashModel for handling a single HTTP servlet request.
allowNoMatch(boolean) - Method in class freemarker.cache.FirstMatchTemplateConfigurationFactory
Same as FirstMatchTemplateConfigurationFactory.setAllowNoMatch(boolean), but return this object to support "fluent API" style.
ALLOWS_NOTHING_RESOLVER - Static variable in interface freemarker.core.TemplateClassResolver
Doesn't allow resolving any classes.
AndMatcher - Class in freemarker.cache
Logical "and" operation among the given matchers.
AndMatcher(TemplateSourceMatcher...) - Constructor for class freemarker.cache.AndMatcher
 
ANGLE_BRACKET_TAG_SYNTAX - Static variable in class freemarker.template.Configuration
 
API_BUILTIN_ENABLED_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
API_BUILTIN_ENABLED_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
API_BUILTIN_ENABLED_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
append(CharSequence) - Method in class freemarker.template.utility.NullWriter
 
append(CharSequence, int, int) - Method in class freemarker.template.utility.NullWriter
 
append(char) - Method in class freemarker.template.utility.NullWriter
 
apply(Template) - Method in class freemarker.core.TemplateConfiguration
Sets those settings of the Template which aren't yet set in the Template and are set in this TemplateConfiguration, leaves the other settings as is.
applyEqualsOperator(TemplateModel, TemplateModel) - Method in class freemarker.core.Environment
Compares two TemplateModel-s according the rules of the FTL "==" operator.
applyEqualsOperatorLenient(TemplateModel, TemplateModel) - Method in class freemarker.core.Environment
Compares two TemplateModel-s according the rules of the FTL "==" operator, except that if the two types are incompatible, they are treated as non-equal instead of throwing an exception.
applyGreaterThanOperator(TemplateModel, TemplateModel) - Method in class freemarker.core.Environment
Compares two TemplateModel-s according the rules of the FTL ">" operator.
applyLessThanOperator(TemplateModel, TemplateModel) - Method in class freemarker.core.Environment
Compares two TemplateModel-s according the rules of the FTL "<" operator.
applyLessThanOrEqualsOperator(TemplateModel, TemplateModel) - Method in class freemarker.core.Environment
Compares two TemplateModel-s according the rules of the FTL "<" operator.
applyWithGreaterThanOrEqualsOperator(TemplateModel, TemplateModel) - Method in class freemarker.core.Environment
Compares two TemplateModel-s according the rules of the FTL ">=" operator.
ARITHMETIC_ENGINE_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
ARITHMETIC_ENGINE_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
ARITHMETIC_ENGINE_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
ArithmeticEngine - Class in freemarker.core
Class to perform arithmetic operations.
ArithmeticEngine() - Constructor for class freemarker.core.ArithmeticEngine
 
ArithmeticEngine.BigDecimalEngine - Class in freemarker.core
This is the default arithmetic engine in FreeMarker.
ArithmeticEngine.ConservativeEngine - Class in freemarker.core
An arithmetic engine that conservatively widens the operation arguments to extent that they can hold the result of the operation.
ArrayModel - Class in freemarker.ext.beans
A class that will wrap an arbitrary array into TemplateCollectionModel and TemplateSequenceModel interfaces.
ArrayModel(Object, BeansWrapper) - Constructor for class freemarker.ext.beans.ArrayModel
Creates a new model that wraps the specified array object.
attributeAdded(ServletContextAttributeEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
attributeAdded(HttpSessionBindingEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
attributeRemoved(ServletContextAttributeEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
attributeRemoved(HttpSessionBindingEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
attributeReplaced(ServletContextAttributeEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
attributeReplaced(HttpSessionBindingEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
AUTO_DETECT_NAMING_CONVENTION - Static variable in class freemarker.template.Configuration
 
AUTO_DETECT_TAG_SYNTAX - Static variable in class freemarker.template.Configuration
 
AUTO_ESCAPING_POLICY_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
AUTO_ESCAPING_POLICY_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
AUTO_ESCAPING_POLICY_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
AUTO_FLUSH_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
AUTO_FLUSH_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
AUTO_FLUSH_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
AUTO_IMPORT_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
AUTO_IMPORT_KEY - Static variable in class freemarker.template.Configuration
Deprecated.
AUTO_IMPORT_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
AUTO_IMPORT_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Deprecated.
AUTO_IMPORT_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
AUTO_IMPORT_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Deprecated.
AUTO_INCLUDE_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
AUTO_INCLUDE_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
AUTO_INCLUDE_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
AUTO_INCLUDE_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
AUTO_INCLUDE_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
AUTO_INCLUDE_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.

B

baseDir - Variable in class freemarker.cache.FileTemplateLoader
 
BeanModel - Class in freemarker.ext.beans
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.
BeanModel(Object, BeansWrapper) - Constructor for class freemarker.ext.beans.BeanModel
Creates a new model that wraps the specified object.
BEANS_WRAPPER - Static variable in interface freemarker.template.ObjectWrapper
Deprecated.
Use BeansWrapperBuilder.build() instead; this instance isn't read-only and thus can't be trusted.
BeansModelCache - Class in freemarker.ext.beans
 
BeansWrapper - Class in freemarker.ext.beans
ObjectWrapper that is able to expose the Java API of arbitrary Java objects.
BeansWrapper() - Constructor for class freemarker.ext.beans.BeansWrapper
Deprecated.
BeansWrapper(Version) - Constructor for class freemarker.ext.beans.BeansWrapper
Use BeansWrapperBuilder instead of the public constructors if possible.
BeansWrapper(BeansWrapperConfiguration, boolean) - Constructor for class freemarker.ext.beans.BeansWrapper
Same as BeansWrapper.BeansWrapper(BeansWrapperConfiguration, boolean, boolean) with true finalizeConstruction argument.
BeansWrapper(BeansWrapperConfiguration, boolean, boolean) - Constructor for class freemarker.ext.beans.BeansWrapper
Initializes the instance based on the the BeansWrapperConfiguration specified.
BeansWrapper.MethodAppearanceDecision - Class in freemarker.ext.beans
BeansWrapper.MethodAppearanceDecisionInput - Class in freemarker.ext.beans
BeansWrapperBuilder - Class in freemarker.ext.beans
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.
BeansWrapperBuilder(Version) - Constructor for class freemarker.ext.beans.BeansWrapperBuilder
BeansWrapperConfiguration - Class in freemarker.ext.beans
Holds BeansWrapper configuration settings and defines their defaults.
BeansWrapperConfiguration(Version, boolean) - Constructor for class freemarker.ext.beans.BeansWrapperConfiguration
 
BeansWrapperConfiguration(Version) - Constructor for class freemarker.ext.beans.BeansWrapperConfiguration
BIGDECIMAL_ENGINE - Static variable in class freemarker.core.ArithmeticEngine
Arithmetic engine that converts all numbers to BigDecimal and then operates on them.
BigDecimalEngine() - Constructor for class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
BOOLEAN_FORMAT_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
BOOLEAN_FORMAT_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
BOOLEAN_FORMAT_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
BooleanModel - Class in freemarker.ext.beans
A class that will wrap instances of Boolean into a TemplateBooleanModel.
BooleanModel(Boolean, BeansWrapper) - Constructor for class freemarker.ext.beans.BooleanModel
 
boxingClassToPrimitiveClass(Class) - Static method in class freemarker.template.utility.ClassUtil
Breakpoint - Class in freemarker.debug
Represents a breakpoint location consisting of a template name and a line number.
Breakpoint(String, int) - Constructor for class freemarker.debug.Breakpoint
Creates a new breakpoint.
BugException - Exception in freemarker.core
An unexpected state was reached that is certainly caused by a bug in FreeMarker.
BugException() - Constructor for exception freemarker.core.BugException
 
BugException(String) - Constructor for exception freemarker.core.BugException
 
BugException(Throwable) - Constructor for exception freemarker.core.BugException
 
BugException(String, Throwable) - Constructor for exception freemarker.core.BugException
 
BugException(int) - Constructor for exception freemarker.core.BugException
 
build() - Method in class freemarker.ext.beans.BeansWrapperBuilder
Returns a BeansWrapper instance that matches the settings of this builder.
build() - Method in class freemarker.template.DefaultObjectWrapperBuilder
Returns a DefaultObjectWrapper instance that matches the settings of this builder.
BuiltInForNodeEx - Class in freemarker.core
 
BuiltInForNodeEx() - Constructor for class freemarker.core.BuiltInForNodeEx
 
ByteArrayTemplateLoader - Class in freemarker.cache
A TemplateLoader that uses a Map with byte[] as its source of templates.
ByteArrayTemplateLoader() - Constructor for class freemarker.cache.ByteArrayTemplateLoader
 

C

CACHE_STORAGE_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
CACHE_STORAGE_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
CACHE_STORAGE_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
CacheStorage - Interface in freemarker.cache
Cache storage abstracts away the storage aspects of a cache - associating an object with a key, retrieval and removal via the key.
CacheStorageWithGetSize - Interface in freemarker.cache
A cache storage that has a getSize() method for returning the current number of cache entries.
calculate(int, int, int, int, int, int, int, int, boolean, TimeZone) - Method in interface freemarker.template.utility.DateUtil.CalendarFieldsToDateConverter
Calculates the Date from the specified calendar fields.
calculate(int, int, int, int, int, int, int, int, boolean, TimeZone) - Method in class freemarker.template.utility.DateUtil.TrivialCalendarFieldsToDateConverter
 
CallPlaceCustomDataInitializationException - Exception in freemarker.core
CallPlaceCustomDataInitializationException(String, Throwable) - Constructor for exception freemarker.core.CallPlaceCustomDataInitializationException
 
CAMEL_CASE_NAMING_CONVENTION - Static variable in class freemarker.template.Configuration
 
canonicalizePrefix(String) - Static method in class freemarker.cache.URLTemplateLoader
Can be used by subclasses to canonicalize URL path prefixes.
CANT_UNWRAP_TO_TARGET_CLASS - Static variable in interface freemarker.template.ObjectWrapperAndUnwrapper
Indicates that while the unwrapping is maybe possible, the result surely can't be the instance of the desired class, nor it can be null.
capitalize(String) - Static method in class freemarker.template.utility.StringUtil
 
CaptureOutput - Class in freemarker.template.utility
Deprecated.
Use block-assignments instead, like <assign x>...</assign>.
CaptureOutput() - Constructor for class freemarker.template.utility.CaptureOutput
Deprecated.
 
caseInsensitive(boolean) - Method in class freemarker.cache.FileExtensionMatcher
caseInsensitive(boolean) - Method in class freemarker.cache.FileNameGlobMatcher
caseInsensitive(boolean) - Method in class freemarker.cache.PathGlobMatcher
check(String, Object) - Static method in exception freemarker.template.utility.NullArgumentException
Convenience method to protect against a null argument.
check(Object) - Static method in exception freemarker.template.utility.NullArgumentException
 
checkHasNoParameters(String) - Static method in class freemarker.core.TemplateFormatUtil
 
checkModifiable() - Method in class freemarker.ext.beans.BeansWrapper
If this object is already read-only according to WriteProtectable, throws IllegalStateException, otherwise does nothing.
chomp(String) - Static method in class freemarker.template.utility.StringUtil
Removes a line-break from the end of the string (if there's any).
CLASSIC_COMPATIBLE_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
CLASSIC_COMPATIBLE_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
CLASSIC_COMPATIBLE_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
ClasspathMetaInfTldSource(Pattern) - Constructor for class freemarker.ext.jsp.TaglibFactory.ClasspathMetaInfTldSource
 
ClassTemplateLoader - Class in freemarker.cache
A TemplateLoader that can load templates from the "classpath".
ClassTemplateLoader() - Constructor for class freemarker.cache.ClassTemplateLoader
Deprecated.
It's a confusing constructor, and seldom useful; use ClassTemplateLoader.ClassTemplateLoader(Class, String) instead.
ClassTemplateLoader(Class<?>) - Constructor for class freemarker.cache.ClassTemplateLoader
Deprecated.
It's confusing that the base path is ""; use ClassTemplateLoader.ClassTemplateLoader(Class, String) instead.
ClassTemplateLoader(Class<?>, String) - Constructor for class freemarker.cache.ClassTemplateLoader
Creates a template loader that will use the Class.getResource(String) method of the specified class to load the resources, and the specified base package path (absolute or relative).
ClassTemplateLoader(ClassLoader, String) - Constructor for class freemarker.cache.ClassTemplateLoader
ClassUtil - Class in freemarker.template.utility
 
clear() - Method in interface freemarker.cache.CacheStorage
 
clear() - Method in class freemarker.cache.MruCacheStorage
 
clear() - Method in class freemarker.cache.NullCacheStorage
 
clear() - Method in class freemarker.cache.SoftCacheStorage
 
clear() - Method in class freemarker.cache.StrongCacheStorage
 
clear() - Method in class freemarker.cache.TemplateCache
Removes all entries from the cache, forcing reloading of templates on subsequent TemplateCache.getTemplate(String, Locale, String, boolean) calls.
clear() - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Removes all mappings from this map.
clearCache() - Method in class freemarker.ext.util.ModelCache
 
clearClassIntrospecitonCache() - Method in class freemarker.ext.beans.BeansWrapper
Removes all class introspection data from the cache.
clearEncodingMap() - Method in class freemarker.template.Configuration
Clears language-to-encoding map.
clearSharedVariables() - Method in class freemarker.template.Configuration
Removes all shared sharedVariables, except the predefined ones (compress, html_escape, etc.).
clearTemplateCache() - Method in class freemarker.template.Configuration
Removes all entries from the template cache, thus forcing reloading of templates on subsequent getTemplate calls.
clone() - Method in class freemarker.core.Configurable
 
clone(boolean) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
clone() - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Returns a shallow copy of this IdentityHashMap instance: the keys and values themselves are not cloned.
clone() - Method in class freemarker.template.Configuration
 
close() - Method in class freemarker.template.utility.NullWriter
 
closeTemplateSource(Object) - Method in class freemarker.cache.ByteArrayTemplateLoader
 
closeTemplateSource(Object) - Method in class freemarker.cache.FileTemplateLoader
 
closeTemplateSource(Object) - Method in class freemarker.cache.MultiTemplateLoader
 
closeTemplateSource(Object) - Method in class freemarker.cache.StringTemplateLoader
 
closeTemplateSource(Object) - Method in interface freemarker.cache.TemplateLoader
Closes the template source, releasing any resources held that are only required for reading the template and/or its metadata.
closeTemplateSource(Object) - Method in class freemarker.cache.URLTemplateLoader
 
closeTemplateSource(Object) - Method in class freemarker.cache.WebappTemplateLoader
 
coerceBigDecimal(BigDecimal, Class<?>) - Static method in class freemarker.ext.beans.BeansWrapper
Converts BigDecimal to the class given in the formalType argument if that's a known numerical type, returns the BigDecimal as is otherwise.
coerceBigDecimals(AccessibleObject, Object[]) - Static method in class freemarker.ext.beans.BeansWrapper
Converts any BigDecimals in the passed array to the type of the corresponding formal argument of the method.
coerceBigDecimals(Class<?>[], Object[]) - Static method in class freemarker.ext.beans.BeansWrapper
Converts any BigDecimal-s in the passed array to the type of the corresponding formal argument of the method via BeansWrapper.coerceBigDecimal(BigDecimal, Class).
CollectionModel - Class in freemarker.ext.beans
A special case of BeanModel that can wrap Java collections and that implements the TemplateCollectionModel in order to be usable in a <#list> block.
CollectionModel(Collection, BeansWrapper) - Constructor for class freemarker.ext.beans.CollectionModel
Creates a new model that wraps the specified collection object.
Collections12 - Class in freemarker.template.utility
Deprecated.
Not needed anymore, as FreeMarker now requires higher than Java 1.3
CollectionUtils - Class in freemarker.template.utility
 
columnNumber - Variable in exception freemarker.core.ParseException
 
CombinedMarkupOutputFormat - Class in freemarker.core
Represents two markup formats nested into each other.
CombinedMarkupOutputFormat(MarkupOutputFormat, MarkupOutputFormat) - Constructor for class freemarker.core.CombinedMarkupOutputFormat
CombinedMarkupOutputFormat(String, MarkupOutputFormat, MarkupOutputFormat) - Constructor for class freemarker.core.CombinedMarkupOutputFormat
 
CommandLine - Class in freemarker.core
Deprecated.
Will be removed (main method in a library, often classified as CWE-489 "Leftover Debug Code").
CommandLine() - Constructor for class freemarker.core.CommandLine
Deprecated.
 
CommonMarkupOutputFormat<MO extends CommonTemplateMarkupOutputModel> - Class in freemarker.core
Common superclass for implementing MarkupOutputFormat-s that use a CommonTemplateMarkupOutputModel subclass.
CommonMarkupOutputFormat() - Constructor for class freemarker.core.CommonMarkupOutputFormat
 
CommonTemplateMarkupOutputModel<MO extends CommonTemplateMarkupOutputModel<MO>> - Class in freemarker.core
Common superclass for implementing TemplateMarkupOutputModel-s that belong to a CommonMarkupOutputFormat subclass format.
CommonTemplateMarkupOutputModel(String, String) - Constructor for class freemarker.core.CommonTemplateMarkupOutputModel
A least one of the parameters must be non-null!
compareNumbers(Number, Number) - Method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
compareNumbers(Number, Number) - Method in class freemarker.core.ArithmeticEngine
 
compareNumbers(Number, Number) - Method in class freemarker.core.ArithmeticEngine.ConservativeEngine
 
compareTo(Object) - Method in class freemarker.debug.Breakpoint
 
concat(MO, MO) - Method in class freemarker.core.CommonMarkupOutputFormat
 
concat(MO, MO) - Method in class freemarker.core.MarkupOutputFormat
Returns a TemplateMarkupOutputModel that contains the content of both TemplateMarkupOutputModel objects concatenated.
ConcurrentCacheStorage - Interface in freemarker.cache
An optional interface for cache storage that knows whether it can be concurrently accessible without synchronization.
ConditionalTemplateConfigurationFactory - Class in freemarker.cache
Returns the given TemplateConfiguration directly, or another TemplateConfigurationFactory's result, when the specified matcher matches the template source.
ConditionalTemplateConfigurationFactory(TemplateSourceMatcher, TemplateConfigurationFactory) - Constructor for class freemarker.cache.ConditionalTemplateConfigurationFactory
 
ConditionalTemplateConfigurationFactory(TemplateSourceMatcher, TemplateConfiguration) - Constructor for class freemarker.cache.ConditionalTemplateConfigurationFactory
 
Configurable - Class in freemarker.core
This is a common superclass of Configuration, Template, and Environment classes.
Configurable() - Constructor for class freemarker.core.Configurable
Deprecated.
This shouldn't even be public; don't use it.
Configurable(Version) - Constructor for class freemarker.core.Configurable
Intended to be called from inside FreeMarker only.
Configurable(Configurable) - Constructor for class freemarker.core.Configurable
Creates a new instance.
Configurable.SettingValueAssignmentException - Exception in freemarker.core
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 - Exception in freemarker.core
The setting name was not recognized.
Configuration - Class in freemarker.template
The main entry point into the FreeMarker API; encapsulates the configuration settings of FreeMarker, also serves as a central template-loading and caching service.
Configuration() - Constructor for class freemarker.template.Configuration
Deprecated.
Configuration(Version) - Constructor for class freemarker.template.Configuration
Creates a new instance and sets which of the non-backward-compatible bugfixes/improvements should be enabled.
CONSERVATIVE_ENGINE - Static variable in class freemarker.core.ArithmeticEngine
Arithmetic engine that uses (more-or-less) the widening conversions of Java language to determine the type of result of operation, instead of converting everything to BigDecimal up front.
ConservativeEngine() - Constructor for class freemarker.core.ArithmeticEngine.ConservativeEngine
 
Constants - Class in freemarker.template.utility
Frequently used constant TemplateModel values.
Constants() - Constructor for class freemarker.template.utility.Constants
 
containingElements(int, int) - Method in class freemarker.template.Template
Deprecated.
Should only be used internally, and might will be removed later.
contains(TemplateModel) - Method in class freemarker.template.DefaultNonListCollectionAdapter
 
containsKey(Object) - Method in class freemarker.ext.beans.HashAdapter
 
containsKey(Object) - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Returns true if this map contains a mapping for the specified key.
containsKey(String) - Method in class freemarker.template.SimpleHash
Tells if the map contains a key or not, regardless if the associated value is null or not.
containsValue(Object) - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Returns true if this map maps one or more keys to the specified value.
contextDestroyed(ServletContextEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
contextInitialized(ServletContextEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
convertArray(Object) - Method in class freemarker.template.DefaultObjectWrapper
Converts an array to a java.util.List.
convertValueToText(Object, boolean, boolean, boolean, int, boolean) - Method in class freemarker.core.FreeMarkerTree
Deprecated.
 
copyMap(Map) - Method in class freemarker.template.SimpleHash
 
create() - Method in class freemarker.core.CustomAttribute
This method is invoked when CustomAttribute.get() is invoked without CustomAttribute.set(Object) being invoked before it to define the value in the current scope.
create(Object) - Method in class freemarker.ext.beans.BeansModelCache
 
create(Object) - Method in class freemarker.ext.util.ModelCache
 
create(Object, ObjectWrapper) - Method in interface freemarker.ext.util.ModelFactory
Create a wrapping model for the specified object that belongs to the specified wrapper.
createConfiguration() - Method in class freemarker.ext.servlet.FreemarkerServlet
Creates the FreeMarker Configuration singleton and (when overidden) maybe sets its defaults.
createDefaultClassPathTlds() - Method in class freemarker.ext.servlet.FreemarkerServlet
Creates the default of the "ClasspathTlds" init-param; if this init-param is specified, it will be appended after the default, not replace it.
createDefaultMetaInfTldSources() - Method in class freemarker.ext.servlet.FreemarkerServlet
Creates the default of the "MetaInfTldSources" init-param; if this init-param is specified, it will completelly replace the default value.
createDefaultObjectWrapper() - Method in class freemarker.ext.servlet.FreemarkerServlet
Override this to specify what the default ObjectWrapper will be when the object_wrapper Servlet init-param wasn't specified.
createLegacyDefaultTemplateLoader() - Static method in class freemarker.cache.TemplateCache
Deprecated.
The TemplateLoader should be always specified by the constructor caller.
createModel(ObjectWrapper, ServletContext, HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
 
createNegativeLookupResult() - Method in class freemarker.cache.TemplateLookupContext
Creates a not-found lookup result that then can be used as the return value of TemplateLookupStrategy.lookup(TemplateLookupContext).
createObject() - Method in interface freemarker.template.utility.ObjectFactory
 
createObjectWrapper() - Method in class freemarker.ext.servlet.FreemarkerServlet
Called from FreemarkerServlet.init() to create the ObjectWrapper; to customzie this aspect, in most cases you should override FreemarkerServlet.createDefaultObjectWrapper() instead.
createProcessingEnvironment(Object, Writer, ObjectWrapper) - Method in class freemarker.template.Template
Creates a Environment object, using this template, the data-model provided as parameter.
createProcessingEnvironment(Object, Writer) - Method in class freemarker.template.Template
createRequestParametersHashModel(HttpServletRequest) - Method in class freemarker.ext.servlet.FreemarkerServlet
 
createTaglibFactory(ObjectWrapper, ServletContext) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called to create the TaglibFactory once per servlet context.
createTemplateLoader(String) - Method in class freemarker.ext.servlet.FreemarkerServlet
Create the template loader.
CSSOutputFormat - Class in freemarker.core
Represents the CSS output format (MIME type "text/css", name "CSS").
currentToken - Variable in exception freemarker.core.ParseException
This is the last token that has been consumed successfully.
CUSTOM_DATE_FORMATS_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
CUSTOM_DATE_FORMATS_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
CUSTOM_DATE_FORMATS_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
CUSTOM_NUMBER_FORMATS_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
CUSTOM_NUMBER_FORMATS_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
CUSTOM_NUMBER_FORMATS_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
CustomAttribute - Class in freemarker.core
A class that allows one to associate custom data with a Configuration, a Template, or Environment.
CustomAttribute(int) - Constructor for class freemarker.core.CustomAttribute
Creates a new custom attribute with the specified scope

D

DATE - Static variable in interface freemarker.template.TemplateDateModel
The date model represents a date value (no time part).
DATE_FORMAT_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
DATE_FORMAT_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
DATE_FORMAT_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
DateModel - Class in freemarker.ext.beans
Wraps arbitrary subclass of Date into a reflective model.
DateModel(Date, BeansWrapper) - Constructor for class freemarker.ext.beans.DateModel
Creates a new model that wraps the specified date object.
DateParseException(String) - Constructor for exception freemarker.template.utility.DateUtil.DateParseException
 
DATETIME - Static variable in interface freemarker.template.TemplateDateModel
The date model represents a date-time value (also known as timestamp).
DATETIME_FORMAT_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
DATETIME_FORMAT_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
DATETIME_FORMAT_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
dateToISO8601String(Date, boolean, boolean, boolean, int, TimeZone, DateUtil.DateToISO8601CalendarFactory) - Static method in class freemarker.template.utility.DateUtil
Format a date, time or dateTime with one of the ISO 8601 extended formats that is also compatible with the XML Schema format (as far as you don't have dates in the BC era).
dateToXSString(Date, boolean, boolean, boolean, int, TimeZone, DateUtil.DateToISO8601CalendarFactory) - Static method in class freemarker.template.utility.DateUtil
DateUtil - Class in freemarker.template.utility
Date and time related utilities.
DateUtil.CalendarFieldsToDateConverter - Interface in freemarker.template.utility
Used internally by DateUtil; don't use its implementations for anything else.
DateUtil.DateParseException - Exception in freemarker.template.utility
 
DateUtil.DateToISO8601CalendarFactory - Interface in freemarker.template.utility
Used internally by DateUtil; don't use its implementations for anything else.
DateUtil.TrivialCalendarFieldsToDateConverter - Class in freemarker.template.utility
Non-thread-safe implementation that hard-references a calendar internally.
DateUtil.TrivialDateToISO8601CalendarFactory - Class in freemarker.template.utility
Non-thread-safe factory that hard-references a calendar internally.
debug - Variable in class freemarker.ext.servlet.FreemarkerServlet
Deprecated.
Not used anymore; to enable/disable debug logging, just set the logging level of the logging library used by Logger.
debug(String) - Method in class freemarker.log.Logger
Logs a debugging message.
debug(String, Throwable) - Method in class freemarker.log.Logger
Logs a debugging message with accompanying throwable.
DEBUG_HANDLER - Static variable in interface freemarker.template.TemplateExceptionHandler
TemplateExceptionHandler useful when you developing non-HTML templates.
DebuggedEnvironment - Interface in freemarker.debug
Represents the debugger-side mirror of a debugged Environment object in the remote VM.
Debugger - Interface in freemarker.debug
The main debugger interface.
DebuggerClient - Class in freemarker.debug
A utility class that allows you to connect to the FreeMarker debugger service running on a specific host and port.
DebuggerListener - Interface in freemarker.debug
An interface for components that wish to receive debugging events.
DebugModel - Interface in freemarker.debug
Represents the debugger-side mirror of a TemplateModel object, a Template object, or a Configuration object.
deduceLocale(String, HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
Returns the locale used for the Configuration.getTemplate(String, Locale) call (as far as the "OverrideResponseLocale" Servlet init-param allows that).
deduceLocale(String) - Static method in class freemarker.template.utility.StringUtil
 
DeepUnwrap - Class in freemarker.template.utility
Utility methods for unwrapping TemplateModel-s.
DeepUnwrap() - Constructor for class freemarker.template.utility.DeepUnwrap
 
DEFAULT_2_3_0 - Static variable in class freemarker.cache.TemplateLookupStrategy
The default lookup strategy of FreeMarker.
DEFAULT_2_3_0 - Static variable in class freemarker.cache.TemplateNameFormat
The default template name format when incompatible_improvements is below 2.4.0.
DEFAULT_2_4_0 - Static variable in class freemarker.cache.TemplateNameFormat
The default template name format only when incompatible_improvements is set to 2.4.0 (or higher).
DEFAULT_CLASSPATH_TLDS - Static variable in class freemarker.ext.jsp.TaglibFactory
The default of TaglibFactory.getClasspathTlds(); an empty list.
DEFAULT_ENCODING_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
DEFAULT_ENCODING_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
DEFAULT_ENCODING_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
DEFAULT_INCOMPATIBLE_ENHANCEMENTS - Static variable in class freemarker.template.Configuration
DEFAULT_INCOMPATIBLE_IMPROVEMENTS - Static variable in class freemarker.template.Configuration
DEFAULT_META_INF_TLD_SOURCES - Static variable in class freemarker.ext.jsp.TaglibFactory
The default of TaglibFactory.getMetaInfTldSources(); a list that contains TaglibFactory.WebInfPerLibJarMetaInfTldSource.INSTANCE, which gives the behavior described in the JSP 2.2 specification.
DEFAULT_NAMESPACE_PREFIX - Static variable in class freemarker.template.Template
 
DEFAULT_PORT - Static variable in interface freemarker.debug.Debugger
 
DEFAULT_TEMPLATE_UPDATE_DELAY_MILLIS - Static variable in class freemarker.cache.TemplateCache
The default template update delay; see Configuration.setTemplateUpdateDelayMilliseconds(long).
DEFAULT_WRAPPER - Static variable in interface freemarker.template.ObjectWrapper
Deprecated.
Use DefaultObjectWrapperBuilder.build() instead; this instance isn't read-only and thus can't be trusted.
DefaultArrayAdapter - Class in freemarker.template
Adapts an array of a non-primitive elements to the corresponding TemplateModel interface(s), most importantly to TemplateHashModelEx.
DefaultEnumerationAdapter - Class in freemarker.template
Adapts an Enumeration to the corresponding TemplateModel interface(s), most importantly to TemplateCollectionModel.
DefaultIterableAdapter - Class in freemarker.template
Adapts an Iterable to the corresponding TemplateModel interface(s), most importantly to TemplateCollectionModel.
DefaultIteratorAdapter - Class in freemarker.template
Adapts an Iterator to the corresponding TemplateModel interface(s), most importantly to TemplateCollectionModel.
DefaultListAdapter - Class in freemarker.template
Adapts a List to the corresponding TemplateModel interface(s), most importantly to TemplateSequenceModel.
DefaultMapAdapter - Class in freemarker.template
Adapts a Map to the corresponding TemplateModel interface(s), most importantly to TemplateHashModelEx.
DefaultNonListCollectionAdapter - Class in freemarker.template
Adapts a non-List Java Collection to the corresponding TemplateModel interface(s), most importantly to TemplateCollectionModelEx.
DefaultObjectWrapper - Class in freemarker.template
The default implementation of the ObjectWrapper interface.
DefaultObjectWrapper() - Constructor for class freemarker.template.DefaultObjectWrapper
DefaultObjectWrapper(Version) - Constructor for class freemarker.template.DefaultObjectWrapper
Use DefaultObjectWrapperBuilder instead if possible.
DefaultObjectWrapper(BeansWrapperConfiguration, boolean) - Constructor for class freemarker.template.DefaultObjectWrapper
Use DefaultObjectWrapper.DefaultObjectWrapper(DefaultObjectWrapperConfiguration, boolean) instead if possible; it does the same, except that it tolerates a non-DefaultObjectWrapperConfiguration configuration too.
DefaultObjectWrapper(DefaultObjectWrapperConfiguration, boolean) - Constructor for class freemarker.template.DefaultObjectWrapper
DefaultObjectWrapperBuilder - Class in freemarker.template
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.
DefaultObjectWrapperBuilder(Version) - Constructor for class freemarker.template.DefaultObjectWrapperBuilder
Creates a builder that creates a DefaultObjectWrapper with the given incompatibleImprovements; using at least 2.3.22 is highly recommended.
DefaultObjectWrapperConfiguration - Class in freemarker.template
Holds DefaultObjectWrapper configuration settings and defines their defaults.
DefaultObjectWrapperConfiguration(Version) - Constructor for class freemarker.template.DefaultObjectWrapperConfiguration
 
DirectiveCallPlace - Interface in freemarker.core
Gives information about the place where a directive is called from, also lets you attach a custom data object to that place.
DISABLE_AUTO_ESCAPING_POLICY - Static variable in class freemarker.template.Configuration
Don't enable auto-escaping, regardless of what the OutputFormat is.
divide(Number, Number) - Method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
divide(Number, Number) - Method in class freemarker.core.ArithmeticEngine.ConservativeEngine
 
divide(Number, Number) - Method in class freemarker.core.ArithmeticEngine
 
doAfterBody() - Method in class freemarker.ext.jsp.FreemarkerTag
 
doAutoImportsAndIncludes(Environment) - Method in class freemarker.core.Configurable
Executes the auto-imports and auto-includes for the main template of this environment.
doAutoImportsAndIncludes(Environment) - Method in class freemarker.template.Configuration
 
doEndTag() - Method in class freemarker.ext.jsp.FreemarkerTag
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
 
doInitBody() - Method in class freemarker.ext.jsp.FreemarkerTag
 
DOMNodeModel - Class in freemarker.template.utility
A convenient wrapper class for wrapping a Node in the W3C DOM API.
DOMNodeModel(Node) - Constructor for class freemarker.template.utility.DOMNodeModel
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
 
doStartTag() - Method in class freemarker.ext.jsp.FreemarkerTag
 
dump(PrintStream) - Method in class freemarker.template.Template
Dump the raw template in canonical form.
dump(Writer) - Method in class freemarker.template.Template
Dump the raw template in canonical form.

E

EMPTY_CHAR_ARRAY - Static variable in class freemarker.template.utility.CollectionUtils
 
EMPTY_CLASS_ARRAY - Static variable in class freemarker.template.utility.CollectionUtils
 
EMPTY_COLLECTION - Static variable in class freemarker.template.utility.Constants
 
EMPTY_HASH - Static variable in class freemarker.template.utility.Constants
 
EMPTY_ITERATOR - Static variable in class freemarker.template.utility.Constants
 
EMPTY_MAP - Static variable in class freemarker.template.utility.Collections12
Deprecated.
 
EMPTY_OBJECT_ARRAY - Static variable in class freemarker.template.utility.CollectionUtils
 
EMPTY_SEQUENCE - Static variable in class freemarker.template.utility.Constants
 
EMPTY_STRING - Static variable in interface freemarker.template.TemplateScalarModel
A constant value to use as the empty string.
EMPTY_STRING - Static variable in class freemarker.template.utility.Constants
 
emptyToNull(String) - Static method in class freemarker.template.utility.StringUtil
Converts a 0-length string to null, leaves the string as is otherwise.
ENABLE_IF_DEFAULT_AUTO_ESCAPING_POLICY - Static variable in class freemarker.template.Configuration
Enable auto-escaping if the output format supports it and MarkupOutputFormat.isAutoEscapedByDefault() is true.
ENABLE_IF_SUPPORTED_AUTO_ESCAPING_POLICY - Static variable in class freemarker.template.Configuration
Enable auto-escaping if the OutputFormat supports it.
END_EVALUATION - Static variable in interface freemarker.template.TransformControl
Constant returned from TransformControl.afterBody() that tells the template engine to end the transform and close the writer.
endColumnNumber - Variable in exception freemarker.core.ParseException
 
endLineNumber - Variable in exception freemarker.core.ParseException
 
entrySet() - Method in class freemarker.ext.beans.HashAdapter
 
entrySet() - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Returns a collection view of the mappings contained in this map.
EnumerationModel - Class in freemarker.ext.beans
A class that adds TemplateModelIterator functionality to the Enumeration interface implementers.
EnumerationModel(Enumeration, BeansWrapper) - Constructor for class freemarker.ext.beans.EnumerationModel
Creates a new model that wraps the specified enumeration object.
Environment - Class in freemarker.core
Object that represents the runtime environment during template processing.
Environment(Template, TemplateHashModel, Writer) - Constructor for class freemarker.core.Environment
 
Environment.Namespace - Class in freemarker.core
 
environmentSuspended(EnvironmentSuspendedEvent) - Method in interface freemarker.debug.DebuggerListener
Called whenever an environment gets suspended (ie hits a breakpoint).
EnvironmentSuspendedEvent - Class in freemarker.debug
Event describing a suspension of an environment (ie because it hit a breakpoint).
EnvironmentSuspendedEvent(Object, String, int, DebuggedEnvironment) - Constructor for class freemarker.debug.EnvironmentSuspendedEvent
 
eol - Variable in exception freemarker.core.ParseException
The end of line string for this machine.
equals(Object) - Method in class freemarker.debug.Breakpoint
 
equals(Object) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
Two BeansWrapperConfiguration-s are equal exactly if their classes are identical (==), and their field values are equal.
equals(Object) - Method in class freemarker.ext.dom.NodeModel
 
equals(Object) - Method in class freemarker.template.DefaultObjectWrapperConfiguration
 
equals(Object) - Method in class freemarker.template.Version
 
error(String) - Method in class freemarker.log.Logger
Logs an error message.
error(String, Throwable) - Method in class freemarker.log.Logger
Logs an error message with accompanying throwable.
escapePlainText(String) - Method in class freemarker.core.CombinedMarkupOutputFormat
 
escapePlainText(String) - Method in class freemarker.core.HTMLOutputFormat
 
escapePlainText(String) - Method in class freemarker.core.MarkupOutputFormat
Should give the same result as MarkupOutputFormat.fromPlainTextByEscaping(String) and then MarkupOutputFormat.getMarkupString(TemplateMarkupOutputModel), but the implementation may uses a more efficient solution.
escapePlainText(String) - Method in class freemarker.core.RTFOutputFormat
 
escapePlainText(String) - Method in class freemarker.core.XHTMLOutputFormat
 
escapePlainText(String) - Method in class freemarker.core.XMLOutputFormat
 
EVALUATE_BODY - Static variable in interface freemarker.template.TransformControl
Constant returned from TransformControl.onStart() that tells the template engine to evaluate the body.
EventForwarding - Class in freemarker.ext.jsp
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() - Constructor for class freemarker.ext.jsp.EventForwarding
 
exec(List) - Method in class freemarker.ext.beans.MapModel
The first argument is used as a key to call the map's get method.
exec(List) - Method in class freemarker.ext.beans.OverloadedMethodsModel
Invokes the method, passing it the arguments from the list.
exec(List) - Method in class freemarker.ext.beans.ResourceBundleModel
Takes first argument as a resource key, looks up a string in resource bundle with this key, then applies a MessageFormat.format on the string with the rest of the arguments.
exec(List) - Method in class freemarker.ext.beans.SimpleMapModel
 
exec(List) - Method in class freemarker.ext.beans.SimpleMethodModel
Invokes the method, passing it the arguments from the list.
exec(List) - Method in class freemarker.ext.dom.NodeModel
 
exec(List) - Method in class freemarker.ext.jdom.NodeListModel
Deprecated.
Applies an XPath expression to the node list and returns the resulting node list.
exec(List) - Method in class freemarker.ext.jython.JythonModel
 
exec(List) - Method in class freemarker.ext.rhino.RhinoFunctionModel
 
exec(List) - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
Evaluates an XPath expression on XML nodes in this model.
exec(List) - Method in interface freemarker.template.TemplateMethodModel
Deprecated.
Executes the method call.
exec(List) - Method in interface freemarker.template.TemplateMethodModelEx
Executes the method call.
exec(List) - Method in class freemarker.template.utility.Execute
Executes a method call.
exec(List) - Method in class freemarker.template.utility.ObjectConstructor
 
execute() - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
 
execute(Map) - Method in class freemarker.ext.ant.JythonAntTask
 
execute(String, Map) - Method in class freemarker.ext.ant.UnlinkedJythonOperationsImpl
 
execute(File, Map) - Method in class freemarker.ext.ant.UnlinkedJythonOperationsImpl
 
execute(Environment, Map, TemplateModel[], TemplateDirectiveBody) - Method in class freemarker.ext.servlet.IncludePage
 
execute(Environment, Map, TemplateModel[], TemplateDirectiveBody) - Method in interface freemarker.template.TemplateDirectiveModel
Executes this user-defined directive; called by FreeMarker when the user-defined directive is called in the template.
Execute - Class in freemarker.template.utility
Gives FreeMarker the the ability to execute external commands.
Execute() - Constructor for class freemarker.template.utility.Execute
 
executeQuery(Object, String) - Method in interface freemarker.ext.dom.XPathSupport
 
expectedTokenSequences - Variable in exception freemarker.core.ParseException
Each entry in this array is an array of integers.
explainTypeError(Class[]) - Method in class freemarker.ext.beans.SimpleMethodModel
Implementation of experimental interface; don't use it, no backward compatibility guarantee!
explainTypeError(Class[]) - Method in class freemarker.ext.dom.NodeModel
 
EXPOSE_ALL - Static variable in class freemarker.ext.beans.BeansWrapper
At this level of exposure, all methods and properties of the wrapped objects are exposed to the template.
EXPOSE_NOTHING - Static variable in class freemarker.ext.beans.BeansWrapper
At this level of exposure, no bean properties and methods are exposed.
EXPOSE_PROPERTIES_ONLY - Static variable in class freemarker.ext.beans.BeansWrapper
At this level of exposure, only property getters are exposed.
EXPOSE_SAFE - Static variable in class freemarker.ext.beans.BeansWrapper
At this level of exposure, all methods and properties of the wrapped objects are exposed to the template except methods that are deemed not safe.

F

FALSE - Static variable in interface freemarker.template.TemplateBooleanModel
A singleton object to represent boolean false
FALSE - Static variable in class freemarker.template.utility.Constants
 
FileExtensionMatcher - Class in freemarker.cache
Matches the file extension; unlike other matchers, by default case insensitive.
FileExtensionMatcher(String) - Constructor for class freemarker.cache.FileExtensionMatcher
 
FileNameGlobMatcher - Class in freemarker.cache
As opposed to PathGlobMatcher, it only compares the "file name" part (the part after the last /) of the source name with the given glob.
FileNameGlobMatcher(String) - Constructor for class freemarker.cache.FileNameGlobMatcher
 
FileTemplateLoader - Class in freemarker.cache
A TemplateLoader that uses files inside a specified directory as the source of templates.
FileTemplateLoader() - Constructor for class freemarker.cache.FileTemplateLoader
Deprecated.
Relying on what the current directory is is a bad practice; use FileTemplateLoader.FileTemplateLoader(File) instead.
FileTemplateLoader(File) - Constructor for class freemarker.cache.FileTemplateLoader
Creates a new file template loader that will use the specified directory as the base directory for loading templates.
FileTemplateLoader(File, boolean) - Constructor for class freemarker.cache.FileTemplateLoader
Creates a new file template loader that will use the specified directory as the base directory for loading templates.
finalizeConstruction(boolean) - Method in class freemarker.ext.beans.BeansWrapper
Meant to be called after BeansWrapper.BeansWrapper(BeansWrapperConfiguration, boolean, boolean) when its last argument was false; makes the instance read-only if necessary, then registers the model factories in the class introspector.
findTemplateSource(String) - Method in class freemarker.cache.ByteArrayTemplateLoader
 
findTemplateSource(String) - Method in class freemarker.cache.FileTemplateLoader
 
findTemplateSource(String) - Method in class freemarker.cache.MultiTemplateLoader
 
findTemplateSource(String) - Method in class freemarker.cache.StringTemplateLoader
 
findTemplateSource(String) - Method in interface freemarker.cache.TemplateLoader
Finds the template in the backing storage and returns an object that identifies the storage location where the template can be loaded from.
findTemplateSource(String) - Method in class freemarker.cache.URLTemplateLoader
 
findTemplateSource(String) - Method in class freemarker.cache.WebappTemplateLoader
 
finetuneMethodAppearance(Class<?>, Method, BeansWrapper.MethodAppearanceDecision) - Method in class freemarker.ext.beans.BeansWrapper
Deprecated.
Use BeansWrapper.setMethodAppearanceFineTuner(MethodAppearanceFineTuner); no need to extend this class anymore. Soon this method will be final, so trying to override it will break your app. Note that if the methodAppearanceFineTuner property is set to non-null, this method is not called anymore.
FirstMatchTemplateConfigurationFactory - Class in freemarker.cache
Returns the first non-null result of the child factories, ignoring all further child factories.
FirstMatchTemplateConfigurationFactory(TemplateConfigurationFactory...) - Constructor for class freemarker.cache.FirstMatchTemplateConfigurationFactory
 
flush() - Method in class freemarker.template.utility.NullWriter
 
format(TemplateDateModel) - Method in class freemarker.core.TemplateDateFormat
Formats the model to markup instead of to plain text if the result markup will be more than just plain text escaped, otherwise falls back to formatting to plain text.
format(TemplateNumberModel) - Method in class freemarker.core.TemplateNumberFormat
Formats the model to markup instead of to plain text if the result markup will be more than just plain text escaped, otherwise falls back to formatting to plain text.
format(String, Object[]) - Method in class freemarker.ext.beans.ResourceBundleModel
Provides direct access to caching format engine from code (instead of from script).
formatToPlainText(TemplateDateModel) - Method in class freemarker.core.TemplateDateFormat
 
formatToPlainText(TemplateNumberModel) - Method in class freemarker.core.TemplateNumberFormat
 
forName(String) - Static method in class freemarker.template.utility.ClassUtil
Similar to Class.forName(java.lang.String), but attempts to load through the thread context class loader.
freemarker.cache - package freemarker.cache
Template loading and caching.
freemarker.core - package freemarker.core
The seldom used or advanced parts of the fundamental FreeMarker API, compared to freemarker.template.
freemarker.debug - package freemarker.debug
Debugging API; experimental status, might change! This is to support debugging in IDE-s.
freemarker.ext.ant - package freemarker.ext.ant
Ant task to transform XML files with a template; a more powerful alternative is FMPP.
freemarker.ext.beans - package freemarker.ext.beans
The default object wrapper of FreeMarker uses this to expose Java Beans and POJO-s to templates.
freemarker.ext.dom - package freemarker.ext.dom
Exposes DOM XML nodes to templates as easily traversable trees; see in the Manual.
freemarker.ext.jdom - package freemarker.ext.jdom
Deprecated, use W3C DOM (freemarker.ext.dom) instead; Exposes JDOM XML nodes to templates.
freemarker.ext.jsp - package freemarker.ext.jsp
Classes for two-way FreeMarker-JSP integration.
freemarker.ext.jython - package freemarker.ext.jython
Exposes Jython objects to templates.
freemarker.ext.rhino - package freemarker.ext.rhino
Exposes Rhino (ECMAScript) objects to templates.
freemarker.ext.servlet - package freemarker.ext.servlet
Servlet for legacy "Model 2" frameworks that allows using FreeMarker templates instead of JSP as the MVC View (see in the Manual).
freemarker.ext.util - package freemarker.ext.util
Various classes used by freemarker.ext but might be useful outside it too.
freemarker.ext.xml - package freemarker.ext.xml
Deprecated, use W3C DOM with freemarker.ext.dom instead; Exposes XML from DOM, dom4j or JDOM nodes, uniformly.
freemarker.log - package freemarker.log
Logging facility; dispatches FreeMarker log messages to the chosen logger library.
freemarker.template - package freemarker.template
The fundamental, most commonly used API-s of FreeMarker; start with Configuration (see also the Getting Stared in the Manual.)
freemarker.template.utility - package freemarker.template.utility
Various classes used by core FreeMarker code but might be useful outside of it too.
FreemarkerServlet - Class in freemarker.ext.servlet
FreeMarker MVC View servlet that can be used similarly to JSP views.
FreemarkerServlet() - Constructor for class freemarker.ext.servlet.FreemarkerServlet
 
FreemarkerTag - Class in freemarker.ext.jsp
Simple implementation of JSP tag to allow use of FreeMarker templates in JSP.
FreemarkerTag() - Constructor for class freemarker.ext.jsp.FreemarkerTag
 
FreeMarkerTree - Class in freemarker.core
Deprecated.
Will be removed, as Swing classes aren't accessible on Google App Engine.
FreeMarkerTree(Template) - Constructor for class freemarker.core.FreeMarkerTree
Deprecated.
 
FreemarkerXmlTask - Class in freemarker.ext.ant
Deprecated.
FMPP is a more complete solution.
FreemarkerXmlTask() - Constructor for class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
Constructor creates the SAXBuilder.
fromMarkup(String) - Method in class freemarker.core.CommonMarkupOutputFormat
 
fromMarkup(String) - Method in class freemarker.core.MarkupOutputFormat
Wraps a String that's already markup to TemplateMarkupOutputModel interface, to indicate its format.
fromPlainTextByEscaping(String) - Method in class freemarker.core.CommonMarkupOutputFormat
 
fromPlainTextByEscaping(String) - Method in class freemarker.core.MarkupOutputFormat
Converts a String that's assumed to be plain text to TemplateMarkupOutputModel, by escaping any special characters in the plain text.
ftlQuote(String) - Static method in class freemarker.template.utility.StringUtil
Creates a quoted FTL string literal from a string, using escaping where necessary.
FTLStringLiteralDec(String) - Static method in class freemarker.template.utility.StringUtil
FTL string literal decoding.
FTLStringLiteralEnc(String, char) - Static method in class freemarker.template.utility.StringUtil
Escapes a string according the FTL string literal escaping rules, assuming the literal is quoted with quotation; it doesn't add the quotation marks itself.
FTLStringLiteralEnc(String) - Static method in class freemarker.template.utility.StringUtil
Escapes a string according the FTL string literal escaping rules; it doesn't add the quotation marks.

G

get(Object) - Method in interface freemarker.cache.CacheStorage
 
get(String, Object) - Method in class freemarker.cache.ConditionalTemplateConfigurationFactory
 
get(String, Object) - Method in class freemarker.cache.FirstMatchTemplateConfigurationFactory
 
get(String, Object) - Method in class freemarker.cache.MergingTemplateConfigurationFactory
 
get(Object) - Method in class freemarker.cache.MruCacheStorage
 
get(Object) - Method in class freemarker.cache.NullCacheStorage
 
get(Object) - Method in class freemarker.cache.SoftCacheStorage
 
get(Object) - Method in class freemarker.cache.StrongCacheStorage
 
get(String, Object) - Method in class freemarker.cache.TemplateConfigurationFactory
Returns (maybe creates) the TemplateConfiguration for the given template source.
get(String, int, Locale, TimeZone, boolean, Environment) - Method in class freemarker.core.AliasTemplateDateFormatFactory
 
get(String, Locale, Environment) - Method in class freemarker.core.AliasTemplateNumberFormatFactory
 
get(Environment) - Method in class freemarker.core.CustomAttribute
Gets the attribute from the appropriate scope that's accessible through the specified Environment.
get() - Method in class freemarker.core.CustomAttribute
Same as CustomAttribute.get(Environment), but uses Environment.getCurrentEnvironment() to fill the 2nd argument.
get(Template) - Method in class freemarker.core.CustomAttribute
Gets the value of a Template-scope attribute from the given Template.
get(TemplateConfiguration) - Method in class freemarker.core.CustomAttribute
get(Configuration) - Method in class freemarker.core.CustomAttribute
Gets the value of a Configuration-scope attribute from the given Configuration.
get(String, int, Locale, TimeZone, boolean, Environment) - Method in class freemarker.core.TemplateDateFormatFactory
Returns a formatter for the given parameters.
get(String, Locale, Environment) - Method in class freemarker.core.TemplateNumberFormatFactory
Returns a formatter for the given parameters.
get(int) - Method in interface freemarker.debug.DebugModel
 
get(int, int) - Method in interface freemarker.debug.DebugModel
 
get(String) - Method in interface freemarker.debug.DebugModel
 
get(String[]) - Method in interface freemarker.debug.DebugModel
 
get(int) - Method in class freemarker.ext.beans.ArrayModel
 
get(String) - Method in class freemarker.ext.beans.BeanModel
Uses Beans introspection to locate a property or method with name matching the key name.
get(int) - Method in class freemarker.ext.beans.CollectionModel
Retrieves the i-th object from the collection, wrapped as a TemplateModel.
get(Object) - Method in class freemarker.ext.beans.HashAdapter
 
get(int) - Method in class freemarker.ext.beans.OverloadedMethodsModel
 
get(String) - Method in class freemarker.ext.beans.SimpleMapModel
 
get(int) - Method in class freemarker.ext.beans.SimpleMethodModel
 
get(String) - Method in class freemarker.ext.dom.NodeModel
 
get(int) - Method in class freemarker.ext.dom.NodeModel
 
get(String) - Method in class freemarker.ext.jdom.NodeListModel
Deprecated.
Provides node list traversal as well as special functions: filtering by name, filtering by node type, shallow-copying, and duplicate removal.
get(int) - Method in class freemarker.ext.jdom.NodeListModel
Deprecated.
Retrieves the i-th element of the node list.
get(String) - Method in class freemarker.ext.jsp.TaglibFactory
Retrieves a JSP tag library identified by an URI.
get(String) - Method in class freemarker.ext.jython.JythonModel
Calls PyObject.__findattr__(java.lang.String), then if it returns null calls PyObject.__finditem__(java.lang.String).
get(int) - Method in class freemarker.ext.jython.JythonSequenceModel
Returns PyObject.__finditem__(int).
get(String) - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
get(int) - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
get(String) - Method in class freemarker.ext.servlet.AllHttpScopesHashModel
 
get(String) - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
get(String) - Method in class freemarker.ext.servlet.HttpRequestParametersHashModel
 
get(String) - Method in class freemarker.ext.servlet.HttpSessionHashModel
 
get(String) - Method in class freemarker.ext.servlet.ServletContextHashModel
 
get(Object) - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Returns the value to which this map maps the specified key.
get(int) - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
Selects a single node from this model's nodelist by its list index and returns a new NodeListModel containing that single node.
get(String) - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
Returns a new NodeListModel containing the nodes that result from applying an operator to this model's nodes.
get(int) - Method in class freemarker.template.DefaultListAdapter
 
get(String) - Method in class freemarker.template.DefaultMapAdapter
 
get(String) - Method in class freemarker.template.SimpleHash
 
get(int) - Method in class freemarker.template.SimpleSequence
Returns the item at the specified index of the list.
get(String) - Method in interface freemarker.template.TemplateHashModel
Gets a TemplateModel from the hash.
get(int) - Method in class freemarker.template.TemplateModelListSequence
 
get(int) - Method in interface freemarker.template.TemplateSequenceModel
Retrieves the i-th template model in this sequence.
get(TimeZone, Date) - Method in interface freemarker.template.utility.DateUtil.DateToISO8601CalendarFactory
Returns a GregorianCalendar with the desired time zone and time and US locale.
get(TimeZone, Date) - Method in class freemarker.template.utility.DateUtil.TrivialDateToISO8601CalendarFactory
 
get(String) - Method in class freemarker.template.utility.DOMNodeModel
 
getActualNamingConvention() - Method in class freemarker.template.Template
Returns the naming convention the parser has chosen for this template.
getActualTagSyntax() - Method in class freemarker.template.Template
Returns the tag syntax the parser has chosen for this template.
getAdaptedObject(Class<?>) - Method in class freemarker.ext.beans.BeanModel
Returns the same as BeanModel.getWrappedObject(); to ensure that, this method will be final starting from 2.4.
getAdaptedObject(Class) - Method in class freemarker.ext.beans.SimpleMapModel
 
getAdaptedObject(Class) - Method in class freemarker.ext.dom.NodeModel
 
getAdaptedObject(Class) - Method in class freemarker.ext.jython.JythonModel
 
getAdaptedObject(Class) - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
getAdaptedObject(Class<?>) - Method in interface freemarker.template.AdapterTemplateModel
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.
getAdaptedObject(Class) - Method in class freemarker.template.DefaultArrayAdapter
 
getAdaptedObject(Class<?>) - Method in class freemarker.template.DefaultEnumerationAdapter
 
getAdaptedObject(Class) - Method in class freemarker.template.DefaultIterableAdapter
 
getAdaptedObject(Class) - Method in class freemarker.template.DefaultIteratorAdapter
 
getAdaptedObject(Class) - Method in class freemarker.template.DefaultListAdapter
 
getAdaptedObject(Class) - Method in class freemarker.template.DefaultMapAdapter
 
getAdaptedObject(Class) - Method in class freemarker.template.DefaultNonListCollectionAdapter
 
getAllowNoMatch() - Method in class freemarker.cache.FirstMatchTemplateConfigurationFactory
getAPI() - Method in class freemarker.ext.beans.BeanModel
 
getAPI() - Method in class freemarker.ext.beans.SimpleMapModel
 
getAPI() - Method in class freemarker.template.DefaultEnumerationAdapter
 
getAPI() - Method in class freemarker.template.DefaultIterableAdapter
 
getAPI() - Method in class freemarker.template.DefaultIteratorAdapter
 
getAPI() - Method in class freemarker.template.DefaultListAdapter
 
getAPI() - Method in class freemarker.template.DefaultMapAdapter
 
getAPI() - Method in class freemarker.template.DefaultNonListCollectionAdapter
 
getAPI() - Method in interface freemarker.template.TemplateModelWithAPISupport
Returns the model that exposes the (Java) API of the value.
getArithmeticEngine() - Method in class freemarker.core.Configurable
getArithmeticEngine() - Method in interface freemarker.core.ParserConfiguration
Overlaps with Configurable.getArithmeticEngine(); the parser needs this for creating numerical literals.
getAsBoolean() - Method in interface freemarker.debug.DebugModel
 
getAsBoolean() - Method in class freemarker.ext.beans.BooleanModel
 
getAsBoolean() - Method in class freemarker.ext.beans.EnumerationModel
getAsBoolean() - Method in class freemarker.ext.beans.IteratorModel
getAsBoolean() - Method in class freemarker.ext.jython.JythonModel
Returns the value of PyObject.__nonzero__().
getAsBoolean() - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
getAsBoolean() - Method in interface freemarker.template.TemplateBooleanModel
 
getAsDate() - Method in interface freemarker.debug.DebugModel
 
getAsDate() - Method in class freemarker.ext.beans.DateModel
 
getAsDate() - Method in class freemarker.template.SimpleDate
 
getAsDate() - Method in interface freemarker.template.TemplateDateModel
Returns the date value.
getAsNumber() - Method in interface freemarker.debug.DebugModel
 
getAsNumber() - Method in class freemarker.ext.beans.NumberModel
 
getAsNumber() - Method in class freemarker.ext.jython.JythonNumberModel
Returns either PyObject.__tojava__(java.lang.Class) with Number.class as argument.
getAsNumber() - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
getAsNumber() - Method in class freemarker.template.SimpleNumber
 
getAsNumber() - Method in interface freemarker.template.TemplateNumberModel
Returns the numeric value.
getAsString() - Method in interface freemarker.debug.DebugModel
 
getAsString() - Method in class freemarker.ext.beans.StringModel
Returns the result of calling Object.toString() on the wrapped object.
getAsString() - Method in class freemarker.ext.jdom.NodeListModel
Deprecated.
This method returns the string resulting from concatenation of string representations of its nodes.
getAsString() - Method in class freemarker.ext.jython.JythonModel
Returns the value of Object.toString().
getAsString() - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
getAsString() - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
Returns the string representation of the wrapped nodes.
getAsString() - Method in class freemarker.template.LocalizedString
 
getAsString() - Method in class freemarker.template.SimpleScalar
 
getAsString() - Method in interface freemarker.template.TemplateScalarModel
Returns the string representation of this model.
getAttemptFileAccess() - Method in class freemarker.cache.WebappTemplateLoader
getAutoEscaping() - Method in class freemarker.template.Template
Returns if the template actually uses auto-escaping (see Configuration.setAutoEscapingPolicy(int)).
getAutoEscapingPolicy() - Method in interface freemarker.core.ParserConfiguration
getAutoEscapingPolicy() - Method in class freemarker.core.TemplateConfiguration
getAutoEscapingPolicy() - Method in class freemarker.template.Configuration
getAutoFlush() - Method in class freemarker.core.Configurable
getAutoImports() - Method in class freemarker.core.Configurable
Getter pair of Configurable.setAutoImports(Map); do not modify the returned Map! To be consistent with other setting getters, if this setting was set directly on this Configurable object, this simply returns that value, otherwise it returns the value from the parent Configurable.
getAutoImportsWithoutFallback() - Method in class freemarker.core.Configurable
Like Configurable.getAutoImports(), but doesn't fall back to the parent Configurable (and so it can be null).
getAutoIncludes() - Method in class freemarker.core.Configurable
Getter pair of Configurable.setAutoIncludes(List); do not modify the returned List! To be consistent with other setting getters, if this setting was set directly on this Configurable object, this simply returns that value, otherwise it returns the value from the parent Configurable.
getAutoIncludesWithoutFallback() - Method in class freemarker.core.Configurable
Like Configurable.getAutoIncludes(), but doesn't fall back to the parent Configurable (and so it can be null).
getBaseDirectory() - Method in class freemarker.cache.FileTemplateLoader
Returns the base directory in which the templates are searched.
getBasePackagePath() - Method in class freemarker.cache.ClassTemplateLoader
See the similar parameter of ClassTemplateLoader.ClassTemplateLoader(ClassLoader, String); note that this is a normalized version of what was actually passed to the constructor.
getBeginColumn() - Method in interface freemarker.core.DirectiveCallPlace
The 1-based column number of the first character of the directive call in the template source code, or -1 if it's not known.
getBeginLine() - Method in interface freemarker.core.DirectiveCallPlace
The 1-based line number of the first character of the directive call in the template source code, or -1 if it's not known.
getBlamedExpressionString() - Method in exception freemarker.template.TemplateException
If there was a blamed expression attached to this exception, it returns its canonical form, otherwise it returns null.
getBooleanFormat() - Method in class freemarker.core.Configurable
getBreakpoints() - Method in interface freemarker.debug.Debugger
Retrieves a list of all Breakpoint objects.
getBreakpoints(String) - Method in interface freemarker.debug.Debugger
Retrieves a list of all Breakpoint objects for the specified template.
getBuildDate() - Method in class freemarker.template.Version
 
getBundle() - Method in class freemarker.ext.beans.ResourceBundleModel
 
getCacheStorage() - Method in class freemarker.cache.TemplateCache
 
getCacheStorage() - Method in class freemarker.template.Configuration
getCaching() - Method in class freemarker.ext.jsp.FreemarkerTag
 
getCauseException() - Method in exception freemarker.template.TemplateException
Deprecated.
Java 1.4 has introduced Throwable.getCause() - use that instead, especially as this can't return runtime exceptions and errors as is.
getChildNodes() - Method in class freemarker.ext.dom.NodeModel
 
getChildNodes() - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
 
getChildNodes() - Method in interface freemarker.template.TemplateNodeModel
 
getClassicCompatibleAsInt() - Method in class freemarker.core.Configurable
 
getClassLoader() - Method in class freemarker.cache.ClassTemplateLoader
See the similar parameter of ClassTemplateLoader.ClassTemplateLoader(ClassLoader, String); null when other mechanism is used to load the resources.
getClasspathTlds() - Method in class freemarker.ext.jsp.TaglibFactory
getCNumberFormat() - Method in class freemarker.core.Environment
Returns the NumberFormat used for the c built-in.
getCollection() - Method in interface freemarker.debug.DebugModel
 
getColumnNumber() - Method in exception freemarker.core.ParseException
1-based column number of the failing section, or 0 is the information is not available.
getColumnNumber() - Method in exception freemarker.template.TemplateException
1-based column number of the failing section, or null if the information is not available.
getConfiguration() - Method in class freemarker.cache.TemplateConfigurationFactory
Returns the configuration this object belongs to, or null if it isn't yet bound to a Configuration.
getConfiguration() - Method in class freemarker.core.Environment
 
getConfiguration() - Method in class freemarker.ext.servlet.FreemarkerServlet
Returns the Configuration object used by this servlet.
getConfiguration() - Method in class freemarker.template.Template
Returns the Configuration object associated with this template.
getConstructorSpecifiedEncoding() - Method in exception freemarker.template.Template.WrongEncodingException
 
getContainingClass() - Method in class freemarker.ext.beans.BeansWrapper.MethodAppearanceDecisionInput
 
getCorrectedNameForUnknownSetting(String) - Method in class freemarker.core.Configurable
 
getCorrectedNameForUnknownSetting(String) - Method in class freemarker.template.Configuration
 
getCurrentDirectiveCallPlace() - Method in class freemarker.core.Environment
Gets the currently executing custom directive's call place information, or null if there's no executing custom directive.
getCurrentEnvironment() - Static method in class freemarker.core.Environment
Retrieves the environment object associated with the current thread, or null if there's no template processing going on in this thread.
getCurrentNamespace() - Method in class freemarker.core.Environment
Returns the current namespace.
getCurrentTemplate() - Method in class freemarker.core.Environment
Returns the Template that we are "lexically" inside at the moment.
getCurrentVisitorNode() - Method in class freemarker.core.Environment
 
getCustomAttribute(String) - Method in class freemarker.core.Configurable
Retrieves a named custom attribute for this configurable.
getCustomAttributeNames() - Method in class freemarker.core.Configurable
Returns an array with names of all custom attributes defined directly on this configurable.
getCustomDateFormat(String) - Method in class freemarker.core.Configurable
Gets the custom name format registered for the name.
getCustomDateFormats() - Method in class freemarker.core.Configurable
Getter pair of Configurable.setCustomDateFormats(Map); do not modify the returned Map! To be consistent with other setting getters, if this setting was set directly on this Configurable object, this simply returns that value, otherwise it returns the value from the parent Configurable.
getCustomDateFormatsWithoutFallback() - Method in class freemarker.core.Configurable
Like Configurable.getCustomDateFormats(), but doesn't fall back to the parent Configurable, nor does it provide a non-null default when called as the method of a Configuration.
getCustomLookupCondition() - Method in class freemarker.cache.TemplateLookupContext
Returns the value of the customLookupCondition parameter of Configuration.getTemplate(String, Locale, Object, String, boolean, boolean); see requirements there, such as having a proper Object.equals(Object) and Object.hashCode() method.
getCustomLookupCondition() - Method in class freemarker.template.Template
Gets the custom lookup condition with which this template was found.
getCustomLookupCondition() - Method in exception freemarker.template.TemplateNotFoundException
The custom lookup condition with which the template was requested, or null if there's no such condition.
getCustomNumberFormat(String) - Method in class freemarker.core.Configurable
Gets the custom name format registered for the name.
getCustomNumberFormats() - Method in class freemarker.core.Configurable
Getter pair of Configurable.setCustomNumberFormats(Map); do not modify the returned Map! To be consistent with other setting getters, if this setting was set directly on this Configurable object, this simply returns that value, otherwise it returns the value from the parent Configurable.
getCustomNumberFormatsWithoutFallback() - Method in class freemarker.core.Configurable
Like Configurable.getCustomNumberFormats(), but doesn't fall back to the parent Configurable.
getCustomState(Object) - Method in class freemarker.core.Environment
Returns the value of a custom state variable, or null if it's missing; see Environment.setCustomState(Object, Object) for more.
getDataModel() - Method in class freemarker.core.Environment
Returns the data-model (also known as the template context in some other template engines).
getDateFormat() - Method in class freemarker.core.Configurable
getDateTimeFormat() - Method in class freemarker.core.Configurable
getDateType() - Method in interface freemarker.debug.DebugModel
 
getDateType() - Method in class freemarker.ext.beans.DateModel
 
getDateType() - Method in class freemarker.template.SimpleDate
 
getDateType() - Method in interface freemarker.template.TemplateDateModel
Returns the type of the date.
getDebugger(InetAddress, int, String) - Static method in class freemarker.debug.DebuggerClient
Connects to the FreeMarker debugger service running on a specific host and port.
getDefaultConfiguration() - Static method in class freemarker.template.Configuration
Deprecated.
The usage of the static singleton (the "default") Configuration instance can easily cause erroneous, unpredictable behavior. This is because multiple independent software components may use FreeMarker internally inside the same application, so they will interfere because of the common Configuration instance. Each such component should use its own private Configuration object instead, that it typically creates with new Configuration() when the component is initialized.
getDefaultDateType() - Method in class freemarker.ext.beans.BeansWrapper
Returns the default date type.
getDefaultDateType() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
getDefaultEncoding() - Method in class freemarker.template.Configuration
Gets the default encoding for converting bytes to characters when reading template files in a locale for which no explicit encoding was specified.
getDefaultInstance() - Static method in class freemarker.ext.beans.BeansWrapper
Deprecated.
Use BeansWrapperBuilder instead. The instance returned here is not read-only, so it's dangerous to use.
getDefaultNS() - Method in class freemarker.core.Environment
 
getDefaultNS() - Method in class freemarker.template.Template
 
getDefaultObjectWrapper(Version) - Static method in class freemarker.template.Configuration
Returns the default object wrapper for a given "incompatible_improvements" version.
getDefaultObjectWrapper() - Static method in class freemarker.template.WrappingTemplateModel
Deprecated.
Don't depend on this object, as it can be replace by anybody in the same JVM.
getDefaultOverrideResponseContentType() - Method in class freemarker.ext.servlet.FreemarkerServlet
Returns the default value of the "OverrideResponseContentType" Servlet init-param.
getDelay() - Method in class freemarker.cache.TemplateCache
Gets the delay in milliseconds between checking for newer versions of a template source.
getDescription() - Method in class freemarker.core.TemplateValueFormat
Meant to be used in error messages to tell what format the parsed string didn't fit.
getDocumentBuilderFactory() - Static method in class freemarker.ext.dom.NodeModel
Returns the DOM parser implementation that is used when building NodeModel objects from XML files or from InputStream with the static convenience methods of NodeModel.
getEditorMessage() - Method in exception freemarker.core.ParseException
Returns the description of the error without error location or source quotations, or null if there's no description available.
getEmulateCaseSensitiveFileSystem() - Method in class freemarker.cache.FileTemplateLoader
getEmulateCaseSensitiveFileSystemDefault() - Method in class freemarker.cache.FileTemplateLoader
getEncoding() - Method in class freemarker.core.TemplateConfiguration
 
getEncoding(Locale) - Method in class freemarker.template.Configuration
Gets the preferred character encoding for the given locale, or the default encoding if no encoding is set explicitly for the specified locale.
getEncoding() - Method in class freemarker.template.Template
Returns the default character encoding used for reading included files.
getEndColumn() - Method in interface freemarker.core.DirectiveCallPlace
The 1-based column number of the last character of the directive call in the template source code, or -1 if it's not known.
getEndColumnNumber() - Method in exception freemarker.core.ParseException
1-based column number of the last character of the failing section, or 0 if the information is not available.
getEndColumnNumber() - Method in exception freemarker.template.TemplateException
1-based column number of the last character of the failing template section, or null if the information is not available.
getEndLine() - Method in interface freemarker.core.DirectiveCallPlace
The 1-based line number of the last character of the directive call in the template source code, or -1 if it's not known.
getEndLineNumber() - Method in exception freemarker.core.ParseException
1-based line number of the last line that contains the failing section, or 0 if the information is not available.
getEndLineNumber() - Method in exception freemarker.template.TemplateException
1-based line number of the last line that contains the failing section, or null if the information is not available.
getEnumModels() - Method in class freemarker.ext.beans.BeansWrapper
Returns a hash model that represents the so-called class enum models.
getEnvironment() - Method in class freemarker.core.Configurable
 
getEnvironment() - Method in class freemarker.debug.EnvironmentSuspendedEvent
The environment that was suspended
getEnvironment() - Method in exception freemarker.template.TemplateException
 
getErrorHandler() - Static method in class freemarker.ext.dom.NodeModel
 
getExposeAsProperty() - Method in class freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision
 
getExposeFields() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
getExposeMethodAs() - Method in class freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision
 
getExposureLevel() - Method in class freemarker.ext.beans.BeansWrapper
 
getExposureLevel() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
getExtraInfo() - Method in class freemarker.template.Version
The arbitrary string after the micro version number without leading dot, dash or underscore, like "RC03" in "2.4.0-RC03".
getForceLegacyNonListCollections() - Method in class freemarker.template.DefaultObjectWrapper
getForceLegacyNonListCollections() - Method in class freemarker.template.DefaultObjectWrapperConfiguration
getFTLInstructionStack() - Method in exception freemarker.template.TemplateException
Returns the snapshot of the FTL stack trace at the time this exception was created.
getFTLTypeDescription(TemplateModel) - Static method in class freemarker.template.utility.ClassUtil
Returns the type description of a value with FTL terms (not plain class name), as it should be used in type-related error messages and for debugging purposes.
getFullTemplatePath(Environment, String, String) - Static method in class freemarker.cache.TemplateCache
Deprecated.
Use Environment.toFullTemplateName(String, String) instead, as that can throw MalformedTemplateNameException, and is on a more logical place anyway.
getGlobalNamespace() - Method in class freemarker.core.Environment
Returns the name-space that contains the globally visible non-data-model variables (usually created with &lt;#global ...&gt;).
getGlobalVariable(String) - Method in class freemarker.core.Environment
Returns the globally visible variable of the given name (or null).
getGlobalVariables() - Method in class freemarker.core.Environment
Returns the read-only hash of globally visible variables.
getId() - Method in interface freemarker.debug.DebuggedEnvironment
Returns a unique identifier for this environment
getImports() - Method in class freemarker.template.Template
Deprecated.
Should only be used internally, and might will be removed later.
getIncompatibleEnhancements() - Method in class freemarker.template.Configuration
getIncompatibleImprovements() - Method in interface freemarker.core.ParserConfiguration
getIncompatibleImprovements() - Method in class freemarker.core.TemplateConfiguration
getIncompatibleImprovements() - Method in class freemarker.ext.beans.BeansWrapper
Returns the version given with BeansWrapper.BeansWrapper(Version), normalized to the lowest version where a change has occurred.
getIncompatibleImprovements() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
getIncompatibleImprovements() - Method in class freemarker.template.Configuration
 
getInnerOutputFormat() - Method in class freemarker.core.CombinedMarkupOutputFormat
 
getInstance(Object, ModelFactory) - Method in class freemarker.ext.beans.BeansWrapper
Deprecated.
override BeansWrapper.getModelFactory(Class) instead. Using this method will now bypass wrapper caching (if it's enabled) and always result in creation of a new wrapper. This method will be removed in 2.4
getInstance(Object) - Method in class freemarker.ext.util.ModelCache
 
getIterableSupport() - Method in class freemarker.template.DefaultObjectWrapper
getIterableSupport() - Method in class freemarker.template.DefaultObjectWrapperConfiguration
getKey() - Method in interface freemarker.template.TemplateHashModelEx2.KeyValuePair
 
getKnownVariableNames() - Method in class freemarker.core.Environment
Returns a set of variable names that are known at the time of call.
getLastModified(Object) - Method in class freemarker.cache.ByteArrayTemplateLoader
 
getLastModified(Object) - Method in class freemarker.cache.FileTemplateLoader
 
getLastModified(Object) - Method in class freemarker.cache.MultiTemplateLoader
 
getLastModified(Object) - Method in class freemarker.cache.StringTemplateLoader
 
getLastModified(Object) - Method in interface freemarker.cache.TemplateLoader
Returns the time of last modification of the specified template source.
getLastModified(Object) - Method in class freemarker.cache.URLTemplateLoader
 
getLastModified(Object) - Method in class freemarker.cache.WebappTemplateLoader
 
getLazyAutoImports() - Method in class freemarker.core.Configurable
getLazyImports() - Method in class freemarker.core.Configurable
getLine() - Method in class freemarker.debug.Breakpoint
Returns the line number of the breakpoint
getLine() - Method in class freemarker.debug.EnvironmentSuspendedEvent
The line number in the template where the execution of the environment was suspended.
getLineNumber() - Method in exception freemarker.core.ParseException
1-based line number of the failing section, or 0 is the information is not available.
getLineNumber() - Method in exception freemarker.template.TemplateException
1-based line number of the failing section, or null if the information is not available.
getLocale() - Method in class freemarker.core.Configurable
getLocalizedLookup() - Method in class freemarker.cache.TemplateCache
Returns if localized template lookup is enabled or not.
getLocalizedLookup() - Method in class freemarker.template.Configuration
getLocalizedString(Locale) - Method in class freemarker.template.LocalizedString
 
getLocalizedString(Locale) - Method in class freemarker.template.ResourceBundleLocalizedString
 
getLocalVariable(String) - Method in class freemarker.core.Environment
Returns the loop or macro local variable corresponding to this variable name.
getLocationString() - Method in class freemarker.debug.Breakpoint
Returns the template name and the line number separated with a colon
getLogger(String) - Static method in class freemarker.log.Logger
Returns a logger for the specified category.
getLogTemplateExceptions() - Method in class freemarker.core.Configurable
getMacros() - Method in class freemarker.template.Template
Deprecated.
Should only be used internally, and might will be removed later.
getMainNamespace() - Method in class freemarker.core.Environment
Returns the main namespace.
getMainTemplate() - Method in class freemarker.core.Environment
Returns the topmost Template, with other words, the one for which this Environment was created.
getMajor() - Method in class freemarker.template.Version
The 1st version number, like 1 in "1.2.3".
getMalformednessDescription() - Method in exception freemarker.template.MalformedTemplateNameException
 
getMarkupString(MO) - Method in class freemarker.core.CommonMarkupOutputFormat
 
getMarkupString(MO) - Method in class freemarker.core.MarkupOutputFormat
Returns the content as markup text; never null.
getMessage() - Method in exception freemarker.core.ParseException
Returns the error location plus the error description.
getMessage() - Method in exception freemarker.template.Template.WrongEncodingException
 
getMessage() - Method in exception freemarker.template.TemplateException
 
getMessageWithoutStackTop() - Method in exception freemarker.template.TemplateException
Similar to TemplateException.getMessage(), but it doesn't contain the position of the failing instruction at then end of the text.
getMetaInfTldSources() - Method in class freemarker.ext.jsp.TaglibFactory
getMethod() - Method in class freemarker.ext.beans.BeansWrapper.MethodAppearanceDecisionInput
 
getMethodAppearanceFineTuner() - Method in class freemarker.ext.beans.BeansWrapper
 
getMethodAppearanceFineTuner() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
getMethodShadowsProperty() - Method in class freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision
 
getMicro() - Method in class freemarker.template.Version
The 3rd version number, like 3 in "1.2.3".
getMimeType() - Method in class freemarker.core.CombinedMarkupOutputFormat
 
getMimeType() - Method in class freemarker.core.CSSOutputFormat
 
getMimeType() - Method in class freemarker.core.HTMLOutputFormat
 
getMimeType() - Method in class freemarker.core.JavaScriptOutputFormat
 
getMimeType() - Method in class freemarker.core.JSONOutputFormat
 
getMimeType() - Method in class freemarker.core.OutputFormat
Returns the MIME type of the output format.
getMimeType() - Method in class freemarker.core.PlainTextOutputFormat
 
getMimeType() - Method in class freemarker.core.RTFOutputFormat
 
getMimeType() - Method in class freemarker.core.UndefinedOutputFormat
 
getMimeType() - Method in class freemarker.core.XHTMLOutputFormat
 
getMimeType() - Method in class freemarker.core.XMLOutputFormat
 
getMinor() - Method in class freemarker.template.Version
The 2nd version number, like 2 in "1.2.3".
getMissingTemplateNormalizedName() - Method in class freemarker.cache.TemplateCache.MaybeMissingTemplate
When the template was missing, this possibly contains its normalized name.
getMissingTemplateReason() - Method in class freemarker.cache.TemplateCache.MaybeMissingTemplate
When the template was missing, this possibly contains the explanation, or null.
getModelFactory(Class<?>) - Method in class freemarker.ext.beans.BeansWrapper
 
getModelFactory(Class) - Method in class freemarker.ext.rhino.RhinoWrapper
 
getModelTypes() - Method in interface freemarker.debug.DebugModel
 
getName() - Method in class freemarker.core.CombinedMarkupOutputFormat
 
getName() - Method in class freemarker.core.CSSOutputFormat
 
getName() - Method in class freemarker.core.HTMLOutputFormat
 
getName() - Method in class freemarker.core.JavaScriptOutputFormat
 
getName() - Method in class freemarker.core.JSONOutputFormat
 
getName() - Method in class freemarker.core.OutputFormat
The short name used to refer to this format (like in the #ftl header).
getName() - Method in class freemarker.core.PlainTextOutputFormat
 
getName() - Method in class freemarker.core.RTFOutputFormat
 
getName() - Method in class freemarker.core.UndefinedOutputFormat
 
getName() - Method in class freemarker.core.XHTMLOutputFormat
 
getName() - Method in class freemarker.core.XMLOutputFormat
 
getName() - Method in class freemarker.debug.EnvironmentSuspendedEvent
The name of the template where the execution of the environment was suspended
getName() - Method in class freemarker.template.Template
The usually path-like (or URL-like) identifier of the template, or possibly null for non-stored templates.
getNamespace(String) - Method in class freemarker.core.Environment
Returns the name-space for the name if exists, or null.
getNamespaceForPrefix(String) - Method in class freemarker.core.Environment
 
getNamespaceForPrefix(String) - Method in class freemarker.template.Template
 
getNamingConvention() - Method in interface freemarker.core.ParserConfiguration
getNamingConvention() - Method in class freemarker.core.TemplateConfiguration
getNamingConvention() - Method in class freemarker.template.Configuration
getNewBuiltinClassResolver() - Method in class freemarker.core.Configurable
Retrieves the TemplateClassResolver used to resolve classes when "SomeClassName"?new is called in a template.
getNextSibling() - Method in class freemarker.ext.dom.NodeModel
 
getNextSibling() - Method in interface freemarker.template.TemplateNodeModelEx
 
getNode() - Method in class freemarker.ext.dom.NodeModel
 
getNodeName() - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
 
getNodeName() - Method in interface freemarker.template.TemplateNodeModel
 
getNodeNamespace() - Method in class freemarker.ext.dom.NodeModel
 
getNodeNamespace() - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
 
getNodeNamespace() - Method in interface freemarker.template.TemplateNodeModel
 
getNodeType() - Method in class freemarker.ext.dom.NodeModel
 
getNodeType() - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
 
getNodeType() - Method in interface freemarker.template.TemplateNodeModel
 
getNoMatchErrorDetails() - Method in class freemarker.cache.FirstMatchTemplateConfigurationFactory
Use this to specify the text added to the exception error message when there was no matching choice.
getNonNullDate(TemplateDateModel) - Static method in class freemarker.core.TemplateFormatUtil
Utility method to extract the Date from an TemplateDateModel, and throw TemplateModelException with a standard error message if that's null.
getNonNullNumber(TemplateNumberModel) - Static method in class freemarker.core.TemplateFormatUtil
Utility method to extract the Number from an TemplateNumberModel, and throws TemplateModelException with a standard error message if that's null.
getNumberFormat() - Method in class freemarker.core.Configurable
getObjectWrapper() - Method in class freemarker.core.Configurable
getObjectWrapper() - Method in class freemarker.ext.jsp.TaglibFactory
getObjectWrapper() - Method in class freemarker.ext.servlet.FreemarkerServlet
Should be final; don't override it.
getObjectWrapper() - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
getObjectWrapper() - Method in class freemarker.template.WrappingTemplateModel
Returns the object wrapper instance used by this wrapping template model.
getOrCreateCustomData(Object, ObjectFactory) - Method in interface freemarker.core.DirectiveCallPlace
Returns the custom data, or if that's null, then it creates and stores it in an atomic operation then returns it.
getOut() - Method in class freemarker.core.Environment
 
getOuterIdentity() - Method in class freemarker.ext.beans.BeansWrapper
By default returns this.
getOuterIdentity() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
getOuterOutputFormat() - Method in class freemarker.core.CombinedMarkupOutputFormat
 
getOutputEncoding() - Method in class freemarker.core.Configurable
 
getOutputFormat() - Method in class freemarker.core.CommonTemplateMarkupOutputModel
 
getOutputFormat() - Method in interface freemarker.core.ParserConfiguration
getOutputFormat() - Method in class freemarker.core.TemplateCombinedMarkupOutputModel
 
getOutputFormat() - Method in class freemarker.core.TemplateConfiguration
getOutputFormat() - Method in class freemarker.core.TemplateHTMLOutputModel
 
getOutputFormat() - Method in interface freemarker.core.TemplateMarkupOutputModel
Returns the singleton OutputFormat object that implements the operations for the "markup output" value.
getOutputFormat() - Method in class freemarker.core.TemplateRTFOutputModel
 
getOutputFormat() - Method in class freemarker.core.TemplateXHTMLOutputModel
 
getOutputFormat() - Method in class freemarker.core.TemplateXMLOutputModel
 
getOutputFormat() - Method in class freemarker.template.Configuration
getOutputFormat(String) - Method in class freemarker.template.Configuration
Returns the output format for a name.
getOutputFormat() - Method in class freemarker.template.Template
Returns the output format (see Configuration.setOutputFormat(OutputFormat)) used for this template.
getParent() - Method in class freemarker.core.Configurable
Returns the parent Configurable object of this object.
getParent() - Method in class freemarker.ext.jsp.FreemarkerTag
 
getParentConfiguration() - Method in class freemarker.core.TemplateConfiguration
Returns the parent Configuration, or null if none was associated yet.
getParentNode() - Method in class freemarker.ext.dom.NodeModel
 
getParentNode() - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
 
getParentNode() - Method in interface freemarker.template.TemplateNodeModel
 
getParsedIncompatibleEnhancements() - Method in class freemarker.template.Configuration
getParserConfiguration() - Method in class freemarker.template.Template
Returns the ParserConfiguration that was used for parsing this template.
getPlainTextTemplate(String, String, Configuration) - Static method in class freemarker.template.Template
getPlainTextTemplate(String, String, String, Configuration) - Static method in class freemarker.template.Template
Creates (not "get"-s) a Template that only contains a single block of static text, no dynamic content.
getPrefixedName(String, String) - Method in class freemarker.template.Template
 
getPrefixForNamespace(String) - Method in class freemarker.core.Environment
 
getPrefixForNamespace(String) - Method in class freemarker.template.Template
 
getPreviousSibling() - Method in class freemarker.ext.dom.NodeModel
 
getPreviousSibling() - Method in interface freemarker.template.TemplateNodeModelEx
 
getPythonClassName(PyObject) - Method in class freemarker.ext.jython.JythonVersionAdapter
Returns pyObject.__class__.__name__
getReader(Object, String) - Method in class freemarker.cache.ByteArrayTemplateLoader
 
getReader(Object, String) - Method in class freemarker.cache.FileTemplateLoader
 
getReader(Object, String) - Method in class freemarker.cache.MultiTemplateLoader
 
getReader(Object, String) - Method in class freemarker.cache.StringTemplateLoader
 
getReader(Object, String) - Method in interface freemarker.cache.TemplateLoader
Returns the character stream of a template represented by the specified template source.
getReader(Object, String) - Method in class freemarker.cache.URLTemplateLoader
 
getReader(Object, String) - Method in class freemarker.cache.WebappTemplateLoader
 
getRecognizeStandardFileExtensions() - Method in interface freemarker.core.ParserConfiguration
getRecognizeStandardFileExtensions() - Method in class freemarker.core.TemplateConfiguration
getRecognizeStandardFileExtensions() - Method in class freemarker.template.Configuration
getRegisteredCustomOutputFormats() - Method in class freemarker.template.Configuration
getRequest() - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
getResourceLoaderClass() - Method in class freemarker.cache.ClassTemplateLoader
See the similar parameter of ClassTemplateLoader.ClassTemplateLoader(Class, String); null when other mechanism is used to load the resources.
getResponse() - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
getRootContainerPattern() - Method in class freemarker.ext.jsp.TaglibFactory.ClasspathMetaInfTldSource
See constructor argument: #ClasspathMetaInfTldSource(Pattern).
getRootTreeNode() - Method in class freemarker.template.Template
Deprecated.
Should only be used internally, and might will be removed later.
getServlet() - Method in class freemarker.ext.servlet.ServletContextHashModel
Returns the underlying servlet.
getSetting(String) - Method in class freemarker.core.Configurable
Deprecated.
It's not possible in general to convert setting values to string, and thus it's impossible to ensure that Configurable.setSetting(String, String) will work with the returned value correctly.
getSettingNames(boolean) - Method in class freemarker.core.Configurable
Returns the valid setting names that aren't Configuration-only.
getSettingNames(boolean) - Method in class freemarker.template.Configuration
Returns the valid Configuration setting names.
getSettings() - Method in class freemarker.core.Configurable
Deprecated.
This method was always defective, and certainly it always will be. Don't use it. (Simply, it's hardly possible in general to convert setting values to text in a way that ensures that Configurable.setSettings(Properties) will work with them correctly.)
getSharedVariable(String) - Method in class freemarker.template.Configuration
Gets a shared variable.
getSharedVariableNames() - Method in class freemarker.template.Configuration
Returns the set containing the names of all defined shared sharedVariables.
getShortClassName(Class) - Static method in class freemarker.template.utility.ClassUtil
getShortClassName(Class, boolean) - Static method in class freemarker.template.utility.ClassUtil
Returns a class name without "java.lang." and "java.util." prefix, also shows array types in a format like int[]; useful for printing class names in error messages.
getShortClassNameOfObject(Object) - Static method in class freemarker.template.utility.ClassUtil
getShortClassNameOfObject(Object, boolean) - Static method in class freemarker.template.utility.ClassUtil
ClassUtil.getShortClassName(Class, boolean) called with object.getClass(), but returns the fictional class name Null for a null value.
getShowErrorTips() - Method in class freemarker.core.Configurable
getSignum(Number) - Static method in class freemarker.template.utility.NumberUtil
 
getSize() - Method in interface freemarker.cache.CacheStorageWithGetSize
Returns the current number of cache entries.
getSize() - Method in class freemarker.cache.MruCacheStorage
Returns a close approximation of the current number of cache entries.
getSize() - Method in class freemarker.cache.NullCacheStorage
Always returns 0.
getSize() - Method in class freemarker.cache.SoftCacheStorage
Returns a close approximation of the number of cache entries.
getSize() - Method in class freemarker.cache.StrongCacheStorage
Returns a close approximation of the number of cache entries.
getSoftSize() - Method in class freemarker.cache.MruCacheStorage
Returns a close approximation of the current number of soft cache entries.
getSoftSizeLimit() - Method in class freemarker.cache.MruCacheStorage
Returns the configured upper limit of the number of soft cache entries.
getSource(int, int, int, int) - Method in class freemarker.template.Template
Returns the template source at the location specified by the coordinates given, or null if unavailable.
getSourceName() - Method in class freemarker.template.Template
The name that was actually used to load this template from the TemplateLoader (or from other custom storage mechanism).
getSourcePlainText(MO) - Method in class freemarker.core.CommonMarkupOutputFormat
 
getSourcePlainText(MO) - Method in class freemarker.core.MarkupOutputFormat
If this TemplateMarkupOutputModel was created with MarkupOutputFormat.fromPlainTextByEscaping(String), it returns the original plain text, otherwise it returns null.
getSQLDateAndTimeTimeZone() - Method in class freemarker.core.Configurable
getStaticModels() - Method in class freemarker.ext.beans.BeansWrapper
Returns a hash model that represents the so-called class static models.
getStrictSyntaxMode() - Method in interface freemarker.core.ParserConfiguration
getStrictSyntaxMode() - Method in class freemarker.core.TemplateConfiguration
getStrictSyntaxMode() - Method in class freemarker.template.Configuration
getStrongSize() - Method in class freemarker.cache.MruCacheStorage
Returns the current number of strong cache entries.
getStrongSizeLimit() - Method in class freemarker.cache.MruCacheStorage
Returns the configured upper limit of the number of strong cache entries.
getSupportedBuiltInDirectiveNames() - Method in class freemarker.template.Configuration
getSupportedBuiltInDirectiveNames(int) - Method in class freemarker.template.Configuration
Returns the names of the directives that are predefined by FreeMarker.
getSupportedBuiltInNames() - Method in class freemarker.template.Configuration
getSupportedBuiltInNames(int) - Method in class freemarker.template.Configuration
Returns the names of the supported "built-ins".
getSupportsIndexedAccess() - Method in class freemarker.ext.beans.CollectionModel
Tells if CollectionModel.get(int) will always fail for this object.
getSuspendedEnvironments() - Method in interface freemarker.debug.Debugger
Retrieves a collection of all DebuggedEnvironment objects that are currently suspended.
getSystemProperty(String) - Static method in class freemarker.template.utility.SecurityUtilities
 
getSystemProperty(String, String) - Static method in class freemarker.template.utility.SecurityUtilities
 
getSystemProperty(String, int) - Static method in class freemarker.template.utility.SecurityUtilities
 
getTabSize() - Method in interface freemarker.core.ParserConfiguration
getTabSize() - Method in class freemarker.core.TemplateConfiguration
getTabSize() - Method in class freemarker.template.Configuration
The getter pair of Configuration.setTabSize(int).
getTagSyntax() - Method in interface freemarker.core.ParserConfiguration
getTagSyntax() - Method in class freemarker.core.TemplateConfiguration
getTagSyntax() - Method in class freemarker.template.Configuration
getTemplate(String, Locale, Object, String, boolean) - Method in class freemarker.cache.TemplateCache
Retrieves the template with the given name (and according the specified further parameters) from the template cache, loading it into the cache first if it's missing/staled.
getTemplate(String, Locale, String, boolean) - Method in class freemarker.cache.TemplateCache
Deprecated.
Use TemplateCache.getTemplate(String, Locale, Object, String, boolean), which can return more detailed result when the template is missing.
getTemplate() - Method in class freemarker.cache.TemplateCache.MaybeMissingTemplate
The Template if it wasn't missing, otherwise null.
getTemplate() - Method in class freemarker.core.Environment
Deprecated.
Use Environment.getMainTemplate() instead (or Environment.getCurrentNamespace() and then Environment.Namespace.getTemplate()); the value returned by this method is often not what you expect when it comes to macro/function invocations.
getTemplate() - Method in class freemarker.core.Environment.Namespace
 
getTemplate(String) - Method in class freemarker.template.Configuration
Retrieves the template with the given name from the template cache, loading it into the cache first if it's missing/staled.
getTemplate(String, Locale) - Method in class freemarker.template.Configuration
getTemplate(String, String) - Method in class freemarker.template.Configuration
getTemplate(String, Locale, String) - Method in class freemarker.template.Configuration
getTemplate(String, Locale, String, boolean) - Method in class freemarker.template.Configuration
getTemplate(String, Locale, String, boolean, boolean) - Method in class freemarker.template.Configuration
getTemplate(String, Locale, Object, String, boolean, boolean) - Method in class freemarker.template.Configuration
Retrieves the template with the given name (and according the specified further parameters) from the template cache, loading it into the cache first if it's missing/staled.
getTemplateConfigurations() - Method in class freemarker.cache.TemplateCache
 
getTemplateConfigurations() - Method in class freemarker.template.Configuration
getTemplateDateFormat(int, Class<? extends Date>) - Method in class freemarker.core.Environment
Gets a TemplateDateFormat using the date/time/datetime format settings and the current locale and time zone.
getTemplateDateFormat(String, int, Class<? extends Date>) - Method in class freemarker.core.Environment
Gets a TemplateDateFormat for the specified format string and the current locale and time zone.
getTemplateDateFormat(String, int, Class<? extends Date>, Locale) - Method in class freemarker.core.Environment
Like Environment.getTemplateDateFormat(String, int, Class), but allows you to use a different locale than the current one.
getTemplateDateFormat(String, int, Class<? extends Date>, Locale, TimeZone, TimeZone) - Method in class freemarker.core.Environment
Like Environment.getTemplateDateFormat(String, int, Class), but allows you to use a different locale and time zone than the current one.
getTemplateDateFormat(String, int, Locale, TimeZone, boolean) - Method in class freemarker.core.Environment
Gets a TemplateDateFormat for the specified parameters.
getTemplateExceptionHandler() - Method in class freemarker.core.Configurable
getTemplateForImporting(String) - Method in class freemarker.core.Environment
getTemplateForInclusion(String, String, boolean) - Method in class freemarker.core.Environment
getTemplateForInclusion(String, String, boolean, boolean) - Method in class freemarker.core.Environment
Gets a template for inclusion; used for implementing Environment.include(Template includedTemplate).
getTemplateLoader(int) - Method in class freemarker.cache.MultiTemplateLoader
Returns the TemplateLoader at the given index.
getTemplateLoader() - Method in class freemarker.cache.TemplateCache
 
getTemplateLoader() - Method in class freemarker.template.Configuration
getTemplateLoaderCount() - Method in class freemarker.cache.MultiTemplateLoader
Returns the number of TemplateLoader-s directly inside this TemplateLoader.
getTemplateLocale() - Method in class freemarker.cache.TemplateLookupContext
null if localized lookup is disabled (see Configuration.getLocalizedLookup()), otherwise the locale requested.
getTemplateLookupStrategy() - Method in class freemarker.cache.TemplateCache
 
getTemplateLookupStrategy() - Method in class freemarker.template.Configuration
getTemplateModel() - Method in class freemarker.ext.beans.HashAdapter
 
getTemplateModel() - Method in interface freemarker.template.TemplateModelAdapter
 
getTemplateName() - Method in class freemarker.cache.TemplateLookupContext
The normalized name (path) of the template (relatively to the TemplateLoader).
getTemplateName() - Method in exception freemarker.core.ParseException
Returns the name (template-root relative path) of the template whose parsing was failed.
getTemplateName() - Method in class freemarker.debug.Breakpoint
Returns the template name of the breakpoint
getTemplateName() - Method in exception freemarker.template.MalformedTemplateNameException
 
getTemplateName() - Method in exception freemarker.template.TemplateException
Deprecated.
Use TemplateException.getTemplateSourceName() instead, unless you are really sure that this is what you want. This method isn't really deprecated, it's just marked so to warn users about this.
getTemplateName() - Method in exception freemarker.template.TemplateNotFoundException
The name (path) of the template that wasn't found.
getTemplateNameFormat() - Method in class freemarker.cache.TemplateCache
 
getTemplateNameFormat() - Method in class freemarker.template.Configuration
getTemplateNumberFormat() - Method in class freemarker.core.Environment
Returns the current number format (Configurable.getNumberFormat()) as TemplateNumberFormat.
getTemplateNumberFormat(String) - Method in class freemarker.core.Environment
Returns the number format as TemplateNumberFormat for the given format string and the current locale.
getTemplateNumberFormat(String, Locale) - Method in class freemarker.core.Environment
Returns the number format as TemplateNumberFormat, for the given format string and locale.
getTemplatePath() - Method in class freemarker.ext.servlet.FreemarkerServlet
Deprecated.
Not called by FreeMarker code, and there's no point to override this (unless to cause confusion).
getTemplateSourceName() - Method in class freemarker.cache.TemplateLookupResult
The source name of the template found (see Template.getSourceName()), or null if TemplateLookupResult.isPositive() is false.
getTemplateSourceName() - Method in exception freemarker.template.TemplateException
Returns the source name (Template.getSourceName()) of the template where the error has occurred, or null if the information isn't available.
getTemplateSpecifiedEncoding() - Method in exception freemarker.template.Template.WrongEncodingException
 
getTemplateUpdateDelayMilliseconds() - Method in class freemarker.template.Configuration
getTimeFormat() - Method in class freemarker.core.Configurable
getTimeZone() - Method in class freemarker.core.Configurable
getTimeZone(String) - Static method in class freemarker.template.utility.DateUtil
Returns the time zone object for the name (or ID).
getTimeZoneName() - Method in exception freemarker.template.utility.UnrecognizedTimeZoneException
 
getTreatDefaultMethodsAsBeanMembers() - Method in class freemarker.ext.beans.BeansWrapper
getTreatDefaultMethodsAsBeanMembers() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
getUndeclaredThrowable() - Method in exception freemarker.template.utility.UndeclaredThrowableException
 
getUnsupportedClass() - Method in exception freemarker.template.utility.UnsupportedNumberClassException
 
getURL(String) - Method in class freemarker.cache.ClassTemplateLoader
 
getURL(String) - Method in class freemarker.cache.URLTemplateLoader
Given a template name (plus potential locale decorations) retrieves an URL that points the template source.
getURLConnectionUsesCaches() - Method in class freemarker.cache.URLTemplateLoader
getURLConnectionUsesCaches() - Method in class freemarker.cache.WebappTemplateLoader
getURLEscapingCharset() - Method in class freemarker.core.Configurable
 
getUseAdaptersForContainers() - Method in class freemarker.template.DefaultObjectWrapper
getUseAdaptersForContainers() - Method in class freemarker.template.DefaultObjectWrapperConfiguration
getUseCache() - Method in class freemarker.ext.beans.BeansWrapper
 
getUseCache() - Method in class freemarker.ext.util.ModelCache
 
getUseModelCache() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
getValue() - Method in interface freemarker.template.TemplateHashModelEx2.KeyValuePair
 
getVariable(String) - Method in class freemarker.core.Environment
Returns the variable that is visible in this context, or null if the variable is not found.
getVersion() - Static method in class freemarker.template.Configuration
Returns the FreeMarker version information, most importantly the major.minor.micro version numbers.
getVersionNumber() - Static method in class freemarker.template.Configuration
Deprecated.
getWhitespaceStripping() - Method in interface freemarker.core.ParserConfiguration
getWhitespaceStripping() - Method in class freemarker.core.TemplateConfiguration
getWhitespaceStripping() - Method in class freemarker.template.Configuration
Gets whether the FTL parser will try to remove superfluous white-space around certain FTL tags.
getWrappedObject() - Method in class freemarker.ext.beans.BeanModel
 
getWrappedObject() - Method in class freemarker.ext.beans.SimpleMapModel
 
getWrappedObject() - Method in class freemarker.ext.dom.NodeModel
 
getWrappedObject() - Method in class freemarker.ext.jython.JythonModel
 
getWrappedObject() - Method in interface freemarker.ext.util.WrapperTemplateModel
Retrieves the original object wrapped by this model.
getWrappedObject() - Method in class freemarker.template.DefaultEnumerationAdapter
 
getWrappedObject() - Method in class freemarker.template.DefaultIterableAdapter
 
getWrappedObject() - Method in class freemarker.template.DefaultIteratorAdapter
 
getWrappedObject() - Method in class freemarker.template.DefaultListAdapter
 
getWrappedObject() - Method in class freemarker.template.DefaultMapAdapter
 
getWrappedObject() - Method in class freemarker.template.DefaultNonListCollectionAdapter
 
getWrappedObject() - Method in class freemarker.template.TemplateModelListSequence
Returns the original List of TemplateModel-s, so it's not a fully unwrapped value.
getWriter(Writer, Map) - Method in interface freemarker.template.TemplateTransformModel
Returns a writer that will be used by the engine to feed the transformation input to the transform.
getWriter(Writer, Map) - Method in class freemarker.template.utility.CaptureOutput
Deprecated.
 
getWriter(Writer, Map) - Method in class freemarker.template.utility.HtmlEscape
 
getWriter(Writer, Map) - Method in class freemarker.template.utility.JythonRuntime
 
getWriter(Writer, Map) - Method in class freemarker.template.utility.NormalizeNewlines
 
getWriter(Writer, Map) - Method in class freemarker.template.utility.StandardCompress
 
getWriter(Writer, Map) - Method in class freemarker.template.utility.XmlEscape
 
getXPathSupportClass() - Static method in class freemarker.ext.dom.NodeModel
Get the currently used freemarker.ext.dom.XPathSupport used as the XPath engine.
getYesNo(String) - Static method in class freemarker.template.utility.StringUtil
 
globToRegularExpression(String) - Static method in class freemarker.template.utility.StringUtil
Same as StringUtil.globToRegularExpression(String, boolean) with caseInsensitive argument false.
globToRegularExpression(String, boolean) - Static method in class freemarker.template.utility.StringUtil
Creates a regular expression from a glob.

H

handleTemplateException(TemplateException, Environment, Writer) - Method in interface freemarker.template.TemplateExceptionHandler
Method called after a TemplateException was raised inside a template.
handleUnknownType(Object) - Method in class freemarker.template.DefaultObjectWrapper
Called for an object that isn't considered to be of a "basic" Java type, like for an application specific type, or for a W3C DOM node.
handleUnknownType(Object) - Method in class freemarker.template.SimpleObjectWrapper
Called if a type other than the simple ones we know about is passed in.
hasCustomFormats() - Method in class freemarker.core.Configurable
Tells if this configurable object or its parent defines any custom formats.
HashAdapter - Class in freemarker.ext.beans
 
hashCode() - Method in class freemarker.debug.Breakpoint
 
hashCode() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
hashCode() - Method in class freemarker.ext.dom.NodeModel
 
hashCode() - Method in class freemarker.template.DefaultObjectWrapperConfiguration
 
hashCode() - Method in class freemarker.template.Version
 
hasNext() - Method in class freemarker.ext.beans.EnumerationModel
Calls underlying Enumeration.nextElement().
hasNext() - Method in class freemarker.ext.beans.IteratorModel
Calls underlying Iterator.hasNext().
hasNext() - Method in class freemarker.template.MapKeyValuePairIterator
 
hasNext() - Method in interface freemarker.template.TemplateHashModelEx2.KeyValuePairIterator
Similar to Iterator.hasNext().
hasNext() - Method in interface freemarker.template.TemplateModelIterator
 
hasPlainGetMethod() - Method in class freemarker.ext.beans.BeanModel
Whether the model has a plain get(String) or get(Object) method
HTML_DEBUG_HANDLER - Static variable in interface freemarker.template.TemplateExceptionHandler
TemplateExceptionHandler useful when you developing HTML templates.
HTMLEnc(String) - Static method in class freemarker.template.utility.StringUtil
Deprecated.
Use StringUtil.XHTMLEnc(String) instead, because it escapes apostrophe-quote too.
HtmlEscape - Class in freemarker.template.utility
Performs an HTML escape of a given template fragment.
HtmlEscape() - Constructor for class freemarker.template.utility.HtmlEscape
 
HTMLOutputFormat - Class in freemarker.core
Represents the HTML output format (MIME type "text/html", name "HTML").
HttpRequestHashModel - Class in freemarker.ext.servlet
TemplateHashModel wrapper for a HttpServletRequest attributes.
HttpRequestHashModel(HttpServletRequest, ObjectWrapper) - Constructor for class freemarker.ext.servlet.HttpRequestHashModel
 
HttpRequestHashModel(HttpServletRequest, HttpServletResponse, ObjectWrapper) - Constructor for class freemarker.ext.servlet.HttpRequestHashModel
 
HttpRequestParametersHashModel - Class in freemarker.ext.servlet
TemplateHashModel wrapper for a HttpServletRequest parameters.
HttpRequestParametersHashModel(HttpServletRequest) - Constructor for class freemarker.ext.servlet.HttpRequestParametersHashModel
 
HttpSessionHashModel - Class in freemarker.ext.servlet
TemplateHashModel wrapper for a HttpSession attributes.
HttpSessionHashModel(HttpSession, ObjectWrapper) - Constructor for class freemarker.ext.servlet.HttpSessionHashModel
Use this constructor when the session already exists.
HttpSessionHashModel(FreemarkerServlet, HttpServletRequest, HttpServletResponse, ObjectWrapper) - Constructor for class freemarker.ext.servlet.HttpSessionHashModel
Use this constructor when the session isn't already created.

I

IdentityHashMap - Class in freemarker.ext.util
Deprecated.
Use IdentityHashMap instead.
IdentityHashMap(int, float) - Constructor for class freemarker.ext.util.IdentityHashMap
Deprecated.
Constructs a new, empty map with the specified initial capacity and the specified load factor.
IdentityHashMap(int) - Constructor for class freemarker.ext.util.IdentityHashMap
Deprecated.
Constructs a new, empty map with the specified initial capacity and default load factor, which is 0.75.
IdentityHashMap() - Constructor for class freemarker.ext.util.IdentityHashMap
Deprecated.
Constructs a new, empty map with a default capacity and load factor, which is 0.75.
IdentityHashMap(Map) - Constructor for class freemarker.ext.util.IdentityHashMap
Deprecated.
Constructs a new map with the same mappings as the given map.
IGNORE_HANDLER - Static variable in interface freemarker.template.TemplateExceptionHandler
TemplateExceptionHandler that simply skips the failing instructions, letting the template continue executing.
importLib(String, String) - Method in class freemarker.core.Environment
Emulates import directive, except that templateName must be template root relative.
importLib(Template, String) - Method in class freemarker.core.Environment
Does what the #import directive does, but with an already loaded template.
importLib(String, String, boolean) - Method in class freemarker.core.Environment
Like Environment.importLib(String, String), but you can specify if you want a lazy import or not.
include(String, String, boolean) - Method in class freemarker.core.Environment
Emulates include directive, except that name must be template root relative.
include(Template) - Method in class freemarker.core.Environment
Processes a Template in the context of this Environment, including its output in the Environment's Writer.
IncludePage - Class in freemarker.ext.servlet
A model that when invoked with a 'path' parameter will perform a servlet include.
IncludePage(HttpServletRequest, HttpServletResponse) - Constructor for class freemarker.ext.servlet.IncludePage
 
INCOMPATIBLE_ENHANCEMENTS - Static variable in class freemarker.template.Configuration
INCOMPATIBLE_IMPROVEMENTS - Static variable in class freemarker.template.Configuration
INCOMPATIBLE_IMPROVEMENTS_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
INCOMPATIBLE_IMPROVEMENTS_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
INCOMPATIBLE_IMPROVEMENTS_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
info(String) - Method in class freemarker.log.Logger
Logs an informational message.
info(String, Throwable) - Method in class freemarker.log.Logger
Logs an informational message with accompanying throwable.
init() - Method in class freemarker.ext.servlet.FreemarkerServlet
Don't override this method to adjust FreeMarker settings! Override the protected methods for that, such as FreemarkerServlet.createConfiguration(), FreemarkerServlet.createTemplateLoader(String), FreemarkerServlet.createDefaultObjectWrapper(), etc.
INIT_PARAM_BUFFER_SIZE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Init-param name - see the FreemarkerServlet class documentation about the init-params.
INIT_PARAM_CLASSPATH_TLDS - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Init-param name - see the FreemarkerServlet class documentation about the init-params.
INIT_PARAM_CONTENT_TYPE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Init-param name - see the FreemarkerServlet class documentation about the init-params.
INIT_PARAM_EXCEPTION_ON_MISSING_TEMPLATE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Init-param name - see the FreemarkerServlet class documentation about the init-params.
INIT_PARAM_META_INF_TLD_LOCATIONS - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Init-param name - see the FreemarkerServlet class documentation about the init-params.
INIT_PARAM_NO_CACHE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Init-param name - see the FreemarkerServlet class documentation about the init-params.
INIT_PARAM_OVERRIDE_RESPONSE_CONTENT_TYPE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Init-param name - see the FreemarkerServlet class documentation about the init-params.
INIT_PARAM_OVERRIDE_RESPONSE_LOCALE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Init-param name - see the FreemarkerServlet class documentation about the init-params.
INIT_PARAM_RESPONSE_CHARACTER_ENCODING - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Init-param name - see the FreemarkerServlet class documentation about the init-params.
INIT_PARAM_TEMPLATE_PATH - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Init-param name - see the FreemarkerServlet class documentation about the init-params.
INIT_PARAM_VALUE_ALWAYS - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
INIT_PARAM_VALUE_DO_NOT_SET - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
INIT_PARAM_VALUE_FORCE_PREFIX - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
INIT_PARAM_VALUE_FROM_TEMPLATE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
INIT_PARAM_VALUE_LEGACY - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
INIT_PARAM_VALUE_NEVER - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
INIT_PARAM_VALUE_WHEN_TEMPLATE_HAS_MIME_TYPE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
initializeServletContext(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called when servlet detects in a request processing that application-global (that is, ServletContext-specific) attributes are not yet set.
initializeSession(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called when servlet detects in a request processing that session-global (that is, HttpSession-specific) attributes are not yet set.
insertDefaults(Map) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
 
INSTANCE - Static variable in class freemarker.cache.NullCacheStorage
 
INSTANCE - Static variable in class freemarker.core.CSSOutputFormat
The only instance (singleton) of this OutputFormat.
INSTANCE - Static variable in class freemarker.core.HTMLOutputFormat
The only instance (singleton) of this OutputFormat.
INSTANCE - Static variable in class freemarker.core.JavaScriptOutputFormat
The only instance (singleton) of this OutputFormat.
INSTANCE - Static variable in class freemarker.core.JSONOutputFormat
The only instance (singleton) of this OutputFormat.
INSTANCE - Static variable in class freemarker.core.PlainTextOutputFormat
 
INSTANCE - Static variable in class freemarker.core.RTFOutputFormat
The only instance (singleton) of this OutputFormat.
INSTANCE - Static variable in class freemarker.core.UndefinedOutputFormat
 
INSTANCE - Static variable in class freemarker.core.XHTMLOutputFormat
The only instance (singleton) of this OutputFormat.
INSTANCE - Static variable in class freemarker.core.XMLOutputFormat
The only instance (singleton) of this OutputFormat.
INSTANCE - Static variable in class freemarker.ext.jsp.TaglibFactory.ClearMetaInfTldSource
 
INSTANCE - Static variable in class freemarker.ext.jsp.TaglibFactory.WebInfPerLibJarMetaInfTldSource
 
INSTANCE - Static variable in class freemarker.ext.jython.JythonWrapper
 
INSTANCE - Static variable in class freemarker.template.utility.NullWriter
 
INSTANCE - Static variable in class freemarker.template.utility.StandardCompress
 
intValue() - Method in class freemarker.template.Version
 
intValueFor(int, int, int) - Static method in class freemarker.template.Version
 
InvalidFormatParametersException - Exception in freemarker.core
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.
InvalidFormatParametersException(String, Throwable) - Constructor for exception freemarker.core.InvalidFormatParametersException
 
InvalidFormatParametersException(String) - Constructor for exception freemarker.core.InvalidFormatParametersException
 
InvalidFormatStringException - Exception in freemarker.core
Used when creating TemplateDateFormat-s and TemplateNumberFormat-s to indicate that the format string (like the value of the dateFormat setting) is malformed.
InvalidFormatStringException(String, Throwable) - Constructor for exception freemarker.core.InvalidFormatStringException
 
InvalidFormatStringException(String) - Constructor for exception freemarker.core.InvalidFormatStringException
 
InvalidPropertyException - Exception in freemarker.ext.beans
An exception thrown when there is an attempt to access an invalid bean property when we are in a "strict bean" mode
InvalidPropertyException(String) - Constructor for exception freemarker.ext.beans.InvalidPropertyException
 
InvalidReferenceException - Exception in freemarker.core
A subclass of TemplateException that says that an FTL expression has evaluated to null or it refers to something that doesn't exist.
InvalidReferenceException(Environment) - Constructor for exception freemarker.core.InvalidReferenceException
Creates and invalid reference exception that contains no information about what was missing or null.
InvalidReferenceException(String, Environment) - Constructor for exception freemarker.core.InvalidReferenceException
Creates and invalid reference exception that contains no programmatically extractable information about the blamed expression.
invalidSettingValueException(String, String) - Method in class freemarker.core.Configurable
 
invokeGenericGet(Map, Class<?>, String) - Method in class freemarker.ext.beans.BeanModel
 
invokeGenericGet(Map, Class, String) - Method in class freemarker.ext.beans.MapModel
Overridden to invoke the generic get method by casting to Map instead of through reflection - should yield better performance.
invokeGenericGet(Map, Class, String) - Method in class freemarker.ext.beans.ResourceBundleModel
Overridden to invoke the getObject method of the resource bundle.
isAPIBuiltinEnabled() - Method in class freemarker.core.Configurable
isAPIBuiltinEnabledSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isArithmeticEngineSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isAutoEscapedByDefault() - Method in class freemarker.core.CombinedMarkupOutputFormat
 
isAutoEscapedByDefault() - Method in class freemarker.core.CommonMarkupOutputFormat
 
isAutoEscapedByDefault() - Method in class freemarker.core.MarkupOutputFormat
Tells if by default auto-escaping should be on for this format.
isAutoEscapingPolicySet() - Method in class freemarker.core.TemplateConfiguration
Tells if this setting is set directly in this object or its value is coming from the parent.
isAutoFlushSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isAutoImportsSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isAutoIncludesSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isBooleanFormatSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isCacheable(Object) - Method in class freemarker.ext.beans.BeansModelCache
 
isCacheable(Object) - Method in class freemarker.ext.util.ModelCache
 
isCacheStorageExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setCacheStorage(CacheStorage) (or equivalent) was already called on this instance.
isCaseInsensitive() - Method in class freemarker.cache.FileExtensionMatcher
 
isCaseInsensitive() - Method in class freemarker.cache.FileNameGlobMatcher
 
isCaseInsensitive() - Method in class freemarker.cache.PathGlobMatcher
 
isClassicCompatible() - Method in class freemarker.core.Configurable
Returns whether the engine runs in the "Classic Compatibile" mode.
isClassicCompatibleSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isClassIntrospectionCacheRestricted() - Method in class freemarker.ext.beans.BeansWrapper
Tells if this instance acts like if its class introspection cache is sharable with other BeansWrapper-s.
isConcurrent() - Method in interface freemarker.cache.ConcurrentCacheStorage
Returns true if this instance of cache storage is concurrently accessible from multiple threads without synchronization.
isConcurrent() - Method in class freemarker.cache.NullCacheStorage
 
isConcurrent() - Method in class freemarker.cache.SoftCacheStorage
Returns true if the underlying Map is a ConcurrentMap.
isConcurrent() - Method in class freemarker.cache.StrongCacheStorage
Always returns true.
isCustomDateFormatsSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isCustomNumberFormatsSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isDateFormatSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isDateTimeFormatSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isDebugEnabled() - Method in class freemarker.log.Logger
Returns true if this logger will log debug messages.
isDefaultEncodingExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setDefaultEncoding(String) (or equivalent) was already called on this instance, or it just holds the default value.
isEmpty(MO) - Method in class freemarker.core.CommonMarkupOutputFormat
 
isEmpty(MO) - Method in class freemarker.core.MarkupOutputFormat
Returns if the markup is empty (0 length).
isEmpty() - Method in class freemarker.ext.beans.ArrayModel
 
isEmpty() - Method in class freemarker.ext.beans.BeanModel
Tells whether the model is empty.
isEmpty() - Method in class freemarker.ext.beans.HashAdapter
 
isEmpty() - Method in class freemarker.ext.beans.MapModel
 
isEmpty() - Method in class freemarker.ext.beans.ResourceBundleModel
Returns true if this bundle contains no objects.
isEmpty() - Method in class freemarker.ext.beans.SimpleMapModel
 
isEmpty() - Method in class freemarker.ext.jdom.NodeListModel
Deprecated.
Returns true if this model contains no nodes.
isEmpty() - Method in class freemarker.ext.jsp.TaglibFactory
Returns false.
isEmpty() - Method in class freemarker.ext.jython.JythonModel
Returns PyObject.__len__() == 0.
isEmpty() - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
isEmpty() - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
isEmpty() - Method in class freemarker.ext.servlet.HttpRequestParametersHashModel
 
isEmpty() - Method in class freemarker.ext.servlet.HttpSessionHashModel
 
isEmpty() - Method in class freemarker.ext.servlet.ServletContextHashModel
 
isEmpty() - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Returns true if this map contains no key-value mappings.
isEmpty() - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
Returns true if this NodeListModel contains no nodes.
isEmpty() - Method in class freemarker.template.DefaultMapAdapter
 
isEmpty() - Method in class freemarker.template.DefaultNonListCollectionAdapter
 
isEmpty() - Method in class freemarker.template.SimpleHash
 
isEmpty() - Method in interface freemarker.template.TemplateCollectionModelEx
Returns if the collection contains any elements.
isEmpty() - Method in interface freemarker.template.TemplateHashModel
 
isEmpty() - Method in class freemarker.template.utility.DOMNodeModel
 
isEncodingSet() - Method in class freemarker.core.TemplateConfiguration
 
isErrorEnabled() - Method in class freemarker.log.Logger
Returns true if this logger will log error messages.
isExposeFields() - Method in class freemarker.ext.beans.BeansWrapper
Returns whether exposure of public instance fields of classes is enabled.
isFatalEnabled() - Method in class freemarker.log.Logger
Returns true if this logger will log fatal error messages.
isFTLIdentifierPart(char) - Static method in class freemarker.template.utility.StringUtil
Tells if a character can occur in an FTL identifier expression (without escaping) as other than the first character.
isFTLIdentifierStart(char) - Static method in class freemarker.template.utility.StringUtil
Tells if a character can occur on the beginning of an FTL identifier expression (without escaping).
isGAECompliant() - Method in class freemarker.template.Version
 
isInAttemptBlock() - Method in class freemarker.core.Environment
Tells if we are inside an #attempt block (but before #recover).
isInfinite(Number) - Static method in class freemarker.template.utility.NumberUtil
 
isInfoEnabled() - Method in class freemarker.log.Logger
Returns true if this logger will log informational messages.
isIntegerBigDecimal(BigDecimal) - Static method in class freemarker.template.utility.NumberUtil
Tells if a BigDecimal stores a whole number.
isLazyAutoImportsSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isLazyImportsSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isLegacyBuiltInBypassed(String) - Method in class freemarker.core.CombinedMarkupOutputFormat
 
isLegacyBuiltInBypassed(String) - Method in class freemarker.core.HTMLOutputFormat
 
isLegacyBuiltInBypassed(String) - Method in class freemarker.core.MarkupOutputFormat
Tells if a string built-in that can't handle a TemplateMarkupOutputModel left hand operand can bypass this object as is.
isLegacyBuiltInBypassed(String) - Method in class freemarker.core.RTFOutputFormat
 
isLegacyBuiltInBypassed(String) - Method in class freemarker.core.XHTMLOutputFormat
 
isLegacyBuiltInBypassed(String) - Method in class freemarker.core.XMLOutputFormat
 
isLocaleBound() - Method in class freemarker.core.TemplateDateFormat
Tells if this formatter should be re-created if the locale changes.
isLocaleBound() - Method in class freemarker.core.TemplateNumberFormat
Tells if this formatter should be re-created if the locale changes.
isLocaleExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setLocale(Locale) (or equivalent) was already called on this instance, or it just holds the default value.
isLocaleSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isLogTemplateExceptionsExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setLogTemplateExceptions(boolean) (or equivalent) was already called on this instance.
isLogTemplateExceptionsSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isNamingConventionSet() - Method in class freemarker.core.TemplateConfiguration
Tells if this setting is set directly in this object or its value is coming from the parent.
isNaN(Number) - Static method in class freemarker.template.utility.NumberUtil
 
isNestedOutputCacheable() - Method in interface freemarker.core.DirectiveCallPlace
Tells if the nested content (the body) can be safely cached, as it only depends on the template content (not on variable values and such) and has no side-effects (other than writing to the output).
isNewBuiltinClassResolverSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isNumberFormatSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isNumerical(Class) - Static method in class freemarker.template.utility.ClassUtil
Tells if a type is numerical; works both for primitive types and classes.
isObjectWrapperExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setObjectWrapper(ObjectWrapper) (or equivalent) was already called on this instance.
isObjectWrapperSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isOutputEncodingSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isOutputFormatExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setOutputFormat(OutputFormat) (or equivalent) was already called on this instance.
isOutputFormatMixingAllowed() - Method in class freemarker.core.CombinedMarkupOutputFormat
 
isOutputFormatMixingAllowed() - Method in class freemarker.core.CommonMarkupOutputFormat
 
isOutputFormatMixingAllowed() - Method in class freemarker.core.CSSOutputFormat
 
isOutputFormatMixingAllowed() - Method in class freemarker.core.JavaScriptOutputFormat
 
isOutputFormatMixingAllowed() - Method in class freemarker.core.JSONOutputFormat
 
isOutputFormatMixingAllowed() - Method in class freemarker.core.OutputFormat
Tells if this output format allows inserting TemplateMarkupOutputModel-s of another output formats into it.
isOutputFormatMixingAllowed() - Method in class freemarker.core.PlainTextOutputFormat
 
isOutputFormatMixingAllowed() - Method in class freemarker.core.UndefinedOutputFormat
 
isOutputFormatSet() - Method in class freemarker.core.TemplateConfiguration
Tells if this setting is set directly in this object or its value is coming from the parent.
isPositive() - Method in class freemarker.cache.TemplateLookupResult
Tells if the lookup has found a matching template.
isPyInstance(Object) - Method in class freemarker.ext.jython.JythonVersionAdapter
Returns obj instanceof Py[Java]Instance.
isRecognizeStandardFileExtensionsExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setRecognizeStandardFileExtensions(boolean) (or equivalent) was already called on this instance.
isRecognizeStandardFileExtensionsSet() - Method in class freemarker.core.TemplateConfiguration
Tells if this setting is set directly in this object or its value is coming from the parent.
isShowErrorTipsSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isSimpleMapWrapper() - Method in class freemarker.ext.beans.BeansWrapper
Tells whether Maps are exposed as simple maps, without access to their method.
isSimpleMapWrapper() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
isSQLDateAndTimeTimeZoneSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isSticky() - Method in class freemarker.cache.MultiTemplateLoader
isStrict() - Method in class freemarker.ext.beans.BeansWrapper
 
isStrict() - Method in class freemarker.ext.beans.BeansWrapperConfiguration
 
isStrictSyntaxModeSet() - Method in class freemarker.core.TemplateConfiguration
Tells if this setting is set directly in this object or its value is coming from the parent.
isTabSizeSet() - Method in class freemarker.core.TemplateConfiguration
Tells if this setting is set directly in this object or its value is coming from the parent.
isTagSyntaxSet() - Method in class freemarker.core.TemplateConfiguration
Tells if this setting is set directly in this object or its value is coming from the parent.
isTemplateExceptionHandlerExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setTemplateExceptionHandler(TemplateExceptionHandler) (or equivalent) was already called on this instance.
isTemplateExceptionHandlerSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isTemplateLoaderExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setTemplateLoader(TemplateLoader) (or equivalent) was already called on this instance.
isTemplateLookupStrategyExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setTemplateLookupStrategy(TemplateLookupStrategy) (or equivalent) was already called on this instance.
isTemplateNameFormatExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setTemplateNameFormat(TemplateNameFormat) (or equivalent) was already called on this instance.
isTimeFormatSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isTimeZoneBound() - Method in class freemarker.core.TemplateDateFormat
Tells if this formatter should be re-created if the time zone changes.
isTimeZoneExplicitlySet() - Method in class freemarker.template.Configuration
Tells if Configuration.setTimeZone(TimeZone) (or equivalent) was already called on this instance, or it just holds the default value.
isTimeZoneSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isTrimmableToEmpty(char[]) - Static method in class freemarker.template.utility.StringUtil
Tells if String.trim() will return a 0-length string for the String equivalent of the argument.
isTrimmableToEmpty(char[], int) - Static method in class freemarker.template.utility.StringUtil
Like StringUtil.isTrimmableToEmpty(char[]), but acts on a sub-array that starts at start (inclusive index).
isTrimmableToEmpty(char[], int, int) - Static method in class freemarker.template.utility.StringUtil
Like StringUtil.isTrimmableToEmpty(char[]), but acts on a sub-array that starts at start (inclusive index) and ends at end (exclusive index).
isURLEscapingCharsetSet() - Method in class freemarker.core.Configurable
Tells if this setting is set directly in this object or its value is coming from the parent.
isWarnEnabled() - Method in class freemarker.log.Logger
Returns true if this logger will log warning messages.
isWhitespaceStrippingSet() - Method in class freemarker.core.TemplateConfiguration
Tells if this setting is set directly in this object or its value is coming from the parent.
isWrappedIterable(TemplateModel) - Static method in exception freemarker.core.NonSequenceOrCollectionException
 
isWriteProtected() - Method in class freemarker.ext.beans.BeansWrapper
 
isWriteProtected() - Method in interface freemarker.template.utility.WriteProtectable
 
isXMLID(String) - Static method in class freemarker.template.utility.StringUtil
Deprecated.
Don't use this outside FreeMarker; it's name if misleading, and it doesn't follow the XML specs.
iterator() - Method in class freemarker.ext.beans.ArrayModel
 
iterator() - Method in class freemarker.ext.beans.CollectionModel
 
iterator() - Method in class freemarker.ext.beans.EnumerationModel
This allows the enumeration to be used in a <#list> block.
iterator() - Method in class freemarker.ext.beans.IteratorModel
This allows the iterator to be used in a <#list> block.
iterator() - Method in class freemarker.ext.jdom.NodeListModel
Deprecated.
 
iterator() - Method in class freemarker.ext.jython.JythonSequenceModel
 
iterator() - Method in class freemarker.template.DefaultEnumerationAdapter
 
iterator() - Method in class freemarker.template.DefaultIterableAdapter
 
iterator() - Method in class freemarker.template.DefaultIteratorAdapter
 
iterator() - Method in class freemarker.template.DefaultNonListCollectionAdapter
 
iterator() - Method in class freemarker.template.SimpleCollection
Retrieves a template model iterator that is used to iterate over the elements in this collection.
iterator() - Method in interface freemarker.template.TemplateCollectionModel
Retrieves a template model iterator that is used to iterate over the elements in this collection.
IteratorModel - Class in freemarker.ext.beans
A class that adds TemplateModelIterator functionality to the Iterator interface implementers.
IteratorModel(Iterator, BeansWrapper) - Constructor for class freemarker.ext.beans.IteratorModel
Creates a new model that wraps the specified iterator object.

J

JavaScriptOutputFormat - Class in freemarker.core
Represents the JavaScript output format (MIME type "application/javascript", name "JavaScript").
javaScriptStringEnc(String) - Static method in class freemarker.template.utility.StringUtil
Escapes a String to be safely insertable into a JavaScript string literal; for more see jsStringEnc(s, false).
javaStringEnc(String) - Static method in class freemarker.template.utility.StringUtil
Escapes the String with the escaping rules of Java language string literals, so it's safe to insert the value into a string literal.
jQuote(Object) - Static method in class freemarker.template.utility.StringUtil
Converts the parameter with toString (if it's not null) and passes it to StringUtil.jQuote(String).
jQuote(String) - Static method in class freemarker.template.utility.StringUtil
Quotes string as Java Language string literal.
jQuoteNoXSS(Object) - Static method in class freemarker.template.utility.StringUtil
Converts the parameter with toString (if not null)and passes it to StringUtil.jQuoteNoXSS(String).
jQuoteNoXSS(String) - Static method in class freemarker.template.utility.StringUtil
Same as StringUtil.jQuoteNoXSS(String) but also escapes '<' as \u003C.
JSONOutputFormat - Class in freemarker.core
Represents the JSON output format (MIME type "application/json", name "JSON").
jsonStringEnc(String) - Static method in class freemarker.template.utility.StringUtil
Escapes a String to be safely insertable into a JSON string literal; for more see jsStringEnc(s, true).
jsStringEnc(String, boolean) - Static method in class freemarker.template.utility.StringUtil
Escapes a String to be safely insertable into a JavaScript or a JSON string literal.
JythonAntTask - Class in freemarker.ext.ant
Used internally, public for technical reasons only.
JythonAntTask() - Constructor for class freemarker.ext.ant.JythonAntTask
 
JythonHashModel - Class in freemarker.ext.jython
Model for Jython dictionaries (PyDictionary and PyStringMap).
JythonHashModel(PyObject, JythonWrapper) - Constructor for class freemarker.ext.jython.JythonHashModel
 
JythonModel - Class in freemarker.ext.jython
Generic model for arbitrary Jython objects.
JythonModel(PyObject, JythonWrapper) - Constructor for class freemarker.ext.jython.JythonModel
 
JythonNumberModel - Class in freemarker.ext.jython
Model for Jython numeric objects (PyInteger, PyLong, PyFloat).
JythonNumberModel(PyObject, JythonWrapper) - Constructor for class freemarker.ext.jython.JythonNumberModel
 
JythonRuntime - Class in freemarker.template.utility
A crude first pass at an embeddable Jython interpreter
JythonRuntime() - Constructor for class freemarker.template.utility.JythonRuntime
 
JythonSequenceModel - Class in freemarker.ext.jython
Model for Jython sequence objects (PySequence descendants).
JythonSequenceModel(PyObject, JythonWrapper) - Constructor for class freemarker.ext.jython.JythonSequenceModel
 
JythonVersionAdapter - Class in freemarker.ext.jython
Functions that has a different implementation depending on the Jython version used.
JythonVersionAdapter() - Constructor for class freemarker.ext.jython.JythonVersionAdapter
 
JythonWrapper - Class in freemarker.ext.jython
An object wrapper that wraps Jython objects into FreeMarker template models and vice versa.
JythonWrapper() - Constructor for class freemarker.ext.jython.JythonWrapper
 

K

KEY_APPLICATION - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
KEY_APPLICATION_PRIVATE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
KEY_INCLUDE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
KEY_JSP_TAGLIBS - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
KEY_REQUEST - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
KEY_REQUEST_PARAMETERS - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
KEY_REQUEST_PRIVATE - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
KEY_SESSION - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
keys() - Method in interface freemarker.debug.DebugModel
 
keys() - Method in class freemarker.ext.beans.BeanModel
 
keys() - Method in class freemarker.ext.beans.SimpleMapModel
 
keys() - Method in class freemarker.ext.jython.JythonHashModel
Returns either object.__findattr__("keys").__call__() or object.__findattr__("keySet").__call__().
keys() - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
keys() - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
keys() - Method in class freemarker.ext.servlet.HttpRequestParametersHashModel
 
keys() - Method in class freemarker.template.DefaultMapAdapter
 
keys() - Method in class freemarker.template.SimpleHash
 
keys() - Method in interface freemarker.template.TemplateHashModelEx
 
keySet() - Method in class freemarker.ext.beans.BeanModel
Helper method to support TemplateHashModelEx.
keySet() - Method in class freemarker.ext.beans.MapModel
 
keySet() - Method in class freemarker.ext.beans.ResourceBundleModel
 
keySet() - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Returns a set view of the keys contained in this map.
keyValuePairIterator() - Method in class freemarker.ext.beans.SimpleMapModel
 
keyValuePairIterator() - Method in class freemarker.template.DefaultMapAdapter
 
keyValuePairIterator() - Method in class freemarker.template.SimpleHash
 
keyValuePairIterator() - Method in interface freemarker.template.TemplateHashModelEx2
 

L

LAZY_AUTO_IMPORTS_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
LAZY_AUTO_IMPORTS_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
LAZY_AUTO_IMPORTS_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
LAZY_IMPORTS_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
LAZY_IMPORTS_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
LAZY_IMPORTS_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
leftPad(String, int) - Static method in class freemarker.template.utility.StringUtil
Pads the string at the left with spaces until it reaches the desired length.
leftPad(String, int, char) - Static method in class freemarker.template.utility.StringUtil
Pads the string at the left with the specified character until it reaches the desired length.
leftPad(String, int, String) - Static method in class freemarker.template.utility.StringUtil
Pads the string at the left with a filling pattern until it reaches the desired length.
LEGACY_NAMING_CONVENTION - Static variable in class freemarker.template.Configuration
 
LIBRARY_AUTO - Static variable in class freemarker.log.Logger
Enum value used for Logger.selectLoggerLibrary(int); indicates auto-selection as described in the class documentation of Logger.Logger().
LIBRARY_AVALON - Static variable in class freemarker.log.Logger
Deprecated.
Avalon LogKit support will be removed sometimes in the future.
LIBRARY_COMMONS - Static variable in class freemarker.log.Logger
Enum value used for Logger.selectLoggerLibrary(int); indicates that Apache commons-logging should be used.
LIBRARY_JAVA - Static variable in class freemarker.log.Logger
Enum value used for Logger.selectLoggerLibrary(int); indicates that java.util.logging should be used.
LIBRARY_LOG4J - Static variable in class freemarker.log.Logger
Enum value used for Logger.selectLoggerLibrary(int); indicates that Log4J should be used.
LIBRARY_NAME_AUTO - Static variable in class freemarker.log.Logger
"org.freemarker.loggerLibrary" property value; indicates auto-selection as described in the class documentation of Logger.Logger().
LIBRARY_NAME_AVALON - Static variable in class freemarker.log.Logger
Deprecated.
Avalon LogKit support will be removed sometimes in the future.
LIBRARY_NAME_COMMONS_LOGGING - Static variable in class freemarker.log.Logger
"org.freemarker.loggerLibrary" property value; indicates that Apache commons-logging should be used.
LIBRARY_NAME_JUL - Static variable in class freemarker.log.Logger
"org.freemarker.loggerLibrary" property value; indicates that java.util.logging should be used.
LIBRARY_NAME_LOG4J - Static variable in class freemarker.log.Logger
"org.freemarker.loggerLibrary" property value; indicates that Log4J should be used.
LIBRARY_NAME_NONE - Static variable in class freemarker.log.Logger
"org.freemarker.loggerLibrary" property value; indicates that no logging should occur.
LIBRARY_NAME_SLF4J - Static variable in class freemarker.log.Logger
"org.freemarker.loggerLibrary" property value; indicates that SLF4J should be used.
LIBRARY_NONE - Static variable in class freemarker.log.Logger
Enum value used for Logger.selectLoggerLibrary(int); indicates that no logging should occur.
LIBRARY_SLF4J - Static variable in class freemarker.log.Logger
Constant used with Logger.selectLoggerLibrary(int); indicates that SLF4J should be used.
lineNumber - Variable in exception freemarker.core.ParseException
 
list - Variable in class freemarker.template.DefaultListAdapter
 
list - Variable in class freemarker.template.SimpleSequence
The List that stored the elements of this sequence.
loadBuiltInEncodingMap() - Method in class freemarker.template.Configuration
Loads a preset language-to-encoding map, similarly as if you have called Configuration.clearEncodingMap() and then did multiple Configuration.setEncoding(Locale, String) calls.
LOCALE_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
LOCALE_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
LOCALE_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
LOCALIZED_LOOKUP_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
LOCALIZED_LOOKUP_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
LOCALIZED_LOOKUP_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
LocalizedString - Class in freemarker.template
An abstract base class for scalars that vary by locale.
LocalizedString() - Constructor for class freemarker.template.LocalizedString
 
LOG_TEMPLATE_EXCEPTIONS_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
LOG_TEMPLATE_EXCEPTIONS_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
LOG_TEMPLATE_EXCEPTIONS_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
Logger - Class in freemarker.log
Delegates logger creation to an actual logging library.
Logger() - Constructor for class freemarker.log.Logger
 
lookup(TemplateLookupContext) - Method in class freemarker.cache.TemplateLookupStrategy
Finds the template source that matches the template name, locale (if not null) and other parameters specified in the TemplateLookupContext.
lookupWithAcquisitionStrategy(String) - Method in class freemarker.cache.TemplateLookupContext
Finds the template source based on its normalized name; handles * steps (so called acquisition), otherwise it just calls TemplateLoader.findTemplateSource(String).
lookupWithLocalizedThenAcquisitionStrategy(String, Locale) - Method in class freemarker.cache.TemplateLookupContext
Finds the template source based on its normalized name; tries localized variations going from most specific to less specific, and for each variation it delegates to TemplateLookupContext.lookupWithAcquisitionStrategy(String).

M

main(String[]) - Static method in class freemarker.core.CommandLine
Deprecated.
 
main(String[]) - Static method in class freemarker.ext.dom.Transform
Deprecated.
Will be removed (main method in a library, often classified as CWE-489 "Leftover Debug Code").
main(String[]) - Static method in class freemarker.ext.jdom.NodeListModel
Deprecated.
Will be removed (main method in a library, often classified as CWE-489 "Leftover Debug Code").
main(String[]) - Static method in class freemarker.template.utility.ToCanonical
Deprecated.
Will be removed (main method in a library, often classified as CWE-489 "Leftover Debug Code").
MalformedTemplateNameException - Exception in freemarker.template
Indicates that the template name given was malformed according the TemplateNameFormat in use.
MalformedTemplateNameException(String, String) - Constructor for exception freemarker.template.MalformedTemplateNameException
 
MapKeyValuePairIterator - Class in freemarker.template
Implementation of TemplateHashModelEx2.KeyValuePairIterator for a TemplateHashModelEx2 that wraps or otherwise uses a Map internally.
MapKeyValuePairIterator(Map<?, ?>, ObjectWrapper) - Constructor for class freemarker.template.MapKeyValuePairIterator
 
MapModel - Class in freemarker.ext.beans
A special case of BeanModel that adds implementation for TemplateMethodModelEx on map objects that is a shortcut for the Map.get() method.
MapModel(Map, BeansWrapper) - Constructor for class freemarker.ext.beans.MapModel
Creates a new model that wraps the specified map object.
MarkupOutputFormat<MO extends TemplateMarkupOutputModel> - Class in freemarker.core
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.
MarkupOutputFormat() - Constructor for class freemarker.core.MarkupOutputFormat
 
matches(String, Object) - Method in class freemarker.cache.AndMatcher
 
matches(String, Object) - Method in class freemarker.cache.FileExtensionMatcher
 
matches(String, Object) - Method in class freemarker.cache.FileNameGlobMatcher
 
matches(String, Object) - Method in class freemarker.cache.NotMatcher
 
matches(String, Object) - Method in class freemarker.cache.OrMatcher
 
matches(String, Object) - Method in class freemarker.cache.PathGlobMatcher
 
matches(String, Object) - Method in class freemarker.cache.PathRegexMatcher
 
matchesName(String, String, String, Environment) - Static method in class freemarker.template.utility.StringUtil
 
maxScale - Variable in class freemarker.core.ArithmeticEngine
 
merge(TemplateConfiguration) - Method in class freemarker.core.TemplateConfiguration
Set all settings in this TemplateConfiguration that were set in the parameter TemplateConfiguration, possibly overwriting the earlier value in this object.
mergeAdjacentText(Node) - Static method in class freemarker.ext.dom.NodeModel
Merges adjacent text nodes (where CDATA counts as text node too).
MergingTemplateConfigurationFactory - Class in freemarker.cache
Returns the merged results of all the child factories.
MergingTemplateConfigurationFactory(TemplateConfigurationFactory...) - Constructor for class freemarker.cache.MergingTemplateConfigurationFactory
 
META_INF_TLD_LOCATION_CLASSPATH - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Used as part of the value of the "MetaInfTldSources" init-param.
META_INF_TLD_LOCATION_CLEAR - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Used as part of the value of the "MetaInfTldSources" init-param.
META_INF_TLD_LOCATION_WEB_INF_PER_LIB_JARS - Static variable in class freemarker.ext.servlet.FreemarkerServlet
Used as part of the value of the "MetaInfTldSources" init-param.
MethodAppearanceDecision() - Constructor for class freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision
 
MethodAppearanceDecisionInput() - Constructor for class freemarker.ext.beans.BeansWrapper.MethodAppearanceDecisionInput
 
MethodAppearanceFineTuner - Interface in freemarker.ext.beans
Used for customizing how the methods are visible from templates, via BeansWrapper.setMethodAppearanceFineTuner(MethodAppearanceFineTuner).
minScale - Variable in class freemarker.core.ArithmeticEngine
 
MINUS_ONE - Static variable in class freemarker.template.utility.Constants
 
ModelCache - Class in freemarker.ext.util
Internally used by various wrapper implementations to implement model caching.
ModelCache() - Constructor for class freemarker.ext.util.ModelCache
 
ModelFactory - Interface in freemarker.ext.util
Interface used to create various wrapper models in the ModelCache.
modulus(Number, Number) - Method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
modulus(Number, Number) - Method in class freemarker.core.ArithmeticEngine.ConservativeEngine
 
modulus(Number, Number) - Method in class freemarker.core.ArithmeticEngine
 
MruCacheStorage - Class in freemarker.cache
A cache storage that implements a two-level Most Recently Used cache.
MruCacheStorage(int, int) - Constructor for class freemarker.cache.MruCacheStorage
Creates a new MRU cache storage with specified maximum cache sizes.
multiply(Number, Number) - Method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
multiply(Number, Number) - Method in class freemarker.core.ArithmeticEngine.ConservativeEngine
 
multiply(Number, Number) - Method in class freemarker.core.ArithmeticEngine
 
MultiTemplateLoader - Class in freemarker.cache
A TemplateLoader that uses a set of other loaders to load the templates.
MultiTemplateLoader(TemplateLoader[]) - Constructor for class freemarker.cache.MultiTemplateLoader
Creates a new instance that will use the specified template loaders.

N

NAMING_CONVENTION_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
NAMING_CONVENTION_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
NAMING_CONVENTION_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
NEW_BUILTIN_CLASS_RESOLVER_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
NEW_BUILTIN_CLASS_RESOLVER_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
NEW_BUILTIN_CLASS_RESOLVER_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
newInstance(Class<?>, List) - Method in class freemarker.ext.beans.BeansWrapper
Creates a new instance of the specified class using the method call logic of this object wrapper for calling the constructor.
newInstanceOrNull(String) - Static method in class freemarker.template.SimpleScalar
Same as calling the constructor, except that for a null parameter it returns null.
newTemplateMarkupOutputModel(String, String) - Method in class freemarker.core.CombinedMarkupOutputFormat
 
newTemplateMarkupOutputModel(String, String) - Method in class freemarker.core.CommonMarkupOutputFormat
Creates a new CommonTemplateMarkupOutputModel that's bound to this OutputFormat instance.
newTemplateMarkupOutputModel(String, String) - Method in class freemarker.core.HTMLOutputFormat
 
newTemplateMarkupOutputModel(String, String) - Method in class freemarker.core.RTFOutputFormat
 
newTemplateMarkupOutputModel(String, String) - Method in class freemarker.core.XHTMLOutputFormat
 
newTemplateMarkupOutputModel(String, String) - Method in class freemarker.core.XMLOutputFormat
 
next() - Method in class freemarker.ext.beans.EnumerationModel
Calls underlying Enumeration.nextElement() and wraps the result.
next() - Method in class freemarker.ext.beans.IteratorModel
Calls underlying Iterator.next() and wraps the result.
next() - Method in class freemarker.template.MapKeyValuePairIterator
 
next() - Method in interface freemarker.template.TemplateHashModelEx2.KeyValuePairIterator
Similar to Iterator.next().
next() - Method in interface freemarker.template.TemplateModelIterator
Returns the next model.
NO_NS_PREFIX - Static variable in class freemarker.template.Template
 
NodeListModel - Class in freemarker.ext.jdom
Deprecated.
Use NodeModel instead.
NodeListModel(Document) - Constructor for class freemarker.ext.jdom.NodeListModel
Deprecated.
Creates a node list that holds a single Document node.
NodeListModel(Element) - Constructor for class freemarker.ext.jdom.NodeListModel
Deprecated.
Creates a node list that holds a single Element node.
NodeListModel(List) - Constructor for class freemarker.ext.jdom.NodeListModel
Deprecated.
Creates a node list that holds a list of nodes.
NodeListModel(List, boolean) - Constructor for class freemarker.ext.jdom.NodeListModel
Deprecated.
Creates a node list that holds a list of nodes.
NodeListModel - Class in freemarker.ext.xml
Deprecated.
Use NodeModel instead.
NodeListModel(Object) - Constructor for class freemarker.ext.xml.NodeListModel
Deprecated.
Creates a new NodeListModel, wrapping the passed nodes.
NodeModel - Class in freemarker.ext.dom
A base class for wrapping a single W3C DOM Node as a FreeMarker template model.
NodeModel(Node) - Constructor for class freemarker.ext.dom.NodeModel
 
noMatchErrorDetails(String) - Method in class freemarker.cache.FirstMatchTemplateConfigurationFactory
Same as FirstMatchTemplateConfigurationFactory.setNoMatchErrorDetails(String), but return this object to support "fluent API" style.
NonBooleanException - Exception in freemarker.core
Indicates that a TemplateBooleanModel value was expected, but the value had a different type.
NonBooleanException(Environment) - Constructor for exception freemarker.core.NonBooleanException
 
NonBooleanException(String, Environment) - Constructor for exception freemarker.core.NonBooleanException
 
NonDateException - Exception in freemarker.core
Indicates that a TemplateDateModel value was expected, but the value had a different type.
NonDateException(Environment) - Constructor for exception freemarker.core.NonDateException
 
NonDateException(String, Environment) - Constructor for exception freemarker.core.NonDateException
 
NonExtendedHashException - Exception in freemarker.core
Indicates that a TemplateHashModelEx value was expected, but the value had a different type.
NonExtendedHashException(Environment) - Constructor for exception freemarker.core.NonExtendedHashException
 
NonExtendedHashException(String, Environment) - Constructor for exception freemarker.core.NonExtendedHashException
 
NonExtendedNodeException - Exception in freemarker.core
Indicates that a TemplateNodeModelEx value was expected, but the value had a different type.
NonExtendedNodeException(Environment) - Constructor for exception freemarker.core.NonExtendedNodeException
 
NonExtendedNodeException(String, Environment) - Constructor for exception freemarker.core.NonExtendedNodeException
 
NonHashException - Exception in freemarker.core
Indicates that a TemplateHashModel value was expected, but the value had a different type.
NonHashException(Environment) - Constructor for exception freemarker.core.NonHashException
 
NonHashException(String, Environment) - Constructor for exception freemarker.core.NonHashException
 
NonMarkupOutputException - Exception in freemarker.core
Indicates that a TemplateMarkupOutputModel value was expected, but the value had a different type.
NonMarkupOutputException(Environment) - Constructor for exception freemarker.core.NonMarkupOutputException
 
NonMarkupOutputException(String, Environment) - Constructor for exception freemarker.core.NonMarkupOutputException
 
NonMethodException - Exception in freemarker.core
Indicates that a TemplateMethodModel value was expected, but the value had a different type.
NonMethodException(Environment) - Constructor for exception freemarker.core.NonMethodException
 
NonMethodException(String, Environment) - Constructor for exception freemarker.core.NonMethodException
 
NonNodeException - Exception in freemarker.core
Indicates that a TemplateNodeModel value was expected, but the value had a different type.
NonNodeException(Environment) - Constructor for exception freemarker.core.NonNodeException
 
NonNodeException(String, Environment) - Constructor for exception freemarker.core.NonNodeException
 
NonNumericalException - Exception in freemarker.core
Indicates that a TemplateNumberModel value was expected, but the value had a different type.
NonNumericalException(Environment) - Constructor for exception freemarker.core.NonNumericalException
 
NonNumericalException(String, Environment) - Constructor for exception freemarker.core.NonNumericalException
 
NonSequenceException - Exception in freemarker.core
Indicates that a TemplateSequenceModel value was expected, but the value had a different type.
NonSequenceException(Environment) - Constructor for exception freemarker.core.NonSequenceException
 
NonSequenceException(String, Environment) - Constructor for exception freemarker.core.NonSequenceException
 
NonSequenceOrCollectionException - Exception in freemarker.core
Indicates that a TemplateSequenceModel or TemplateCollectionModel value was expected, but the value had a different type.
NonSequenceOrCollectionException(Environment) - Constructor for exception freemarker.core.NonSequenceOrCollectionException
 
NonSequenceOrCollectionException(String, Environment) - Constructor for exception freemarker.core.NonSequenceOrCollectionException
 
NonStringException - Exception in freemarker.core
Indicates that a TemplateScalarModel value was expected (or maybe something that can be automatically coerced to that), but the value had a different type.
NonStringException(Environment) - Constructor for exception freemarker.core.NonStringException
 
NonStringException(String, Environment) - Constructor for exception freemarker.core.NonStringException
 
NonStringOrTemplateOutputException - Exception in freemarker.core
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.
NonStringOrTemplateOutputException(Environment) - Constructor for exception freemarker.core.NonStringOrTemplateOutputException
 
NonStringOrTemplateOutputException(String, Environment) - Constructor for exception freemarker.core.NonStringOrTemplateOutputException
 
normalizeIncompatibleImprovementsVersion(Version) - Static method in class freemarker.ext.beans.BeansWrapper
Returns the lowest version number that is equivalent with the parameter version.
normalizeIncompatibleImprovementsVersion(Version) - Static method in class freemarker.template.DefaultObjectWrapper
Returns the lowest version number that is equivalent with the parameter version.
NormalizeNewlines - Class in freemarker.template.utility
Transformer that supports FreeMarker legacy behavior: all newlines appearing within the transformed area will be transformed into the platform's default newline.
NormalizeNewlines() - Constructor for class freemarker.template.utility.NormalizeNewlines
 
NOTHING - Static variable in interface freemarker.template.TemplateModel
A general-purpose object to represent nothing.
NotMatcher - Class in freemarker.cache
Logical "not" operation on the given matcher.
NotMatcher(TemplateSourceMatcher) - Constructor for class freemarker.cache.NotMatcher
 
NullArgumentException - Exception in freemarker.template.utility
Indicates that an argument that must be non-null was null.
NullArgumentException() - Constructor for exception freemarker.template.utility.NullArgumentException
 
NullArgumentException(String) - Constructor for exception freemarker.template.utility.NullArgumentException
 
NullArgumentException(String, String) - Constructor for exception freemarker.template.utility.NullArgumentException
 
NullCacheStorage - Class in freemarker.cache
A cache storage that doesn't store anything.
NullCacheStorage() - Constructor for class freemarker.cache.NullCacheStorage
 
NullWriter - Class in freemarker.template.utility
A Writer that simply drops what it gets.
NUMBER_FORMAT_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
NUMBER_FORMAT_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
NUMBER_FORMAT_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
NumberModel - Class in freemarker.ext.beans
Wraps arbitrary subclass of Number into a reflective model.
NumberModel(Number, BeansWrapper) - Constructor for class freemarker.ext.beans.NumberModel
Creates a new model that wraps the specified number object.
NumberUtil - Class in freemarker.template.utility
Number- and math-related utilities.

O

object - Variable in class freemarker.ext.beans.BeanModel
 
object - Variable in class freemarker.ext.jython.JythonModel
 
OBJECT_WRAPPER_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
OBJECT_WRAPPER_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
OBJECT_WRAPPER_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
ObjectConstructor - Class in freemarker.template.utility
An object that you can make available in a template to instantiate arbitrary beans-wrapped objects in a template.
ObjectConstructor() - Constructor for class freemarker.template.utility.ObjectConstructor
 
ObjectFactory<T> - Interface in freemarker.template.utility
Used for the trivial cases of the factory pattern.
ObjectWrapper - Interface in freemarker.template
Maps Java objects to the type-system of FreeMarker Template Language (see the TemplateModel interfaces).
ObjectWrapperAndUnwrapper - Interface in freemarker.template
Experimental - subject to change: Adds functionality to ObjectWrapper that creates a plain Java object from a TemplateModel.
ObjectWrapperWithAPISupport - Interface in freemarker.template.utility
Experimental - subject to change: Implemented by ObjectWrapper-s to help TemplateModel-s to implement the someValue?api operation.
ONE - Static variable in class freemarker.template.utility.Constants
 
onError(Throwable) - Method in interface freemarker.template.TransformControl
Called if any exception occurs during the transform between the TemplateTransformModel.getWriter(java.io.Writer, java.util.Map) call and the Writer.close() call.
onStart() - Method in interface freemarker.template.TransformControl
Called before the body is evaluated for the first time.
optimizeListStorage(List) - Static method in class freemarker.template.utility.OptimizerUtil
 
optimizeNumberRepresentation(Number) - Static method in class freemarker.template.utility.OptimizerUtil
This is needed to reverse the extreme conversions in arithmetic operations so that numbers can be meaningfully used with models that don't know what to do with a BigDecimal.
OptimizerUtil - Class in freemarker.template.utility
 
OptInTemplateClassResolver - Class in freemarker.core
A TemplateClassResolver that resolves only the classes whose name was specified in the constructor.
OptInTemplateClassResolver(Set, List) - Constructor for class freemarker.core.OptInTemplateClassResolver
Creates a new instance.
OrMatcher - Class in freemarker.cache
Logical "or" operation among the given matchers.
OrMatcher(TemplateSourceMatcher...) - Constructor for class freemarker.cache.OrMatcher
 
output(String, Writer) - Method in class freemarker.core.CombinedMarkupOutputFormat
 
output(MO, Writer) - Method in class freemarker.core.CommonMarkupOutputFormat
 
output(String, Writer) - Method in class freemarker.core.CommonMarkupOutputFormat
 
output(String, Writer) - Method in class freemarker.core.HTMLOutputFormat
 
output(MO, Writer) - Method in class freemarker.core.MarkupOutputFormat
Prints the parameter model to the output.
output(String, Writer) - Method in class freemarker.core.MarkupOutputFormat
Equivalent to calling MarkupOutputFormat.fromPlainTextByEscaping(String) and then MarkupOutputFormat.output(TemplateMarkupOutputModel, Writer), but the implementation may uses a more efficient solution.
output(String, Writer) - Method in class freemarker.core.RTFOutputFormat
 
output(String, Writer) - Method in class freemarker.core.XHTMLOutputFormat
 
output(String, Writer) - Method in class freemarker.core.XMLOutputFormat
 
OUTPUT_ENCODING_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
OUTPUT_ENCODING_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
OUTPUT_ENCODING_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
OUTPUT_FORMAT_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
OUTPUT_FORMAT_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
OUTPUT_FORMAT_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
OutputFormat - Class in freemarker.core
Represents an output format.
OutputFormat() - Constructor for class freemarker.core.OutputFormat
 
outputInstructionStack(PrintWriter) - Method in class freemarker.core.Environment
Prints the current FTL stack trace.
OverloadedMethodsModel - Class in freemarker.ext.beans
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.

P

parse(String, int) - Method in class freemarker.core.TemplateDateFormat
Parsers a string to date/time/datetime, according to this format.
parse(String) - Method in class freemarker.core.TemplateNumberFormat
This method is reserved for future purposes; currently it always throws ParsingNotSupportedException.
parse(InputSource, boolean, boolean) - Static method in class freemarker.ext.dom.NodeModel
Convenience method to create a NodeModel from a SAX InputSource; please see the security warning further down.
parse(InputSource) - Static method in class freemarker.ext.dom.NodeModel
Same as parse(is, true, true); don't miss the security warnings documented there.
parse(File, boolean, boolean) - Static method in class freemarker.ext.dom.NodeModel
Same as NodeModel.parse(InputSource, boolean, boolean), but loads from a File; don't miss the security warnings documented there.
parse(File) - Static method in class freemarker.ext.dom.NodeModel
Same as parse(source, true, true), but loads from a File; don't miss the security warnings documented there.
parseAsImportList(String) - Method in class freemarker.core.Configurable
 
parseAsList(String) - Method in class freemarker.core.Configurable
 
parseAsSegmentedList(String) - Method in class freemarker.core.Configurable
 
PARSED_DEFAULT_INCOMPATIBLE_ENHANCEMENTS - Static variable in class freemarker.template.Configuration
ParseException - Exception in freemarker.core
Parsing-time exception in a template (as opposed to a runtime exception, a TemplateException).
ParseException(Token, int[][], String[]) - Constructor for exception freemarker.core.ParseException
This constructor is used by the method "generateParseException" in the generated parser.
ParseException() - Constructor for exception freemarker.core.ParseException
Deprecated.
Use a constructor to which you pass description, template, and positions.
ParseException(String, int, int) - Constructor for exception freemarker.core.ParseException
Deprecated.
Use a constructor to which you can also pass the template, and the end positions.
ParseException(String, Template, int, int, int, int) - Constructor for exception freemarker.core.ParseException
 
ParseException(String, Template, int, int, int, int, Throwable) - Constructor for exception freemarker.core.ParseException
 
ParseException(String, Template, int, int) - Constructor for exception freemarker.core.ParseException
Deprecated.
Use ParseException.ParseException(String, Template, int, int, int, int) instead, as IDE-s need the end position of the error too.
ParseException(String, Template, int, int, Throwable) - Constructor for exception freemarker.core.ParseException
Deprecated.
Use ParseException.ParseException(String, Template, int, int, int, int, Throwable) instead, as IDE-s need the end position of the error too.
ParseException(String, Template, Token) - Constructor for exception freemarker.core.ParseException
 
ParseException(String, Template, Token, Throwable) - Constructor for exception freemarker.core.ParseException
 
ParseException(String, TemplateObject) - Constructor for exception freemarker.core.ParseException
 
ParseException(String, TemplateObject, Throwable) - Constructor for exception freemarker.core.ParseException
 
parseISO8601Date(String, TimeZone, DateUtil.CalendarFieldsToDateConverter) - Static method in class freemarker.template.utility.DateUtil
parseISO8601DateTime(String, TimeZone, DateUtil.CalendarFieldsToDateConverter) - Static method in class freemarker.template.utility.DateUtil
parseISO8601Time(String, TimeZone, DateUtil.CalendarFieldsToDateConverter) - Static method in class freemarker.template.utility.DateUtil
parseNameValuePairList(String, String) - Static method in class freemarker.template.utility.StringUtil
Parses a name-value pair list, where the pairs are separated with comma, and the name and value is separated with colon.
ParserConfiguration - Interface in freemarker.core
Don't implement this interface yourself; use the existing implementation(s).
parseXSDate(String, TimeZone, DateUtil.CalendarFieldsToDateConverter) - Static method in class freemarker.template.utility.DateUtil
Parses an W3C XML Schema date string (not time or date-time).
parseXSDateTime(String, TimeZone, DateUtil.CalendarFieldsToDateConverter) - Static method in class freemarker.template.utility.DateUtil
Parses an W3C XML Schema date-time string (not date or time).
parseXSTime(String, TimeZone, DateUtil.CalendarFieldsToDateConverter) - Static method in class freemarker.template.utility.DateUtil
Parses an W3C XML Schema time string (not date or date-time).
parseXSTimeZone(String) - Static method in class freemarker.template.utility.DateUtil
Parses the time zone part from a W3C XML Schema date/time/dateTime.
ParsingNotSupportedException - Exception in freemarker.core
Thrown when the TemplateValueFormat doesn't support parsing, and parsing was invoked.
ParsingNotSupportedException(String, Throwable) - Constructor for exception freemarker.core.ParsingNotSupportedException
 
ParsingNotSupportedException(String) - Constructor for exception freemarker.core.ParsingNotSupportedException
 
PathGlobMatcher - Class in freemarker.cache
Matches the whole template source name (also known as template source path) with the given glob.
PathGlobMatcher(String) - Constructor for class freemarker.cache.PathGlobMatcher
 
PathRegexMatcher - Class in freemarker.cache
Matches the whole template source name (also known as template source path) with the given regular expression.
PathRegexMatcher(String) - Constructor for class freemarker.cache.PathRegexMatcher
 
permissiveUnwrap(TemplateModel) - Static method in class freemarker.template.utility.DeepUnwrap
Same as DeepUnwrap.unwrap(TemplateModel), but it doesn't throw exception if it doesn't know how to unwrap the model, but rather returns it as-is.
PlainTextOutputFormat - Class in freemarker.core
Represents the plain text output format (MIME type "text/plain", name "plainText").
postTemplateProcess(HttpServletRequest, HttpServletResponse, Template, TemplateModel) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called after the execution returns from Template.process(Object, java.io.Writer).
premissiveUnwrap(TemplateModel) - Static method in class freemarker.template.utility.DeepUnwrap
Deprecated.
the name of this method is mistyped. Use DeepUnwrap.permissiveUnwrap(TemplateModel) instead.
preprocessRequest(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called as the first step in request processing, before the templating mechanism is put to work.
preTemplateProcess(HttpServletRequest, HttpServletResponse, Template, TemplateModel) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called before the execution is passed to Template.process(Object, java.io.Writer).
primitiveClassToBoxingClass(Class) - Static method in class freemarker.template.utility.ClassUtil
Gets the wrapper class for a primitive class, like Integer for int, also returns Void for void.
printStackTrace(PrintWriter) - Method in exception freemarker.core.StopException
 
printStackTrace(PrintStream) - Method in exception freemarker.core.StopException
 
printStackTrace(PrintStream) - Method in exception freemarker.template.TemplateException
Overrides Throwable.printStackTrace(PrintStream) so that it will include the FTL stack trace.
printStackTrace(PrintWriter) - Method in exception freemarker.template.TemplateException
Overrides Throwable.printStackTrace(PrintWriter) so that it will include the FTL stack trace.
printStackTrace(PrintWriter, boolean, boolean, boolean) - Method in exception freemarker.template.TemplateException
 
printStackTrace(PrintStream, boolean, boolean, boolean) - Method in exception freemarker.template.TemplateException
 
printStandardStackTrace(PrintStream) - Method in exception freemarker.template.TemplateException
Prints the stack trace as if wasn't overridden by TemplateException.
printStandardStackTrace(PrintWriter) - Method in exception freemarker.template.TemplateException
Prints the stack trace as if wasn't overridden by TemplateException.
process() - Method in class freemarker.core.Environment
Processes the template to which this environment belongs to.
process(BeansWrapper.MethodAppearanceDecisionInput, BeansWrapper.MethodAppearanceDecision) - Method in interface freemarker.ext.beans.MethodAppearanceFineTuner
Implement this to tweak certain aspects of how methods appear in the data-model.
process(Object, Writer) - Method in class freemarker.template.Template
Executes template, using the data-model provided, writing the generated output to the supplied Writer.
process(Object, Writer, ObjectWrapper, TemplateNodeModel) - Method in class freemarker.template.Template
Like Template.process(Object, Writer), but also sets a (XML-)node to be recursively processed by the template.
process(Object, Writer, ObjectWrapper) - Method in class freemarker.template.Template
processEnvironment(Environment, HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
This is the method that actually executes the template.
put(Object, Object) - Method in interface freemarker.cache.CacheStorage
 
put(Object, Object) - Method in class freemarker.cache.MruCacheStorage
 
put(Object, Object) - Method in class freemarker.cache.NullCacheStorage
 
put(Object, Object) - Method in class freemarker.cache.SoftCacheStorage
 
put(Object, Object) - Method in class freemarker.cache.StrongCacheStorage
 
put(Object, Object) - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Associates the specified value with the specified key in this map.
put(String, Object) - Method in class freemarker.template.SimpleHash
Adds a key-value entry to this hash.
put(String, boolean) - Method in class freemarker.template.SimpleHash
Puts a boolean in the map
putAll(Map) - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Copies all of the mappings from the specified map to this one.
putAll(Map) - Method in class freemarker.template.SimpleHash
Adds all the key/value entries in the map
putTemplate(String, byte[]) - Method in class freemarker.cache.ByteArrayTemplateLoader
Adds a template to this template loader; see StringTemplateLoader.putTemplate(String, String) for more.
putTemplate(String, byte[], long) - Method in class freemarker.cache.ByteArrayTemplateLoader
Adds a template to this template loader; see StringTemplateLoader.putTemplate(String, String, long) for more.
putTemplate(String, String) - Method in class freemarker.cache.StringTemplateLoader
Puts a template into the loader.
putTemplate(String, String, long) - Method in class freemarker.cache.StringTemplateLoader
Puts a template into the loader.
putUnlistedModel(String, TemplateModel) - Method in class freemarker.ext.servlet.AllHttpScopesHashModel
Stores a model in the hash so that it doesn't show up in keys() and values() methods.
pyInstanceToJava(Object) - Method in class freemarker.ext.jython.JythonVersionAdapter
Returns ((PyInstance) py[Java]Instance).__tojava__(java.lang.Object.class).

R

RECOGNIZE_STANDARD_FILE_EXTENSIONS_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
RECOGNIZE_STANDARD_FILE_EXTENSIONS_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
RECOGNIZE_STANDARD_FILE_EXTENSIONS_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
REGISTERED_CUSTOM_OUTPUT_FORMATS_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
REGISTERED_CUSTOM_OUTPUT_FORMATS_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
REGISTERED_CUSTOM_OUTPUT_FORMATS_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
registerNamespace(String, String) - Method in class freemarker.ext.jdom.NodeListModel
Deprecated.
Registers an XML namespace with this node list.
registerNamespace(String, String) - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
Registers a namespace prefix-URI pair for subsequent use in NodeListModel.get(String) as well as for use in XPath expressions.
release() - Method in class freemarker.ext.jsp.FreemarkerTag
 
remove(Object) - Method in interface freemarker.cache.CacheStorage
 
remove(Object) - Method in class freemarker.cache.MruCacheStorage
 
remove(Object) - Method in class freemarker.cache.NullCacheStorage
 
remove(Object) - Method in class freemarker.cache.SoftCacheStorage
 
remove(Object) - Method in class freemarker.cache.StrongCacheStorage
 
remove(Object) - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Removes the mapping for this key from this map if present.
remove(String) - Method in class freemarker.template.SimpleHash
Removes the given key from the underlying map.
removeAutoImport(String) - Method in class freemarker.core.Configurable
Removes an auto-import from this Configurable level (not from the parents or children); see Configurable.addAutoImport(String, String).
removeAutoInclude(String) - Method in class freemarker.core.Configurable
Removes the auto-include from this Configurable level (not from the parents or children); see Configurable.addAutoInclude(String).
removeBreakpoint(Breakpoint) - Method in interface freemarker.debug.Debugger
Removes a single breakpoint
removeBreakpoints(String) - Method in interface freemarker.debug.Debugger
Removes all breakpoints for a specific template
removeBreakpoints() - Method in interface freemarker.debug.Debugger
Removes all breakpoints
removeComments(Node) - Static method in class freemarker.ext.dom.NodeModel
Recursively removes all comment nodes from the subtree.
removeCustomAttribute(String) - Method in class freemarker.core.Configurable
Removes a named custom attribute for this configurable.
removeDebuggerListener(Object) - Method in interface freemarker.debug.Debugger
Removes a previously added debugger listener.
removeFromClassIntrospectionCache(Class<?>) - Method in class freemarker.ext.beans.BeansWrapper
Removes the introspection data for a class from the cache.
removePIs(Node) - Static method in class freemarker.ext.dom.NodeModel
Recursively removes all processing instruction nodes from the subtree.
removeTemplate(String) - Method in class freemarker.cache.ByteArrayTemplateLoader
Removes the template with the specified name if it was added earlier.; see StringTemplateLoader.removeTemplate(String) for more details.
removeTemplate(String) - Method in class freemarker.cache.StringTemplateLoader
Removes the template with the specified name if it was added earlier.
removeTemplate(String, Locale, String, boolean) - Method in class freemarker.cache.TemplateCache
removeTemplate(String, Locale, Object, String, boolean) - Method in class freemarker.cache.TemplateCache
Removes an entry from the cache, hence forcing the re-loading of it when it's next time requested.
removeTemplateFromCache(String) - Method in class freemarker.template.Configuration
Equivalent to removeTemplateFromCache(name, thisCfg.getLocale(), thisCfg.getEncoding(thisCfg.getLocale()), true).
removeTemplateFromCache(String, Locale) - Method in class freemarker.template.Configuration
Equivalent to removeTemplateFromCache(name, locale, thisCfg.getEncoding(locale), true).
removeTemplateFromCache(String, String) - Method in class freemarker.template.Configuration
Equivalent to removeTemplateFromCache(name, thisCfg.getLocale(), encoding, true).
removeTemplateFromCache(String, Locale, String) - Method in class freemarker.template.Configuration
Equivalent to removeTemplateFromCache(name, locale, encoding, true).
removeTemplateFromCache(String, Locale, String, boolean) - Method in class freemarker.template.Configuration
Removes a template from the template cache, hence forcing the re-loading of it when it's next time requested.
render(Writer) - Method in interface freemarker.template.TemplateDirectiveBody
Renders the body of the directive body to the specified writer.
REPEAT_EVALUATION - Static variable in interface freemarker.template.TransformControl
Constant returned from TransformControl.afterBody() that tells the template engine to repeat transform body evaluation and feed it again to the transform.
replace(String, String, String) - Static method in class freemarker.template.utility.StringUtil
replace(String, String, String, boolean, boolean) - Static method in class freemarker.template.utility.StringUtil
Replaces all occurrences of a sub-string in a string.
requestUrlToTemplatePath(HttpServletRequest) - Method in class freemarker.ext.servlet.FreemarkerServlet
Maps the request URL to a template path (template name) that is passed to Configuration.getTemplate(String, Locale).
resetState() - Method in class freemarker.cache.MultiTemplateLoader
Clears the sickiness memory, also resets the state of all enclosed StatefulTemplateLoader-s.
resetState() - Method in interface freemarker.cache.StatefulTemplateLoader
Invoked by Configuration.clearTemplateCache() to instruct this template loader to throw away its current state and start afresh.
resolve(String, Environment, Template) - Method in class freemarker.core.OptInTemplateClassResolver
 
resolve(String, Environment, Template) - Method in interface freemarker.core.TemplateClassResolver
Gets a Class based on the class name.
ResourceBundleLocalizedString - Class in freemarker.template
A concrete implementation of LocalizedString that gets a localized string from a ResourceBundle
ResourceBundleLocalizedString(String, String) - Constructor for class freemarker.template.ResourceBundleLocalizedString
 
ResourceBundleModel - Class in freemarker.ext.beans
A hash model that wraps a resource bundle.
ResourceBundleModel(ResourceBundle, BeansWrapper) - Constructor for class freemarker.ext.beans.ResourceBundleModel
 
resume() - Method in interface freemarker.debug.DebuggedEnvironment
Resumes the processing of the environment in the remote VM after it was stopped on a breakpoint.
RETHROW_HANDLER - Static variable in interface freemarker.template.TemplateExceptionHandler
TemplateExceptionHandler that simply re-throws the exception; this should be used in most production systems.
RhinoFunctionModel - Class in freemarker.ext.rhino
 
RhinoFunctionModel(Function, Scriptable, BeansWrapper) - Constructor for class freemarker.ext.rhino.RhinoFunctionModel
 
RhinoScriptableModel - Class in freemarker.ext.rhino
 
RhinoScriptableModel(Scriptable, BeansWrapper) - Constructor for class freemarker.ext.rhino.RhinoScriptableModel
 
RhinoWrapper - Class in freemarker.ext.rhino
 
RhinoWrapper() - Constructor for class freemarker.ext.rhino.RhinoWrapper
 
RichObjectWrapper - Interface in freemarker.template.utility
Experimental - subject to change: Union of the interfaces that a typical feature rich ObjectWrapper is expected to implement.
rightPad(String, int) - Static method in class freemarker.template.utility.StringUtil
Pads the string at the right with spaces until it reaches the desired length.
rightPad(String, int, char) - Static method in class freemarker.template.utility.StringUtil
Pads the string at the right with the specified character until it reaches the desired length.
rightPad(String, int, String) - Static method in class freemarker.template.utility.StringUtil
Pads the string at the right with a filling pattern until it reaches the desired length.
roundingPolicy - Variable in class freemarker.core.ArithmeticEngine
 
RTFEnc(String) - Static method in class freemarker.template.utility.StringUtil
Rich Text Format encoding (does not replace line breaks).
RTFEnc(String, Writer) - Static method in class freemarker.template.utility.StringUtil
Like StringUtil.RTFEnc(String), but writes the result into a Writer.
RTFOutputFormat - Class in freemarker.core
Represents the Rich Text Format output format (MIME type "application/rtf", name "RTF").

S

safeGetTemplateName(Template) - Method in class freemarker.core.OptInTemplateClassResolver
Extract the template name from the template object which will be matched against the trusted template names and pattern.
SAFER_RESOLVER - Static variable in interface freemarker.core.TemplateClassResolver
Same as TemplateClassResolver.UNRESTRICTED_RESOLVER, except that it doesn't allow resolving ObjectConstructor and Execute and freemarker.template.utility.JythonRuntime.
SCOPE_CONFIGURATION - Static variable in class freemarker.core.CustomAttribute
Constant used in the constructor specifying that this attribute is Configuration-scoped.
SCOPE_ENVIRONMENT - Static variable in class freemarker.core.CustomAttribute
Constant used in the constructor specifying that this attribute is Environment-scoped.
SCOPE_TEMPLATE - Static variable in class freemarker.core.CustomAttribute
Constant used in the constructor specifying that this attribute is Template-scoped.
SecurityUtilities - Class in freemarker.template.utility
 
selectLoggerLibrary(int) - Static method in class freemarker.log.Logger
Deprecated.
This method isn't reliable, unless you can somehow ensure that you access the FreeMarker classes first; use the "org.freemarker.loggerLibrary" Java system property instead, like java ... -Dorg.freemarker.loggerLibrary=slf4j. See Logger.SYSTEM_PROPERTY_NAME_LOGGER_LIBRARY for more.
serialVersionUID - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
serialVersionUID - Static variable in class freemarker.ext.util.IdentityHashMap
Deprecated.
 
ServletContextHashModel - Class in freemarker.ext.servlet
TemplateHashModel wrapper for a ServletContext attributes.
ServletContextHashModel(GenericServlet, ObjectWrapper) - Constructor for class freemarker.ext.servlet.ServletContextHashModel
 
ServletContextHashModel(ServletContext, ObjectWrapper) - Constructor for class freemarker.ext.servlet.ServletContextHashModel
sessionCreated(HttpSessionEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
sessionDestroyed(HttpSessionEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
set(Object, Environment) - Method in class freemarker.core.CustomAttribute
Sets the attribute inside the appropriate scope that's accessible through the specified Environment.
set(Object) - Method in class freemarker.core.CustomAttribute
set(Object, Template) - Method in class freemarker.core.CustomAttribute
Sets the value of a Template-scope attribute in the given Template.
set(Object, TemplateConfiguration) - Method in class freemarker.core.CustomAttribute
set(Object, Configuration) - Method in class freemarker.core.CustomAttribute
Sets the value of a Configuration-scope attribute in the given Configuration.
setAllowNoMatch(boolean) - Method in class freemarker.cache.FirstMatchTemplateConfigurationFactory
Use this to specify if having no matching choice is an error.
setAllSharedVariables(TemplateHashModelEx) - Method in class freemarker.template.Configuration
Adds all object in the hash as shared variable to the configuration; it's like doing several Configuration.setSharedVariable(String, Object) calls, one for each hash entry.
setAPIBuiltinEnabled(boolean) - Method in class freemarker.core.Configurable
Specifies if ?api can be used in templates.
setArithmeticEngine(ArithmeticEngine) - Method in class freemarker.core.Configurable
Sets the arithmetic engine used to perform arithmetic operations.
setAttemptFileAccess(boolean) - Method in class freemarker.cache.WebappTemplateLoader
Specifies that before loading templates with ServletContext.getResource(String), it should try to load the template as File; default is true, though it's not always recommended anymore.
setAttributesShadowItems(boolean) - Method in class freemarker.ext.jython.JythonWrapper
Sets whether attributes shadow items in wrapped objects.
setAutoEscapingPolicy(int) - Method in class freemarker.core.TemplateConfiguration
Sets the output format of the template; see Configuration.setAutoEscapingPolicy(int) for more.
setAutoEscapingPolicy(int) - Method in class freemarker.template.Configuration
Sets when auto-escaping should be enabled depending on the current output format; default is Configuration.ENABLE_IF_DEFAULT_AUTO_ESCAPING_POLICY.
setAutoFlush(boolean) - Method in class freemarker.core.Configurable
Sets whether the output Writer is automatically flushed at the end of Template.process(Object, Writer) (and its overloads).
setAutoImports(Map) - Method in class freemarker.core.Configurable
Removes all auto-imports, then calls Configurable.addAutoImport(String, String) for each Map-entry (the entry key is the namespaceVarName).
setAutoIncludes(List) - Method in class freemarker.core.Configurable
Removes all auto-includes, then calls Configurable.addAutoInclude(String) for each List items.
setBasedir(File) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
Set the base directory.
setBodyContent(BodyContent) - Method in class freemarker.ext.jsp.FreemarkerTag
 
setBooleanFormat(String) - Method in class freemarker.core.Configurable
The string value for the boolean true and false values, intended for human audience (not for a computer language), separated with comma.
setCacheStorage(CacheStorage) - Method in class freemarker.template.Configuration
Sets the CacheStorage used for caching Template-s; the earlier content of the template cache will be dropt.
setCaching(boolean) - Method in class freemarker.ext.jsp.FreemarkerTag
 
setCaseInsensitive(boolean) - Method in class freemarker.cache.FileExtensionMatcher
Sets if the matching will be case insensitive (UNICODE compliant); default is true.
setCaseInsensitive(boolean) - Method in class freemarker.cache.FileNameGlobMatcher
Sets if the matching will be case insensitive (UNICODE compliant); default is false.
setCaseInsensitive(boolean) - Method in class freemarker.cache.PathGlobMatcher
Sets if the matching will be case insensitive (UNICODE compliant); default is false.
setCategoryPrefix(String) - Static method in class freemarker.log.Logger
Deprecated.
This wasn't reliable, unless you can somehow ensure that you access the FreeMarker classes first. As it's not known to be useful for users, consider it removed.
setClassForTemplateLoading(Class, String) - Method in class freemarker.template.Configuration
Sets the class whose Class.getResource(String) method will be used to load templates, from the inside the package specified.
setClassicCompatible(boolean) - Method in class freemarker.core.Configurable
Toggles the "Classic Compatible" mode.
setClassicCompatibleAsInt(int) - Method in class freemarker.core.Configurable
Same as Configurable.setClassicCompatible(boolean), but allows some extra values.
setClassLoaderForTemplateLoading(ClassLoader, String) - Method in class freemarker.template.Configuration
Sets the ClassLoader whose ClassLoader.getResource(String) method will be used to load templates, from the inside the package specified.
setClasspathTlds(List) - Method in class freemarker.ext.jsp.TaglibFactory
Sets the class-loader resource paths of the TLD-s that aren't inside the locations covered by TaglibFactory.setMetaInfTldSources(List), yet you want them to be discovered.
setConfiguration(Configuration) - Method in class freemarker.cache.TemplateCache
setConfiguration(Configuration) - Method in class freemarker.cache.TemplateConfigurationFactory
setConfigurationDefaults() - Method in class freemarker.ext.servlet.FreemarkerServlet
Sets the defaults of the configuration that are specific to the FreemarkerServlet subclass.
setConfigurationOfChildren(Configuration) - Method in class freemarker.cache.ConditionalTemplateConfigurationFactory
 
setConfigurationOfChildren(Configuration) - Method in class freemarker.cache.FirstMatchTemplateConfigurationFactory
 
setConfigurationOfChildren(Configuration) - Method in class freemarker.cache.MergingTemplateConfigurationFactory
 
setConfigurationOfChildren(Configuration) - Method in class freemarker.cache.TemplateConfigurationFactory
setCurrentVisitorNode(TemplateNodeModel) - Method in class freemarker.core.Environment
sets TemplateNodeModel as the current visitor node.
setCustomAttribute(String, Object) - Method in class freemarker.core.Configurable
Sets a named custom attribute for this configurable.
setCustomDateFormats(Map<String, ? extends TemplateDateFormatFactory>) - Method in class freemarker.core.Configurable
Associates names with formatter factories, which then can be referred by the date_format, time_format, and datetime_format settings with values starting with @name.
setCustomLookupCondition(Object) - Method in class freemarker.template.Template
Mostly only used internally; setter pair of Template.getCustomLookupCondition().
setCustomNumberFormats(Map<String, ? extends TemplateNumberFormatFactory>) - Method in class freemarker.core.Configurable
Associates names with formatter factories, which then can be referred by the number_format setting with values starting with @name.
setCustomState(Object, Object) - Method in class freemarker.core.Environment
Sets the value of a custom state variable.
setDateFormat(String) - Method in class freemarker.core.Configurable
Sets the format used to convert Date-s to string-s that are date (no time part) values, also the format that someString?date will use to parse strings.
setDateFormat(String) - Method in class freemarker.core.Environment
 
setDateTimeFormat(String) - Method in class freemarker.core.Configurable
Sets the format used to convert Date-s to string-s that are date-time (timestamp) values, also the format that someString?datetime will use to parse strings.
setDateTimeFormat(String) - Method in class freemarker.core.Environment
 
setDefaultConfiguration(Configuration) - Static method in class freemarker.template.Configuration
Deprecated.
Using the "default" Configuration instance can easily lead to erroneous, unpredictable behaviour. See more here....
setDefaultDateType(int) - Method in class freemarker.ext.beans.BeansWrapper
Sets the default date type to use for date models that result from a plain java.util.Date instead of java.sql.Date or java.sql.Time or java.sql.Timestamp.
setDefaultDateType(int) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
setDefaultEncoding(String) - Method in class freemarker.template.Configuration
Sets the charset used for decoding byte sequences to character sequences when reading template files in a locale for which no explicit encoding was specified via Configuration.setEncoding(Locale, String).
setDefaultObjectWrapper(ObjectWrapper) - Static method in class freemarker.template.WrappingTemplateModel
Deprecated.
This method has VM-wide effect, which makes it unsuitable for application where multiple components might use FreeMarker internally.
setDelay(long) - Method in class freemarker.cache.TemplateCache
Sets the delay in milliseconds between checking for newer versions of a template sources.
setDestdir(File) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
Set the destination directory into which the generated files should be copied to
setDirectoryForTemplateLoading(File) - Method in class freemarker.template.Configuration
Sets the file system directory from which to load templates.
setDocumentBuilderFactory(DocumentBuilderFactory) - Static method in class freemarker.ext.dom.NodeModel
Deprecated.
It's a bad practice to change static fields, as if multiple independent components do that in the same JVM, they unintentionally affect each other. Therefore it's recommended to leave this static value at its default.
setEmulateCaseSensitiveFileSystem(boolean) - Method in class freemarker.cache.FileTemplateLoader
Intended for development only, checks if the template name matches the case (upper VS lower case letters) of the actual file name, and if it doesn't, it emulates a file-not-found even if the file system is case insensitive.
setEncoding(String) - Method in class freemarker.core.TemplateConfiguration
When the standard template loading/caching mechanism is used, this forces the charset used for reading the template "file", overriding everything but the encoding coming from the #ftl header.
setEncoding(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
Set encoding for generated files.
setEncoding(Locale, String) - Method in class freemarker.template.Configuration
Sets the character set encoding to use for templates of a given locale.
setEncoding(String) - Method in class freemarker.template.Template
Deprecated.
Should only be used internally, and might will be removed later.
setErrorHandler(ErrorHandler) - Static method in class freemarker.ext.dom.NodeModel
Deprecated.
It's a bad practice to change static fields, as if multiple independent components do that in the same JVM, they unintentionally affect each other. Therefore it's recommended to leave this static value at its default.
setExposeAsProperty(PropertyDescriptor) - Method in class freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision
 
setExposeFields(boolean) - Method in class freemarker.ext.beans.BeansWrapper
Controls whether public instance fields of classes are exposed to templates.
setExposeFields(boolean) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
setExposeMethodAs(String) - Method in class freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision
 
setExposureLevel(int) - Method in class freemarker.ext.beans.BeansWrapper
Sets the method exposure level.
setExposureLevel(int) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
setExtension(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
Set the output file extension.
setFile(File) - Method in class freemarker.ext.ant.JythonAntTask
 
setForceLegacyNonListCollections(boolean) - Method in class freemarker.template.DefaultObjectWrapper
Specifies whether non-List Collection-s (like Set-s) must be wrapped by pre-fetching into a SimpleSequence.
setForceLegacyNonListCollections(boolean) - Method in class freemarker.template.DefaultObjectWrapperConfiguration
setGlobalVariable(String, TemplateModel) - Method in class freemarker.core.Environment
Sets a variable that is visible globally.
setIncompatibleEnhancements(String) - Method in class freemarker.template.Configuration
setIncompatibleImprovements(Version) - Method in class freemarker.template.Configuration
Use Configuration.Configuration(Version) instead if possible; see the meaning of the parameter there.
setIncremental(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
Turn on/off incremental processing.
setIterableSupport(boolean) - Method in class freemarker.template.DefaultObjectWrapper
Specifies whether Iterable-s (not to be confused with Iterator-s) that don't implement any other recognized Java interfaces (most notably Collection) will be recognized as listable objects (TemplateCollectionModel-s), or they will be just seen as generic objects (JavaBean-s).
setIterableSupport(boolean) - Method in class freemarker.template.DefaultObjectWrapperConfiguration
setLazyAutoImports(Boolean) - Method in class freemarker.core.Configurable
Specifies if auto-imports will be lazy imports.
setLazyImports(boolean) - Method in class freemarker.core.Configurable
Specifies if <#import ...> (and Environment.importLib(String, String)) should delay the loading and processing of the imported templates until the content of the imported namespace is actually accessed.
setLocale(Locale) - Method in class freemarker.core.Configurable
Sets the locale used for number and date formatting (among others), also the locale used for searching localized template variations when no locale was explicitly requested.
setLocale(Locale) - Method in class freemarker.core.Environment
 
setLocale(Locale) - Method in class freemarker.template.Configuration
 
setLocalizedLookup(boolean) - Method in class freemarker.cache.TemplateCache
Setis if localized template lookup is enabled or not.
setLocalizedLookup(boolean) - Method in class freemarker.template.Configuration
Enables/disables localized template lookup.
setLocalVariable(String, TemplateModel) - Method in class freemarker.core.Environment
Sets a local variable (one effective only during a macro invocation).
setLogTemplateExceptions(boolean) - Method in class freemarker.core.Configurable
Specifies if TemplateException-s thrown by template processing are logged by FreeMarker or not.
setLogTemplateExceptions(boolean) - Method in class freemarker.template.Configuration
 
setMaxScale(int) - Method in class freemarker.core.ArithmeticEngine
Sets the maximal scale to use when multiplying BigDecimal numbers.
setMetaInfTldSources(List) - Method in class freemarker.ext.jsp.TaglibFactory
Sets the list of places where we will look for META-INF/**/*.tld files.
setMethodAppearanceFineTuner(MethodAppearanceFineTuner) - Method in class freemarker.ext.beans.BeansWrapper
Used to tweak certain aspects of how methods appear in the data-model; see MethodAppearanceFineTuner for more.
setMethodAppearanceFineTuner(MethodAppearanceFineTuner) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
See BeansWrapper.setMethodAppearanceFineTuner(MethodAppearanceFineTuner); additionally, note that currently setting this to non-null will disable class introspection cache sharing, unless the value implements SingletonCustomizer.
setMethodShadowsProperty(boolean) - Method in class freemarker.ext.beans.BeansWrapper.MethodAppearanceDecision
 
setMethodsShadowItems(boolean) - Method in class freemarker.ext.beans.BeansWrapper
Sets whether methods shadow items in beans.
setMinScale(int) - Method in class freemarker.core.ArithmeticEngine
Sets the minimal scale to use when dividing BigDecimal numbers.
setModels(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
 
setName(String) - Method in class freemarker.ext.jsp.FreemarkerTag
 
setNamingConvention(int) - Method in class freemarker.core.TemplateConfiguration
setNamingConvention(int) - Method in class freemarker.template.Configuration
Sets the naming convention used for the identifiers that are part of the template language.
setNewBuiltinClassResolver(TemplateClassResolver) - Method in class freemarker.core.Configurable
Sets the TemplateClassResolver that is used when the new built-in is called in a template.
setNoMatchErrorDetails(String) - Method in class freemarker.cache.FirstMatchTemplateConfigurationFactory
 
setNullModel(TemplateModel) - Method in class freemarker.ext.beans.BeansWrapper
Deprecated.
Changing the null model can cause a lot of confusion; don't do it.
setNumberFormat(String) - Method in class freemarker.core.Configurable
Sets the default number format used to convert numbers to strings.
setNumberFormat(String) - Method in class freemarker.core.Environment
 
setObjectWrapper(ObjectWrapper) - Method in class freemarker.core.Configurable
Sets the object wrapper used to wrap objects to TemplateModel-s.
setObjectWrapper(ObjectWrapper) - Method in class freemarker.ext.jsp.TaglibFactory
Sets the ObjectWrapper used when building the JSP tag library TemplateHashModel-s from the TLD-s.
setObjectWrapper(ObjectWrapper) - Method in class freemarker.template.Configuration
 
setObjectWrapper(ObjectWrapper) - Method in class freemarker.template.WrappingTemplateModel
 
setOut(Writer) - Method in class freemarker.core.Environment
 
setOuterIdentity(ObjectWrapper) - Method in class freemarker.ext.beans.BeansWrapper
When wrapping an object, the BeansWrapper commonly needs to wrap "sub-objects", for example each element in a wrapped collection.
setOuterIdentity(ObjectWrapper) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
See BeansWrapper.setOuterIdentity(ObjectWrapper), except here the default is null that means the ObjectWrapper that you will set up with this BeansWrapperBuilder object.
setOutputEncoding(String) - Method in class freemarker.core.Configurable
Informs FreeMarker about the charset used for the output.
setOutputEncoding(String) - Method in class freemarker.core.Environment
 
setOutputFormat(OutputFormat) - Method in class freemarker.core.TemplateConfiguration
Sets the output format of the template; see Configuration.setOutputFormat(OutputFormat) for more.
setOutputFormat(OutputFormat) - Method in class freemarker.template.Configuration
Sets the default output format.
setPageContext(PageContext) - Method in class freemarker.ext.jsp.FreemarkerTag
 
setParent(Tag) - Method in class freemarker.ext.jsp.FreemarkerTag
 
setParentConfiguration(Configuration) - Method in class freemarker.core.TemplateConfiguration
Associates this instance with a Configuration; usually you don't call this, as it's called internally when this instance is added to a Configuration.
setProjectfile(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
Set the path to the project XML file
setRecognizeStandardFileExtensions(boolean) - Method in class freemarker.core.TemplateConfiguration
setRecognizeStandardFileExtensions(boolean) - Method in class freemarker.template.Configuration
Sets if the "file" extension part of the source name (Template.getSourceName()) will influence certain parsing settings.
setRegisteredCustomOutputFormats(Collection<? extends OutputFormat>) - Method in class freemarker.template.Configuration
Sets the custom output formats that can be referred by their unique name (OutputFormat.getName()) from templates.
setRoundingPolicy(int) - Method in class freemarker.core.ArithmeticEngine
 
setServletContextForTemplateLoading(Object, String) - Method in class freemarker.template.Configuration
Sets the servlet context from which to load templates.
setSetting(String, String) - Method in class freemarker.core.Configurable
Sets a FreeMarker setting by a name and string value.
setSetting(String, String) - Method in class freemarker.template.Configuration
 
setSettings(Properties) - Method in class freemarker.core.Configurable
Set the settings stored in a Properties object.
setSettings(InputStream) - Method in class freemarker.core.Configurable
Reads a setting list (key and element pairs) from the input stream.
setSharedVariable(String, TemplateModel) - Method in class freemarker.template.Configuration
Adds a shared variable to the configuration.
setSharedVariable(String, Object) - Method in class freemarker.template.Configuration
Adds shared variable to the configuration; It uses Configurable.getObjectWrapper() to wrap the value, so it's important that the object wrapper is set before this.
setSharedVaribles(Map) - Method in class freemarker.template.Configuration
Replaces all shared variables (removes all previously added ones).
setShowErrorTips(boolean) - Method in class freemarker.core.Configurable
Sets if tips should be shown in error messages of errors arising during template processing.
setSimpleMapWrapper(boolean) - Method in class freemarker.ext.beans.BeansWrapper
When set to true, the keys in Map-s won't mix with the method names when looking at them from templates.
setSimpleMapWrapper(boolean) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
setSQLDateAndTimeTimeZone(TimeZone) - Method in class freemarker.core.Configurable
Sets the time zone used when dealing with java.sql.Date and java.sql.Time values.
setSQLDateAndTimeTimeZone(TimeZone) - Method in class freemarker.core.Environment
 
setSticky(boolean) - Method in class freemarker.cache.MultiTemplateLoader
Sets if for a name that was already loaded earlier the same TemplateLoader will be tried first, or we always try the TemplateLoader-s strictly in the order as it was specified in the constructor.
setStrict(boolean) - Method in class freemarker.ext.beans.BeansWrapper
Specifies if an attempt to read a bean property that doesn't exist in the wrapped object should throw an InvalidPropertyException.
setStrict(boolean) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
setStrictBeanModels(boolean) - Method in class freemarker.core.Configurable
Deprecated.
Set this on the ObjectWrapper itself.
setStrictBeanModels(boolean) - Method in class freemarker.core.TemplateConfiguration
 
setStrictSyntaxMode(boolean) - Method in class freemarker.core.TemplateConfiguration
setStrictSyntaxMode(boolean) - Method in class freemarker.template.Configuration
Deprecated.
Only true (the default) value will be supported sometimes in the future.
setTabSize(int) - Method in class freemarker.core.TemplateConfiguration
setTabSize(int) - Method in class freemarker.template.Configuration
Sets the assumed display width of the tab character (ASCII 9), which influences the column number shown in error messages (or the column number you get through other API-s).
setTagSyntax(int) - Method in class freemarker.core.TemplateConfiguration
setTagSyntax(int) - Method in class freemarker.template.Configuration
Determines the syntax of the template files (angle bracket VS square bracket) that has no #ftl in it.
setTemplate(Template) - Method in class freemarker.core.FreeMarkerTree
Deprecated.
 
setTemplate(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
 
setTemplateConfigurations(TemplateConfigurationFactory) - Method in class freemarker.template.Configuration
Sets a TemplateConfigurationFactory that will configure individual templates where their settings differ from those coming from the common Configuration object.
setTemplateDir(File) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
 
setTemplateEncoding(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
 
setTemplateExceptionHandler(TemplateExceptionHandler) - Method in class freemarker.core.Configurable
Sets the exception handler used to handle exceptions occurring inside templates.
setTemplateExceptionHandler(TemplateExceptionHandler) - Method in class freemarker.core.Environment
 
setTemplateExceptionHandler(TemplateExceptionHandler) - Method in class freemarker.template.Configuration
 
setTemplateLoader(TemplateLoader) - Method in class freemarker.template.Configuration
Sets a TemplateLoader that is used to look up and load templates; as a side effect the template cache will be emptied (unless the new and the old values are the same).
setTemplateLookupStrategy(TemplateLookupStrategy) - Method in class freemarker.template.Configuration
Sets a TemplateLookupStrategy that is used to look up templates based on the requested name; as a side effect the template cache will be emptied.
setTemplateName(String) - Method in exception freemarker.core.ParseException
Should be used internally only; sets the name of the template that contains the error.
setTemplateNameFormat(TemplateNameFormat) - Method in class freemarker.template.Configuration
Sets the template name format used.
setTemplateUpdateDelay(int) - Method in class freemarker.template.Configuration
Deprecated.
Use Configuration.setTemplateUpdateDelayMilliseconds(long) instead, because the time granularity of this method is often misunderstood to be milliseconds.
setTemplateUpdateDelayMilliseconds(long) - Method in class freemarker.template.Configuration
Sets the time in milliseconds that must elapse before checking whether there is a newer version of a template "file" exists than the cached one.
setTimeFormat(String) - Method in class freemarker.core.Configurable
Sets the format used to convert Date-s to string-s that are time (no date part) values, also the format that someString?time will use to parse strings.
setTimeFormat(String) - Method in class freemarker.core.Environment
 
setTimeZone(TimeZone) - Method in class freemarker.core.Configurable
Sets the time zone to use when formatting date/time values.
setTimeZone(TimeZone) - Method in class freemarker.core.Environment
 
setTimeZone(TimeZone) - Method in class freemarker.template.Configuration
 
settingValueAssignmentException(String, String, Throwable) - Method in class freemarker.core.Configurable
 
setTreatDefaultMethodsAsBeanMembers(boolean) - Method in class freemarker.ext.beans.BeansWrapper
Controls whether Java 8 default methods that weren't overridden in a class will be recognized as bean property accessors and/or bean actions, and thus will be visible from templates.
setTreatDefaultMethodsAsBeanMembers(boolean) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
setURLConnectionUsesCaches(Boolean) - Method in class freemarker.cache.URLTemplateLoader
Sets if URLConnection.setUseCaches(boolean) will be called, and with what value.
setURLConnectionUsesCaches(Boolean) - Method in class freemarker.cache.WebappTemplateLoader
setURLEscapingCharset(String) - Method in class freemarker.core.Configurable
Sets the URL escaping charset.
setURLEscapingCharset(String) - Method in class freemarker.core.Environment
 
setUseAdaptersForContainers(boolean) - Method in class freemarker.template.DefaultObjectWrapper
Sets if to wrap container objects (Map-s, List-s, arrays and such) the legacy copying approach or the newer adapter approach should be used.
setUseAdaptersForContainers(boolean) - Method in class freemarker.template.DefaultObjectWrapperConfiguration
setUseCache(boolean) - Method in class freemarker.ext.beans.BeansWrapper
Sets whether this wrapper caches the TemplateModel-s created for the Java objects that has wrapped with this object wrapper.
setUseCache(boolean) - Method in class freemarker.ext.jython.JythonWrapper
Sets whether this wrapper caches model instances.
setUseCache(boolean) - Method in class freemarker.ext.util.ModelCache
Sets whether this wrapper caches model instances.
setUseModelCache(boolean) - Method in class freemarker.ext.beans.BeansWrapperConfiguration
See BeansWrapper.setUseCache(boolean) (it means the same).
setValidation(boolean) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.
Sets whether to validate the XML input.
setVariable(String, TemplateModel) - Method in class freemarker.core.Environment
Sets a variable in the current namespace.
setWhitespaceStripping(boolean) - Method in class freemarker.core.TemplateConfiguration
setWhitespaceStripping(boolean) - Method in class freemarker.template.Configuration
Sets whether the FTL parser will try to remove superfluous white-space around certain FTL tags.
setXPathSupportClass(Class) - Static method in class freemarker.ext.dom.NodeModel
Set an alternative implementation of freemarker.ext.dom.XPathSupport to use as the XPath engine.
SHOW_ERROR_TIPS_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
SHOW_ERROR_TIPS_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
SHOW_ERROR_TIPS_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
SIMPLE_WRAPPER - Static variable in interface freemarker.template.ObjectWrapper
Deprecated.
No replacement as it was seldom if ever used by anyone; this instance isn't read-only and thus can't be trusted.
SimpleCollection - Class in freemarker.template
A simple implementation of TemplateCollectionModel.
SimpleCollection(Iterator) - Constructor for class freemarker.template.SimpleCollection
SimpleCollection(Collection) - Constructor for class freemarker.template.SimpleCollection
SimpleCollection(Iterator, ObjectWrapper) - Constructor for class freemarker.template.SimpleCollection
 
SimpleCollection(Collection, ObjectWrapper) - Constructor for class freemarker.template.SimpleCollection
 
SimpleDate - Class in freemarker.template
A simple implementation of the TemplateDateModel interface.
SimpleDate(Date) - Constructor for class freemarker.template.SimpleDate
Creates a new date model wrapping the specified date object and having DATE type.
SimpleDate(Time) - Constructor for class freemarker.template.SimpleDate
Creates a new date model wrapping the specified time object and having TIME type.
SimpleDate(Timestamp) - Constructor for class freemarker.template.SimpleDate
Creates a new date model wrapping the specified time object and having DATETIME type.
SimpleDate(Date, int) - Constructor for class freemarker.template.SimpleDate
Creates a new date model wrapping the specified date object and having the specified type.
SimpleHash - Class in freemarker.template
A simple implementation of the TemplateHashModelEx interface, using its own underlying Map or SortedMap for storing the hash entries.
SimpleHash() - Constructor for class freemarker.template.SimpleHash
SimpleHash(Map) - Constructor for class freemarker.template.SimpleHash
SimpleHash(ObjectWrapper) - Constructor for class freemarker.template.SimpleHash
Creates an empty simple hash using the specified object wrapper.
SimpleHash(Map, ObjectWrapper) - Constructor for class freemarker.template.SimpleHash
Creates a new hash by shallow-coping (possibly cloning) the underlying map; in many applications you should use DefaultMapAdapter instead.
SimpleList - Class in freemarker.template
Deprecated.
Use SimpleSequence instead.
SimpleList() - Constructor for class freemarker.template.SimpleList
Deprecated.
 
SimpleList(List) - Constructor for class freemarker.template.SimpleList
Deprecated.
 
SimpleMapModel - Class in freemarker.ext.beans
Model used by BeansWrapper when simpleMapWrapper mode is enabled.
SimpleMapModel(Map, BeansWrapper) - Constructor for class freemarker.ext.beans.SimpleMapModel
 
SimpleMethodModel - Class in freemarker.ext.beans
A class that will wrap a reflected method call into a TemplateMethodModel interface.
SimpleNumber - Class in freemarker.template
A simple implementation of the TemplateNumberModel interface.
SimpleNumber(Number) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(byte) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(short) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(int) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(long) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(float) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(double) - Constructor for class freemarker.template.SimpleNumber
 
SimpleObjectWrapper - Class in freemarker.template
A restricted object wrapper that will not expose arbitrary object, just those that directly correspond to the TemplateModel sub-interfaces (String, Map and such).
SimpleObjectWrapper() - Constructor for class freemarker.template.SimpleObjectWrapper
SimpleObjectWrapper(Version) - Constructor for class freemarker.template.SimpleObjectWrapper
 
SimpleScalar - Class in freemarker.template
A simple implementation of the TemplateScalarModel interface, using a String.
SimpleScalar(String) - Constructor for class freemarker.template.SimpleScalar
Constructs a SimpleScalar containing a string value.
SimpleSequence - Class in freemarker.template
A simple implementation of the TemplateSequenceModel interface, using its own underlying List for storing the list items.
SimpleSequence() - Constructor for class freemarker.template.SimpleSequence
SimpleSequence(int) - Constructor for class freemarker.template.SimpleSequence
SimpleSequence(Collection) - Constructor for class freemarker.template.SimpleSequence
SimpleSequence(TemplateCollectionModel) - Constructor for class freemarker.template.SimpleSequence
Constructs a simple sequence from the passed collection model, which shouldn't be added to later.
SimpleSequence(ObjectWrapper) - Constructor for class freemarker.template.SimpleSequence
Constructs an empty sequence using the specified object wrapper.
SimpleSequence(int, ObjectWrapper) - Constructor for class freemarker.template.SimpleSequence
Constructs an empty simple sequence with preallocated capacity.
SimpleSequence(Collection, ObjectWrapper) - Constructor for class freemarker.template.SimpleSequence
Constructs a simple sequence that will contain the elements from the specified Collection; consider using DefaultListAdapter instead.
simplify(Node) - Static method in class freemarker.ext.dom.NodeModel
Removes all comments and processing instruction, and unites adjacent text nodes (here CDATA counts as text as well).
SingletonCustomizer - Interface in freemarker.ext.beans
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.
singletonList(Object) - Static method in class freemarker.template.utility.Collections12
Deprecated.
 
singletonMap(Object, Object) - Static method in class freemarker.template.utility.Collections12
Deprecated.
 
size() - Method in interface freemarker.debug.DebugModel
 
size() - Method in class freemarker.ext.beans.ArrayModel
 
size() - Method in class freemarker.ext.beans.BeanModel
 
size() - Method in class freemarker.ext.beans.CollectionModel
 
size() - Method in class freemarker.ext.beans.MapModel
 
size() - Method in class freemarker.ext.beans.OverloadedMethodsModel
 
size() - Method in class freemarker.ext.beans.ResourceBundleModel
 
size() - Method in class freemarker.ext.beans.SimpleMapModel
 
size() - Method in class freemarker.ext.beans.SimpleMethodModel
 
size() - Method in class freemarker.ext.dom.NodeModel
Always returns 1.
size() - Method in class freemarker.ext.jdom.NodeListModel
Deprecated.
 
size() - Method in class freemarker.ext.jython.JythonHashModel
Returns PyObject.__len__().
size() - Method in class freemarker.ext.jython.JythonSequenceModel
Returns PyObject.__len__().
size() - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
size() - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
size() - Method in class freemarker.ext.servlet.HttpRequestParametersHashModel
 
size() - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Returns the number of key-value mappings in this map.
size() - Method in class freemarker.ext.xml.NodeListModel
Deprecated.
Returns the number of nodes in this model's nodelist.
size() - Method in class freemarker.template.DefaultListAdapter
 
size() - Method in class freemarker.template.DefaultMapAdapter
 
size() - Method in class freemarker.template.DefaultNonListCollectionAdapter
 
size() - Method in class freemarker.template.SimpleHash
 
size() - Method in class freemarker.template.SimpleSequence
 
size() - Method in interface freemarker.template.TemplateCollectionModelEx
Returns the number items in this collection, or Integer.MAX_VALUE, if there are more than Integer.MAX_VALUE items.
size() - Method in interface freemarker.template.TemplateHashModelEx
 
size() - Method in class freemarker.template.TemplateModelListSequence
 
size() - Method in interface freemarker.template.TemplateSequenceModel
 
SKIP_BODY - Static variable in interface freemarker.template.TransformControl
Constant returned from TransformControl.onStart() that tells the template engine to skip evaluation of the body.
SoftCacheStorage - Class in freemarker.cache
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.
SoftCacheStorage() - Constructor for class freemarker.cache.SoftCacheStorage
Creates an instance that uses a ConcurrentMap internally.
SoftCacheStorage(Map) - Constructor for class freemarker.cache.SoftCacheStorage
 
specialConstructor - Variable in exception freemarker.core.ParseException
Deprecated.
Will be remove without replacement in 2.4.
specifiedEncoding - Variable in exception freemarker.template.Template.WrongEncodingException
split(String, char) - Static method in class freemarker.template.utility.StringUtil
Splits a string at the specified character.
split(String, String, boolean) - Static method in class freemarker.template.utility.StringUtil
Splits a string at the specified string.
SQL_DATE_AND_TIME_TIME_ZONE_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
SQL_DATE_AND_TIME_TIME_ZONE_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
SQL_DATE_AND_TIME_TIME_ZONE_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
SQUARE_BRACKET_TAG_SYNTAX - Static variable in class freemarker.template.Configuration
 
StandardCompress - Class in freemarker.template.utility
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.
StandardCompress() - Constructor for class freemarker.template.utility.StandardCompress
 
StandardCompress(int) - Constructor for class freemarker.template.utility.StandardCompress
 
StatefulTemplateLoader - Interface in freemarker.cache
Interface that can be implemented by TemplateLoader-s that maintain some sort of internal state (i.e.
stop() - Method in interface freemarker.debug.DebuggedEnvironment
Stops the processing of the environment after it was stopped on a breakpoint.
StopException - Exception in freemarker.core
This exception is thrown when a #stop directive is encountered.
STRICT_BEAN_MODELS - Static variable in class freemarker.core.Configurable
Deprecated.
STRICT_BEAN_MODELS_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
STRICT_BEAN_MODELS_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
STRICT_BEAN_MODELS_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
STRICT_SYNTAX_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
STRICT_SYNTAX_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
STRICT_SYNTAX_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
StringModel - Class in freemarker.ext.beans
Subclass of BeanModel that exposes the return value of the Object.toString() method through the TemplateScalarModel interface.
StringModel(Object, BeansWrapper) - Constructor for class freemarker.ext.beans.StringModel
Creates a new model that wraps the specified object with BeanModel + scalar functionality.
StringTemplateLoader - Class in freemarker.cache
A TemplateLoader that uses a Map with String-s as its source of templates.
StringTemplateLoader() - Constructor for class freemarker.cache.StringTemplateLoader
 
StringUtil - Class in freemarker.template.utility
Some text related utilities.
StringUtil() - Constructor for class freemarker.template.utility.StringUtil
 
StrongCacheStorage - Class in freemarker.cache
Strong cache storage is a cache storage that simply wraps a Map.
StrongCacheStorage() - Constructor for class freemarker.cache.StrongCacheStorage
 
subtract(Number, Number) - Method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
subtract(Number, Number) - Method in class freemarker.core.ArithmeticEngine.ConservativeEngine
 
subtract(Number, Number) - Method in class freemarker.core.ArithmeticEngine
 
synchronizedWrapper() - Method in class freemarker.template.SimpleHash
 
synchronizedWrapper() - Method in class freemarker.template.SimpleSequence
 
SYSTEM_PROPERTY_CLASSPATH_TLDS - Static variable in class freemarker.ext.servlet.FreemarkerServlet
When set, the items defined in it will be added after those coming from the "ClasspathTlds" init-param.
SYSTEM_PROPERTY_META_INF_TLD_SOURCES - Static variable in class freemarker.ext.servlet.FreemarkerServlet
When set, the items defined in it will be added after those coming from the "MetaInfTldSources" init-param.
SYSTEM_PROPERTY_NAME_EMULATE_CASE_SENSITIVE_FILE_SYSTEM - Static variable in class freemarker.cache.FileTemplateLoader
By setting this Java system property to true, you can change the default of #getEmulateCaseSensitiveFileSystem().
SYSTEM_PROPERTY_NAME_LOGGER_LIBRARY - Static variable in class freemarker.log.Logger
The "org.freemarker.loggerLibrary" system property is used to select a logger library explicitly, rather than relying on automatic selection.

T

TAB_SIZE_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation.
TAB_SIZE_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
TAB_SIZE_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
TAG_SYNTAX_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
TAG_SYNTAX_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
TAG_SYNTAX_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
TaglibFactory - Class in freemarker.ext.jsp
A hash model associated with a servlet context that can load JSP tag libraries associated with that servlet context.
TaglibFactory(ServletContext) - Constructor for class freemarker.ext.jsp.TaglibFactory
/** Creates a new JSP taglib factory that will be used to load JSP tag libraries and functions for the web application represented by the passed in ServletContext.
TaglibFactory.ClasspathMetaInfTldSource - Class in freemarker.ext.jsp
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 - Class in freemarker.ext.jsp
When it occurs in the TaglibFactory.MetaInfTldSource list, all TaglibFactory.MetaInfTldSource-s before it will be disabled.
TaglibFactory.MetaInfTldSource - Class in freemarker.ext.jsp
A location within which we will look for META-INF/**/*.tld-s.
TaglibFactory.WebInfPerLibJarMetaInfTldSource - Class in freemarker.ext.jsp
To search TLD-s under sevletContext:/WEB-INF/lib/*.{jar,zip}/META-INF/**/*.tld, as requested by the JSP specification.
Template - Class in freemarker.template
Stores an already parsed template, ready to be processed (rendered) for unlimited times, possibly from multiple threads.
Template(String, Reader, Configuration) - Constructor for class freemarker.template.Template
Same as Template.Template(String, String, Reader, Configuration) with null sourceName parameter.
Template(String, String, Configuration) - Constructor for class freemarker.template.Template
Template(String, Reader, Configuration, String) - Constructor for class freemarker.template.Template
Convenience constructor for Template(name, null, reader, cfg, encoding).
Template(String, String, Reader, Configuration) - Constructor for class freemarker.template.Template
Constructs a template from a character stream.
Template(String, String, Reader, Configuration, String) - Constructor for class freemarker.template.Template
Same as Template.Template(String, String, Reader, Configuration), but also specifies the template's encoding (not recommended).
Template(String, String, Reader, Configuration, ParserConfiguration, String) - Constructor for class freemarker.template.Template
Template(String, Reader) - Constructor for class freemarker.template.Template
Deprecated.
This constructor uses the "default" Configuration instance, which can easily lead to erroneous, unpredictable behavior. See more here....
Template.WrongEncodingException - Exception in freemarker.template
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.
TEMPLATE_CONFIGURATIONS_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation.
TEMPLATE_CONFIGURATIONS_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
TEMPLATE_CONFIGURATIONS_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
TEMPLATE_EXCEPTION_HANDLER_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
TEMPLATE_EXCEPTION_HANDLER_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
TEMPLATE_EXCEPTION_HANDLER_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
TEMPLATE_LOADER_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
TEMPLATE_LOADER_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
TEMPLATE_LOADER_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
TEMPLATE_LOOKUP_STRATEGY_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
TEMPLATE_LOOKUP_STRATEGY_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
TEMPLATE_LOOKUP_STRATEGY_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
TEMPLATE_NAME_FORMAT_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
TEMPLATE_NAME_FORMAT_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
TEMPLATE_NAME_FORMAT_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
TEMPLATE_UPDATE_DELAY_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
TEMPLATE_UPDATE_DELAY_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
TEMPLATE_UPDATE_DELAY_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
TemplateBooleanModel - Interface in freemarker.template
"boolean" template language data type; same as in Java; either true or false.
TemplateCache - Class in freemarker.cache
Performs caching and on-demand loading of the templates.
TemplateCache() - Constructor for class freemarker.cache.TemplateCache
Deprecated.
Use TemplateCache.TemplateCache(TemplateLoader) instead. The default loader is useless in most applications, also it can mean a security risk.
TemplateCache(TemplateLoader) - Constructor for class freemarker.cache.TemplateCache
TemplateCache(TemplateLoader, CacheStorage) - Constructor for class freemarker.cache.TemplateCache
TemplateCache(TemplateLoader, Configuration) - Constructor for class freemarker.cache.TemplateCache
TemplateCache(TemplateLoader, CacheStorage, Configuration) - Constructor for class freemarker.cache.TemplateCache
TemplateCache(TemplateLoader, CacheStorage, TemplateLookupStrategy, TemplateNameFormat, Configuration) - Constructor for class freemarker.cache.TemplateCache
TemplateCache(TemplateLoader, CacheStorage, TemplateLookupStrategy, TemplateNameFormat, TemplateConfigurationFactory, Configuration) - Constructor for class freemarker.cache.TemplateCache
 
TemplateCache.MaybeMissingTemplate - Class in freemarker.cache
TemplateClassResolver - Interface in freemarker.core
Used by built-ins and other template language features that get a class based on a string.
TemplateCollectionModel - Interface in freemarker.template
"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 - Interface in freemarker.template
"extended collection" template language data type: Adds size/emptiness querybility and "contains" test to TemplateCollectionModel.
TemplateCombinedMarkupOutputModel - Class in freemarker.core
Stores combined markup to be printed; used with CombinedMarkupOutputFormat.
TemplateConfiguration - Class in freemarker.core
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.
TemplateConfiguration() - Constructor for class freemarker.core.TemplateConfiguration
Creates a new instance.
TemplateConfigurationFactory - Class in freemarker.cache
Creates (or returns) TemplateConfiguration-s for template sources.
TemplateConfigurationFactory() - Constructor for class freemarker.cache.TemplateConfigurationFactory
 
TemplateConfigurationFactoryException - Exception in freemarker.cache
Non-I/O exception thrown by TemplateConfigurationFactory-s.
TemplateConfigurationFactoryException(String) - Constructor for exception freemarker.cache.TemplateConfigurationFactoryException
 
TemplateConfigurationFactoryException(String, Throwable) - Constructor for exception freemarker.cache.TemplateConfigurationFactoryException
 
TemplateDateFormat - Class in freemarker.core
Represents a date/time/dateTime format; used in templates for formatting and parsing with that format.
TemplateDateFormat() - Constructor for class freemarker.core.TemplateDateFormat
 
TemplateDateFormatFactory - Class in freemarker.core
Factory for a certain kind of date/time/dateTime formatting (TemplateDateFormat).
TemplateDateFormatFactory() - Constructor for class freemarker.core.TemplateDateFormatFactory
 
TemplateDateModel - Interface in freemarker.template
"date", "time" and "date-time" template language data types: corresponds to Date.
TemplateDirectiveBody - Interface in freemarker.template
Represents the nested content of a directive (TemplateDirectiveModel) invocation.
TemplateDirectiveModel - Interface in freemarker.template
"directive" template language data type: used as user-defined directives (much like macros) in templates.
TemplateException - Exception in freemarker.template
Runtime exception in a template (as opposed to a parsing-time exception: ParseException).
TemplateException(Environment) - Constructor for exception freemarker.template.TemplateException
Constructs a TemplateException with no specified detail message or underlying cause.
TemplateException(String, Environment) - Constructor for exception freemarker.template.TemplateException
Constructs a TemplateException with the given detail message, but no underlying cause exception.
TemplateException(Exception, Environment) - Constructor for exception freemarker.template.TemplateException
The same as TemplateException.TemplateException(Throwable, Environment); it's exists only for binary backward-compatibility.
TemplateException(Throwable, Environment) - Constructor for exception freemarker.template.TemplateException
Constructs a TemplateException with the given underlying Exception, but no detail message.
TemplateException(String, Exception, Environment) - Constructor for exception freemarker.template.TemplateException
The same as TemplateException.TemplateException(String, Throwable, Environment); it's exists only for binary backward-compatibility.
TemplateException(String, Throwable, Environment) - Constructor for exception freemarker.template.TemplateException
Constructs a TemplateException with both a description of the error that occurred and the underlying Exception that caused this exception to be raised.
TemplateException(Throwable, Environment, Expression, _ErrorDescriptionBuilder) - Constructor for exception freemarker.template.TemplateException
Don't use this; this is to be used internally by FreeMarker.
TemplateExceptionHandler - Interface in freemarker.template
Used for the template_exception_handler configuration setting; see Configurable.setTemplateExceptionHandler(TemplateExceptionHandler) for more.
TemplateFormatUtil - Class in freemarker.core
Utility classes for implementing TemplateValueFormat-s.
TemplateHashModel - Interface in freemarker.template
"hash" template language data type: an object that contains other objects accessible through string keys (sub-variable names).
TemplateHashModelEx - Interface in freemarker.template
"extended hash" template language data type; extends TemplateHashModel by allowing iterating through its keys and values.
TemplateHashModelEx2 - Interface in freemarker.template
Adds key-value pair listing capability to TemplateHashModelEx.
TemplateHashModelEx2.KeyValuePair - Interface in freemarker.template
A key-value pair in a hash; used for TemplateHashModelEx2.KeyValuePairIterator.
TemplateHashModelEx2.KeyValuePairIterator - Interface in freemarker.template
Iterates over the key-value pairs in a hash.
TemplateHTMLOutputModel - Class in freemarker.core
Stores HTML markup to be printed; used with HTMLOutputFormat.
TemplateLoader - Interface in freemarker.cache
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 - Class in freemarker.cache
TemplateLookupResult - Class in freemarker.cache
The return value of TemplateLookupStrategy.lookup(TemplateLookupContext) and similar lookup methods.
TemplateLookupStrategy - Class in freemarker.cache
Finds the TemplateLoader-level (storage-level) template source for the template name with which the template was requested (as in Configuration.getTemplate(String)).
TemplateLookupStrategy() - Constructor for class freemarker.cache.TemplateLookupStrategy
 
TemplateMarkupOutputModel<MO extends TemplateMarkupOutputModel<MO>> - Interface in freemarker.core
"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 - Interface in freemarker.template
Deprecated.
Use TemplateMethodModelEx instead. This interface is from the old times when the only kind of value you could pass in was string.
TemplateMethodModelEx - Interface in freemarker.template
"extended method" template language data type: Objects that act like functions.
TemplateModel - Interface in freemarker.template
The common super-interface of the interfaces that stand for the FreeMarker Template Language (FTL) data types.
TemplateModelAdapter - Interface in freemarker.template
Implemented by classes that serve as adapters for template model objects in some other object model.
TemplateModelException - Exception in freemarker.template
TemplateModel methods throw this exception if the requested data can't be retrieved.
TemplateModelException() - Constructor for exception freemarker.template.TemplateModelException
Constructs a TemplateModelException with no specified detail message.
TemplateModelException(String) - Constructor for exception freemarker.template.TemplateModelException
Constructs a TemplateModelException with the specified detail message.
TemplateModelException(Exception) - Constructor for exception freemarker.template.TemplateModelException
The same as TemplateModelException.TemplateModelException(Throwable); it's exists only for binary backward-compatibility.
TemplateModelException(Throwable) - Constructor for exception freemarker.template.TemplateModelException
Constructs a TemplateModelException with the given underlying Exception, but no detail message.
TemplateModelException(String, Exception) - Constructor for exception freemarker.template.TemplateModelException
The same as TemplateModelException.TemplateModelException(String, Throwable); it's exists only for binary backward-compatibility.
TemplateModelException(String, Throwable) - Constructor for exception freemarker.template.TemplateModelException
Constructs a TemplateModelException with both a description of the error that occurred and the underlying Exception that caused this exception to be raised.
TemplateModelException(Throwable, Environment, String, boolean) - Constructor for exception freemarker.template.TemplateModelException
Don't use this; this is to be used internally by FreeMarker.
TemplateModelException(Throwable, Environment, _ErrorDescriptionBuilder, boolean) - Constructor for exception freemarker.template.TemplateModelException
Don't use this; this is to be used internally by FreeMarker.
TemplateModelIterator - Interface in freemarker.template
Used to iterate over a set of template models once; usually returned from TemplateCollectionModel.iterator().
TemplateModelListSequence - Class in freemarker.template
A sequence that wraps a List of TemplateModel-s.
TemplateModelListSequence(List) - Constructor for class freemarker.template.TemplateModelListSequence
 
TemplateModelWithAPISupport - Interface in freemarker.template
Experimental - subject to change: A TemplateModel on which the ?api operation can be applied.
TemplateNameFormat - Class in freemarker.cache
Symbolized template name format.
TemplateNodeModel - Interface in freemarker.template
"node" template language data type: an object that is a node in a tree.
TemplateNodeModelEx - Interface in freemarker.template
A NodeModel that supports navigating to the previous and next sibling nodes.
TemplateNotFoundException - Exception in freemarker.template
Thrown when Configuration.getTemplate(String) (or similar) doesn't find a template.
TemplateNotFoundException(String, Object, String) - Constructor for exception freemarker.template.TemplateNotFoundException
 
TemplateNumberFormat - Class in freemarker.core
Represents a number format; used in templates for formatting and parsing with that format.
TemplateNumberFormat() - Constructor for class freemarker.core.TemplateNumberFormat
 
TemplateNumberFormatFactory - Class in freemarker.core
Factory for a certain kind of number formatting (TemplateNumberFormat).
TemplateNumberFormatFactory() - Constructor for class freemarker.core.TemplateNumberFormatFactory
 
TemplateNumberModel - Interface in freemarker.template
"number" template language data type; an object that stores a number.
TemplateRTFOutputModel - Class in freemarker.core
Stores RTF markup to be printed; used with RTFOutputFormat.
TemplateScalarModel - Interface in freemarker.template
"string" template language data-type; like in Java, an unmodifiable UNICODE character sequence.
TemplateSequenceModel - Interface in freemarker.template
"sequence" template language data type; an object that contains other objects accessible through an integer 0-based index.
TemplateSourceMatcher - Class in freemarker.cache
 
TemplateSourceMatcher() - Constructor for class freemarker.cache.TemplateSourceMatcher
 
TemplateTransformModel - Interface in freemarker.template
"transform" template language data type: user-defined directives (much like macros) specialized on filtering output; you should rather use the newer TemplateDirectiveModel instead.
TemplateValueFormat - Class in freemarker.core
Superclass of all value format objects; objects that convert values to strings, or parse strings.
TemplateValueFormat() - Constructor for class freemarker.core.TemplateValueFormat
 
TemplateValueFormatException - Exception in freemarker.core
Error while getting, creating or applying TemplateValueFormat-s (including its subclasses, like TemplateNumberFormat).
TemplateValueFormatException(String, Throwable) - Constructor for exception freemarker.core.TemplateValueFormatException
 
TemplateValueFormatException(String) - Constructor for exception freemarker.core.TemplateValueFormatException
 
TemplateValueFormatFactory - Class in freemarker.core
Superclass of all format factories.
TemplateValueFormatFactory() - Constructor for class freemarker.core.TemplateValueFormatFactory
 
TemplateXHTMLOutputModel - Class in freemarker.core
Stores HTML markup to be printed; used with HTMLOutputFormat.
TemplateXMLOutputModel - Class in freemarker.core
Stores XML markup to be printed; used with XMLOutputFormat.
TIME - Static variable in interface freemarker.template.TemplateDateModel
The date model represents a time value (no date part).
TIME_FORMAT_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
TIME_FORMAT_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
TIME_FORMAT_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
TIME_ZONE_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
TIME_ZONE_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
TIME_ZONE_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
ToCanonical - Class in freemarker.template.utility
Deprecated.
Will be removed (main method in a library, often classified as CWE-489 "Leftover Debug Code").
ToCanonical() - Constructor for class freemarker.template.utility.ToCanonical
Deprecated.
 
toFullTemplateName(String, String) - Method in class freemarker.core.Environment
Resolves a reference to a template (like the one used in #include or #import), assuming a base name.
toIntExact(Number) - Static method in class freemarker.template.utility.NumberUtil
Converts a Number to int whose mathematical value is exactly the same as of the original number.
tokenImage - Variable in exception freemarker.core.ParseException
This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.
toList() - Method in class freemarker.template.SimpleSequence
Deprecated.
No replacement exists; not a reliable way of getting back the original list elemnts.
toLowerABC(int) - Static method in class freemarker.template.utility.StringUtil
Same as StringUtil.toUpperABC(int), but produces lower case result, like "ab".
toMap() - Method in class freemarker.template.SimpleHash
Note that this method creates and returns a deep-copy of the underlying hash used internally.
toNumber(String) - Method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
toNumber(String) - Method in class freemarker.core.ArithmeticEngine.ConservativeEngine
 
toNumber(String) - Method in class freemarker.core.ArithmeticEngine
Should be able to parse all FTL numerical literals, Java Double toString results, and XML Schema numbers.
toPropertiesString() - Method in class freemarker.ext.beans.BeansWrapper
Returns the name-value pairs that describe the configuration of this BeansWrapper; called from BeansWrapper.toString().
toPropertiesString() - Method in class freemarker.template.DefaultObjectWrapper
 
toString() - Method in class freemarker.cache.ByteArrayTemplateLoader
Show class name and some details that are useful in template-not-found errors.
toString() - Method in class freemarker.cache.ClassTemplateLoader
Show class name and some details that are useful in template-not-found errors.
toString() - Method in class freemarker.cache.FileTemplateLoader
Show class name and some details that are useful in template-not-found errors.
toString() - Method in class freemarker.cache.MultiTemplateLoader
Show class name and some details that are useful in template-not-found errors.
toString() - Method in class freemarker.cache.StringTemplateLoader
Show class name and some details that are useful in template-not-found errors.
toString() - Method in class freemarker.cache.WebappTemplateLoader
Show class name and some details that are useful in template-not-found errors.
toString() - Method in class freemarker.core.OutputFormat
Returns the short description of this format, to be used in error messages.
toString() - Method in class freemarker.ext.beans.BeanModel
 
toString() - Method in class freemarker.ext.beans.BeansWrapper
Returns the exact class name and the identity hash, also the values of the most often used BeansWrapper configuration properties, also if which (if any) shared class introspection cache it uses.
toString() - Method in class freemarker.ext.beans.SimpleMethodModel
 
toString() - Method in class freemarker.template.SimpleDate
 
toString() - Method in class freemarker.template.SimpleHash
Returns the toString() of the underlying Map.
toString() - Method in class freemarker.template.SimpleNumber
 
toString() - Method in class freemarker.template.SimpleScalar
 
toString() - Method in class freemarker.template.SimpleSequence
 
toString() - Method in class freemarker.template.Template
Returns a string representing the raw template text in canonical form.
toString() - Method in class freemarker.template.Version
Contains the major.minor.micor numbers and the extraInfo part, not the other information.
toStringExtraProperties() - Method in class freemarker.core.OutputFormat
Should be like "foo=\"something\", bar=123"; this will be inserted inside the parentheses in OutputFormat.toString().
toUpperABC(int) - Static method in class freemarker.template.utility.StringUtil
Converts 1, 2, 3 and so forth to "A", "B", "C" and so fort.
transcode(String) - Method in class freemarker.ext.servlet.HttpRequestParametersHashModel
 
Transform - Class in freemarker.ext.dom
Deprecated.
Will be removed (main method in a library, often classified as CWE-489 "Leftover Debug Code").
transform(Reader, Writer) - Method in class freemarker.template.utility.NormalizeNewlines
Performs newline normalization on FreeMarker output.
TransformControl - Interface in freemarker.template
An interface that can be implemented by writers returned from TemplateTransformModel.getWriter(java.io.Writer, java.util.Map).
trim(char[]) - Static method in class freemarker.template.utility.StringUtil
Behaves exactly like String.trim(), but works on arrays.
TrivialCalendarFieldsToDateConverter() - Constructor for class freemarker.template.utility.DateUtil.TrivialCalendarFieldsToDateConverter
 
TrivialDateToISO8601CalendarFactory() - Constructor for class freemarker.template.utility.DateUtil.TrivialDateToISO8601CalendarFactory
 
TRUE - Static variable in interface freemarker.template.TemplateBooleanModel
A singleton object to represent boolean true
TRUE - Static variable in class freemarker.template.utility.Constants
 
tryToString(Object) - Static method in class freemarker.template.utility.StringUtil
Tries to run toString(), but if that fails, returns a "[com.example.SomeClass.toString() failed: " + e + "]" instead.
tryUnwrapTo(TemplateModel, Class<?>) - Method in class freemarker.ext.beans.BeansWrapper
 
tryUnwrapTo(TemplateModel, Class<?>) - Method in interface freemarker.template.ObjectWrapperAndUnwrapper
Attempts to unwrap a TemplateModel to a plain Java object that's the instance of the given class (or is null).
TYPE_BOOLEAN - Static variable in interface freemarker.debug.DebugModel
 
TYPE_COLLECTION - Static variable in interface freemarker.debug.DebugModel
 
TYPE_CONFIGURATION - Static variable in interface freemarker.debug.DebugModel
 
TYPE_DATE - Static variable in interface freemarker.debug.DebugModel
 
TYPE_ENVIRONMENT - Static variable in interface freemarker.debug.DebugModel
 
TYPE_HASH - Static variable in interface freemarker.debug.DebugModel
 
TYPE_HASH_EX - Static variable in interface freemarker.debug.DebugModel
 
TYPE_METHOD - Static variable in interface freemarker.debug.DebugModel
 
TYPE_METHOD_EX - Static variable in interface freemarker.debug.DebugModel
 
TYPE_NAMES - Static variable in interface freemarker.template.TemplateDateModel
 
TYPE_NUMBER - Static variable in interface freemarker.debug.DebugModel
 
TYPE_SCALAR - Static variable in interface freemarker.debug.DebugModel
 
TYPE_SEQUENCE - Static variable in interface freemarker.debug.DebugModel
 
TYPE_TEMPLATE - Static variable in interface freemarker.debug.DebugModel
 
TYPE_TRANSFORM - Static variable in interface freemarker.debug.DebugModel
 

U

UndeclaredThrowableException - Exception in freemarker.template.utility
The equivalent of JDK 1.3 UndeclaredThrowableException.
UndeclaredThrowableException(Throwable) - Constructor for exception freemarker.template.utility.UndeclaredThrowableException
 
UndeclaredThrowableException(String, Throwable) - Constructor for exception freemarker.template.utility.UndeclaredThrowableException
 
UndefinedCustomFormatException - Exception in freemarker.core
 
UndefinedCustomFormatException(String, Throwable) - Constructor for exception freemarker.core.UndefinedCustomFormatException
 
UndefinedCustomFormatException(String) - Constructor for exception freemarker.core.UndefinedCustomFormatException
 
UndefinedOutputFormat - Class in freemarker.core
Represents the output format used when the template output format is undecided.
UnexpectedTypeException - Exception in freemarker.core
The type of a value differs from what was expected.
UnexpectedTypeException(Environment, String) - Constructor for exception freemarker.core.UnexpectedTypeException
 
UnformattableValueException - Exception in freemarker.core
Thrown when a TemplateModel can't be formatted because of the value/properties of it are outside of that the TemplateValueFormat supports.
UnformattableValueException(String, Throwable) - Constructor for exception freemarker.core.UnformattableValueException
 
UnformattableValueException(String) - Constructor for exception freemarker.core.UnformattableValueException
 
UNKNOWN - Static variable in interface freemarker.template.TemplateDateModel
It is not known whether the date represents a date, a time, or a date-time value.
UnknownDateTypeFormattingUnsupportedException - Exception in freemarker.core
Thrown when a TemplateDateModel can't be formatted because its type is TemplateDateModel.UNKNOWN.
UnknownDateTypeFormattingUnsupportedException() - Constructor for exception freemarker.core.UnknownDateTypeFormattingUnsupportedException
 
UnknownDateTypeParsingUnsupportedException - Exception in freemarker.core
Thrown when a string can't be parsed to TemplateDateModel, because the provided target type is TemplateDateModel.UNKNOWN.
UnknownDateTypeParsingUnsupportedException() - Constructor for exception freemarker.core.UnknownDateTypeParsingUnsupportedException
 
unknownSettingException(String) - Method in class freemarker.core.Configurable
Creates the exception that should be thrown when a setting name isn't recognized.
UnlinkedJythonOperationsImpl - Class in freemarker.ext.ant
Used internally, public for technical reasons only.
UnlinkedJythonOperationsImpl() - Constructor for class freemarker.ext.ant.UnlinkedJythonOperationsImpl
 
UnparsableValueException - Exception in freemarker.core
Thrown when the content of the string that should be parsed by the TemplateValueFormat doesn't match what the format expects.
UnparsableValueException(String, Throwable) - Constructor for exception freemarker.core.UnparsableValueException
 
UnparsableValueException(String) - Constructor for exception freemarker.core.UnparsableValueException
 
UnrecognizedTimeZoneException - Exception in freemarker.template.utility
Indicates that the time zone name is not recognized.
UnrecognizedTimeZoneException(String) - Constructor for exception freemarker.template.utility.UnrecognizedTimeZoneException
 
UnregisteredOutputFormatException - Exception in freemarker.core
 
UnregisteredOutputFormatException(String) - Constructor for exception freemarker.core.UnregisteredOutputFormatException
 
UnregisteredOutputFormatException(String, Throwable) - Constructor for exception freemarker.core.UnregisteredOutputFormatException
 
UNRESTRICTED_RESOLVER - Static variable in interface freemarker.core.TemplateClassResolver
unsetCacheStorage() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetDefaultEncoding() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetLocale() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetLogTemplateExceptions() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetObjectWrapper() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetOutputFormat() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetRecognizeStandardFileExtensions() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetTemplateExceptionHandler() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetTemplateLoader() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetTemplateLookupStrategy() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetTemplateNameFormat() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
unsetTimeZone() - Method in class freemarker.template.Configuration
Resets the setting to its default, as if it was never set.
UnsupportedNumberClassException - Exception in freemarker.template.utility
Thrown when FreeMarker runs into a Number subclass that it doesn't yet support.
UnsupportedNumberClassException(Class) - Constructor for exception freemarker.template.utility.UnsupportedNumberClassException
 
unwrap(TemplateModel) - Method in class freemarker.ext.beans.BeanModel
 
unwrap(TemplateModel) - Method in class freemarker.ext.beans.BeansWrapper
Attempts to unwrap a model into underlying object.
unwrap(TemplateModel, Class<?>) - Method in class freemarker.ext.beans.BeansWrapper
Attempts to unwrap a model into an object of the desired class.
unwrap(TemplateModel) - Method in class freemarker.ext.jython.JythonWrapper
Coerces a template model into a PyObject.
unwrap(TemplateModel) - Method in interface freemarker.template.ObjectWrapperAndUnwrapper
Unwraps a TemplateModel to a plain Java object.
unwrap(TemplateModel) - Static method in class freemarker.template.utility.DeepUnwrap
Unwraps TemplateModel-s recursively.
URL_ESCAPING_CHARSET_KEY - Static variable in class freemarker.core.Configurable
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
URL_ESCAPING_CHARSET_KEY_CAMEL_CASE - Static variable in class freemarker.core.Configurable
Modern, camel case (likeThis) variation of the setting name.
URL_ESCAPING_CHARSET_KEY_SNAKE_CASE - Static variable in class freemarker.core.Configurable
Legacy, snake case (like_this) variation of the setting name.
URLEnc(String, String) - Static method in class freemarker.template.utility.StringUtil
URL encoding (like%20this) for query parameter values, path segments, fragments; this encodes all characters that are reserved anywhere.
URLPathEnc(String, String) - Static method in class freemarker.template.utility.StringUtil
Like StringUtil.URLEnc(String, String) but doesn't escape the slash character (/).
URLTemplateLoader - Class in freemarker.cache
This is an abstract template loader that can load templates whose location can be described by an URL.
URLTemplateLoader() - Constructor for class freemarker.cache.URLTemplateLoader
 
useDefaultXPathSupport() - Static method in class freemarker.ext.dom.NodeModel
Tells the system to use (restore) the default (initial) XPath system used by this FreeMarker version on this system.
useJaxenXPathSupport() - Static method in class freemarker.ext.dom.NodeModel
Convenience method.
useSunInternalXPathSupport() - Static method in class freemarker.ext.dom.NodeModel
 
useXalanXPathSupport() - Static method in class freemarker.ext.dom.NodeModel
Convenience method.
UTC - Static variable in class freemarker.template.utility.DateUtil
 

V

values() - Method in class freemarker.ext.beans.BeanModel
 
values() - Method in class freemarker.ext.beans.SimpleMapModel
 
values() - Method in class freemarker.ext.jython.JythonHashModel
Returns object.__findattr__("values").__call__().
values() - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
values() - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
values() - Method in class freemarker.ext.servlet.HttpRequestParametersHashModel
 
values() - Method in class freemarker.ext.util.IdentityHashMap
Deprecated.
Returns a collection view of the values contained in this map.
values() - Method in class freemarker.template.DefaultMapAdapter
 
values() - Method in class freemarker.template.SimpleHash
 
values() - Method in interface freemarker.template.TemplateHashModelEx
 
Version - Class in freemarker.template
Represents a version number plus the further qualifiers and build info.
Version(String) - Constructor for class freemarker.template.Version
 
Version(String, Boolean, Date) - Constructor for class freemarker.template.Version
 
Version(int, int, int) - Constructor for class freemarker.template.Version
 
Version(int) - Constructor for class freemarker.template.Version
Creates an object based on the int value that uses the same kind of encoding as Version.intValue().
Version(int, int, int, String, Boolean, Date) - Constructor for class freemarker.template.Version
 
VERSION_2_3_0 - Static variable in class freemarker.template.Configuration
FreeMarker version 2.3.0 (an incompatible improvements break-point)
VERSION_2_3_19 - Static variable in class freemarker.template.Configuration
FreeMarker version 2.3.19 (an incompatible improvements break-point)
VERSION_2_3_20 - Static variable in class freemarker.template.Configuration
FreeMarker version 2.3.20 (an incompatible improvements break-point)
VERSION_2_3_21 - Static variable in class freemarker.template.Configuration
FreeMarker version 2.3.21 (an incompatible improvements break-point)
VERSION_2_3_22 - Static variable in class freemarker.template.Configuration
FreeMarker version 2.3.22 (an incompatible improvements break-point)
VERSION_2_3_23 - Static variable in class freemarker.template.Configuration
FreeMarker version 2.3.23 (an incompatible improvements break-point)
VERSION_2_3_24 - Static variable in class freemarker.template.Configuration
FreeMarker version 2.3.24 (an incompatible improvements break-point)
VERSION_2_3_25 - Static variable in class freemarker.template.Configuration
FreeMarker version 2.3.25 (an incompatible improvements break-point)
VERSION_2_3_26 - Static variable in class freemarker.template.Configuration
FreeMarker version 2.3.26 (an incompatible improvements break-point)
versionStringToInt(String) - Static method in class freemarker.template.utility.StringUtil
Converts a version number string to an integer for easy comparison.
visit(TemplateElement, TemplateDirectiveModel, Map, List) - Method in class freemarker.core.Environment
Deprecated.
Should be internal API

W

warn(String) - Method in class freemarker.log.Logger
Logs a warning message.
warn(String, Throwable) - Method in class freemarker.log.Logger
Logs a warning message with accompanying throwable.
WebappTemplateLoader - Class in freemarker.cache
A TemplateLoader that uses streams reachable through ServletContext.getResource(String) as its source of templates.
WebappTemplateLoader(ServletContext) - Constructor for class freemarker.cache.WebappTemplateLoader
Creates a template loader that will use the specified servlet context to load the resources.
WebappTemplateLoader(ServletContext, String) - Constructor for class freemarker.cache.WebappTemplateLoader
Creates a template loader that will use the specified servlet context to load the resources.
WHITESPACE_STRIPPING_KEY - Static variable in class freemarker.template.Configuration
Alias to the ..._SNAKE_CASE variation due to backward compatibility constraints.
WHITESPACE_STRIPPING_KEY_CAMEL_CASE - Static variable in class freemarker.template.Configuration
Modern, camel case (likeThis) variation of the setting name.
WHITESPACE_STRIPPING_KEY_SNAKE_CASE - Static variable in class freemarker.template.Configuration
Legacy, snake case (like_this) variation of the setting name.
wrap(Object) - Method in class freemarker.ext.beans.BeanModel
 
wrap(Object) - Method in class freemarker.ext.beans.BeansWrapper
Wraps the object with a template model that is most specific for the object's class.
wrap(Object, Method) - Method in class freemarker.ext.beans.BeansWrapper
Wraps a Java method so that it can be called from templates, without wrapping its parent ("this") object.
wrap(Node) - Static method in class freemarker.ext.dom.NodeModel
 
wrap(Object) - Method in class freemarker.ext.jython.JythonWrapper
Wraps the passed Jython object into a FreeMarker template model.
wrap(Object) - Method in class freemarker.ext.rhino.RhinoWrapper
 
wrap(Object) - Method in class freemarker.template.DefaultObjectWrapper
Wraps the parameter object to TemplateModel interface(s).
wrap(Object) - Method in interface freemarker.template.ObjectWrapper
Makes a TemplateModel out of a non-TemplateModel object, usually by "wrapping" it into a TemplateModel implementation that delegates to the original object.
wrap(Object) - Method in class freemarker.template.WrappingTemplateModel
Wraps the passed object into a template model using this object's object wrapper.
wrapAsAPI(Object) - Method in class freemarker.ext.beans.BeansWrapper
 
wrapAsAPI(Object) - Method in class freemarker.template.SimpleObjectWrapper
 
wrapAsAPI(Object) - Method in interface freemarker.template.utility.ObjectWrapperWithAPISupport
Wraps an object to a TemplateModel that exposes the object's "native" (usually, Java) API.
wrapDomNode(Object) - Method in class freemarker.template.DefaultObjectWrapper
 
wrapper - Variable in class freemarker.ext.beans.BeanModel
 
wrapper - Variable in class freemarker.ext.jython.JythonModel
 
WrapperTemplateModel - Interface in freemarker.ext.util
A generic interface for template models that wrap some underlying object, and wish to provide access to that wrapped object.
WrappingTemplateModel - Class in freemarker.template
Convenience base-class for containers that wrap their contained arbitrary Java objects into TemplateModel instances.
WrappingTemplateModel() - Constructor for class freemarker.template.WrappingTemplateModel
Deprecated.
Use WrappingTemplateModel.WrappingTemplateModel(ObjectWrapper) instead; this method uses the deprecated.
WrappingTemplateModel(ObjectWrapper) - Constructor for class freemarker.template.WrappingTemplateModel
Protected constructor that creates a new wrapping template model using the specified object wrapper.
write(char[], int, int) - Method in class freemarker.template.utility.NullWriter
 
write(int) - Method in class freemarker.template.utility.NullWriter
 
write(char[]) - Method in class freemarker.template.utility.NullWriter
 
write(String) - Method in class freemarker.template.utility.NullWriter
 
write(String, int, int) - Method in class freemarker.template.utility.NullWriter
 
writeProtect() - Method in class freemarker.ext.beans.BeansWrapper
Makes the configuration properties (settings) of this BeansWrapper object read-only.
writeProtect() - Method in interface freemarker.template.utility.WriteProtectable
Makes this object permanently read-only.
WriteProtectable - Interface in freemarker.template.utility
Implemented by objects that can be made permanently read-only.
WrongEncodingException(String) - Constructor for exception freemarker.template.Template.WrongEncodingException
Deprecated.
Use #WrongEncodingException(String, String).
WrongEncodingException(String, String) - Constructor for exception freemarker.template.Template.WrongEncodingException
 

X

XHTMLEnc(String) - Static method in class freemarker.template.utility.StringUtil
XHTML Encoding.
XHTMLEnc(String, Writer) - Static method in class freemarker.template.utility.StringUtil
Like StringUtil.XHTMLEnc(String), but writes the result into a Writer.
XHTMLOutputFormat - Class in freemarker.core
Represents the XML output format (MIME type "application/xhtml+xml", name "XHTML").
XMLEnc(String) - Static method in class freemarker.template.utility.StringUtil
XML Encoding.
XMLEnc(String, Writer) - Static method in class freemarker.template.utility.StringUtil
Like StringUtil.XMLEnc(String), but writes the result into a Writer.
XMLEncNA(String) - Static method in class freemarker.template.utility.StringUtil
XML encoding without replacing apostrophes.
XMLEncNQG(String) - Static method in class freemarker.template.utility.StringUtil
XML encoding without replacing apostrophes and quotation marks and greater-thans (except in ]]>).
XMLEncQAttr(String) - Static method in class freemarker.template.utility.StringUtil
XML encoding for attribute values quoted with " (not with '!).
XmlEscape - Class in freemarker.template.utility
Performs an XML escaping of a given template fragment.
XmlEscape() - Constructor for class freemarker.template.utility.XmlEscape
 
XMLOutputFormat - Class in freemarker.core
Represents the XML output format (MIME type "application/xml", name "XML").
XPathSupport - Interface in freemarker.ext.dom
 

Z

ZERO - Static variable in class freemarker.template.utility.Constants
 

_

__getitem__(String) - Method in class freemarker.core.Environment
A hook that Jython uses.
__setitem__(String, Object) - Method in class freemarker.core.Environment
A hook that Jython uses.
A B C D E F G H I J K L M N O P R S T U V W X Z _ 
Skip navigation links