A B C D E F G H I J K L M N O P R S T U V W _ 
All Classes All Packages

A

AbstractScope - Class in freemarker.core
An abstract scope with no variable storage mechanism of its own; only provides enclosing scope and operations related to enclosing scope.
AbstractScope(Scope) - Constructor for class freemarker.core.AbstractScope
 
AdapterTemplateModel - Interface in freemarker.template
Supplemental interface that can be implemented by classes that also implement any of the TemplateModel interfaces.
add(boolean) - Method in class freemarker.template.SimpleSequence
Adds a boolean to the end of this SimpleSequence, by coercing the boolean into TemplateBooleanModel.TRUE or TemplateBooleanModel.FALSE.
add(Object) - Method in class freemarker.template.SimpleSequence
Adds an arbitrary object to the end of this SimpleSequence.
addAutoImport(String, String) - Method in class freemarker.template.Configuration
Add an auto-imported template.
addAutoInclude(String) - Method in class freemarker.template.Configuration
add a template to be automatically included at the top of any template that is vended by this Configuration object.
addAutoTemplateVisitors(ASTVisitor...) - Method in class freemarker.template.Configuration
 
addBreakpoint(Breakpoint) - Method in interface freemarker.debug.Debugger
Adds a breakpoint
addDebuggerListener(DebuggerListener) - Method in interface freemarker.debug.Debugger
Adds a listener for debugger events.
addImport(LibraryLoad) - Method in class freemarker.template.Template
Called by code internally to maintain a list of imports
addMacro(Macro) - Method in class freemarker.core.TemplateCore
Called by code internally to maintain a table of macros
addParsingProblem(ParsingProblem) - Method in class freemarker.template.Template
 
addPrefixNSMapping(String, String) - Method in class freemarker.template.Template
This is used internally.
afterBody() - Method in interface freemarker.template.TransformControl
Called after the body has been evaluated.
ANGLE_BRACKET_TAG_SYNTAX - Static variable in class freemarker.template.Configuration
 
ARITHMETIC_ENGINE_KEY - Static variable in class freemarker.core.Configurable
 
AUTO_DETECT_TAG_SYNTAX - Static variable in class freemarker.template.Configuration
 
AUTO_IMPORT_KEY - Static variable in class freemarker.template.Configuration
 
AUTO_INCLUDE_KEY - Static variable in class freemarker.template.Configuration
 

B

baseDir - Variable in class freemarker.cache.FileTemplateLoader
The base directory used as the root of the namespace for resolving template paths.
BaseScope - Class in freemarker.core
A basic scope that stores variables locally in a hash map.
BEANS_WRAPPER - Static variable in interface freemarker.template.ObjectWrapper
An ObjectWrapper that works similarly to ObjectWrapper.SIMPLE_WRAPPER, but exposes the objects methods and JavaBeans properties as hash elements and custom handling for Java Maps, ResourceBundles, etc.
BlockScope - Class in freemarker.core
 
BlockScope(TemplateElement, Scope) - Constructor for class freemarker.core.BlockScope
 
bodyParameters - Variable in class freemarker.core.MacroContext
 
BOOLEAN_FORMAT_KEY - Static variable in class freemarker.core.Configurable
 
BreakException - Exception in freemarker.core
An exception used to break out of a loop
BreakException() - Constructor for exception freemarker.core.BreakException
 
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.

C

CACHE_STORAGE_KEY - Static variable in class freemarker.template.Configuration
 
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.
canonicalizePrefix(String) - Static method in class freemarker.cache.URLTemplateLoader
Can be used by subclasses to canonicalize URL path prefixes.
checkModifyTemplate() - Static method in class freemarker.core.TemplateCore
 
checkPermission(Configuration, Permission) - Static method in class freemarker.core.FreeMarkerPermission
Checks a permission if there is a SecurityManager installed in the JVM and the Configuration's isSecure() returns true.
checkPermission(Permission) - Static method in class freemarker.core.FreeMarkerPermission
Checks a permission if there is a SecurityManager installed in the JVM.
ClassTemplateLoader - Class in freemarker.cache
A TemplateLoader that uses streams reachable through Class.getResourceAsStream(String) as its source of templates.
ClassTemplateLoader() - Constructor for class freemarker.cache.ClassTemplateLoader
Deprecated.
confusing constructor, and seldom useful; use ClassTemplateLoader(Class, String) instead.
ClassTemplateLoader(Class) - Constructor for class freemarker.cache.ClassTemplateLoader
Deprecated.
it is confusing that the base path is ""; use ClassTemplateLoader(Class, String) instead.
ClassTemplateLoader(Class, String) - Constructor for class freemarker.cache.ClassTemplateLoader
Equivalent to invoking ClassTemplateLoader(Class, String, boolean) with false as the last argument.
ClassTemplateLoader(Class, String, boolean) - 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 path (absolute or relative).
clear() - Method in interface freemarker.cache.CacheStorage
Removes all values from this cache
clear() - Method in class freemarker.cache.MruCacheStorage
 
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.core.BaseScope
 
clearEncodingMap() - Method in class freemarker.template.Configuration
Clears language-to-encoding map.
clearSharedVariables() - Method in class freemarker.template.Configuration
Removes all shared variables, 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() - Method in class freemarker.template.Configuration
 
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.
closeTemplateSource(Object) - Method in class freemarker.cache.URLTemplateLoader
 
closeTemplateSource(Object) - Method in class freemarker.cache.WebappTemplateLoader
 
CommandLine - Class in freemarker.core
FreeMarker command-line utility, the Main-Class of freemarker.jar.
CommandLine() - Constructor for class freemarker.core.CommandLine
 
compare(Reader, Reader, File, File) - Static method in class freemarker.testcase.TemplateTestCase
 
compareTo(Object) - Method in class freemarker.debug.Breakpoint
 
ConcurrentCacheStorage - Interface in freemarker.cache
An optional interface for cache storage that knows whether it can be concurrently accessible without synchronization.
Configurable - Class in freemarker.core
This is a common superclass of Configuration, Template, and Environment classes.
Configurable() - Constructor for class freemarker.core.Configurable
 
Configurable(Configurable) - Constructor for class freemarker.core.Configurable
Creates a new instance.
Configurable.UnknownSettingException - Exception in freemarker.core
 
Configuration - Class in freemarker.template
Main entry point into the FreeMarker API, this class encapsulates the various configuration parameters with which FreeMarker is run, as well as serves as a central template loading and caching point.
Configuration() - Constructor for class freemarker.template.Configuration
 
containingElements(int, int) - Method in class freemarker.template.Template
 
convertArray(Object) - Method in class freemarker.template.DefaultObjectWrapper
Converts an array to a java.util.List
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.
createProcessingEnvironment(Object, Writer) - Method in class freemarker.template.Template
Same as createProcessingEnvironment(rootMap, out, null).
createProcessingEnvironment(Object, Writer, ObjectWrapper) - Method in class freemarker.template.Template
Creates a Environment object, using this template, the data model provided as the root map object, and the supplied object wrapper to convert map elements to template models.
createTemplate(String, Reader, Configuration, String, CodeSource) - Method in class freemarker.cache.TemplateCache
 
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-only value.
DATE_FORMAT_KEY - Static variable in class freemarker.core.Configurable
 
DATETIME - Static variable in interface freemarker.template.TemplateDateModel
The date model represents a datetime value.
DATETIME_FORMAT_KEY - Static variable in class freemarker.core.Configurable
 
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
This is a TemplateExceptionHandler used when you develop the 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.
declaresVariable(String) - Method in class freemarker.template.Template
 
declareVariable(String) - Method in class freemarker.template.Template
 
DEFAULT_ENCODING_KEY - Static variable in class freemarker.template.Configuration
 
DEFAULT_NAMESPACE_PREFIX - Static variable in class freemarker.template.Template
 
DEFAULT_PORT - Static variable in interface freemarker.debug.Debugger
 
DEFAULT_WRAPPER - Static variable in interface freemarker.template.ObjectWrapper
The default object wrapper implementation.
DefaultObjectWrapper - Class in freemarker.template
The default implementation of the ObjectWrapper interface.
DefaultObjectWrapper() - Constructor for class freemarker.template.DefaultObjectWrapper
 
definesVariable(String) - Method in class freemarker.core.BaseScope
 
definesVariable(String) - Method in class freemarker.core.BlockScope
 
definesVariable(String) - Method in class freemarker.core.Environment
 
definesVariable(String) - Method in class freemarker.core.MacroInvocationBodyContext
 
definesVariable(String) - Method in interface freemarker.core.Scope
 
definesVariable(String) - Method in class freemarker.core.TemplateNamespace
 
definesVariable(String) - Method in class freemarker.template.Configuration
 
doAutoImportsAndIncludes(Environment) - Method in class freemarker.core.Configurable
 
doAutoImportsAndIncludes(Environment) - Method in class freemarker.template.Configuration
 
dump(PrintStream) - Method in class freemarker.core.TemplateCore
Dump the raw template in canonical form.
dump(Writer) - Method in class freemarker.core.TemplateCore
Dump the raw template in canonical form.

E

EMPTY_STRING - Static variable in interface freemarker.template.TemplateScalarModel
A constant value to use as the empty string.
enableJRuby() - Method in class freemarker.template.Configuration
We're keeping this functionality for now, but if there is no sign anybody is interested in using this, it will likely be removed.
enableJython() - Method in class freemarker.template.Configuration
We're keeping this functionality for now, but if there is no sign anybody is interested in using this, it will likely be removed.
enableRhino() - Method in class freemarker.template.Configuration
We're keeping this functionality for now, but if there is no sign anybody is interested in using this, it will likely be removed.
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.
Environment - Class in freemarker.core
Object that represents the runtime environment during template processing.
Environment(Template, TemplateHashModel, Writer) - Constructor for class freemarker.core.Environment
 
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, int, DebuggedEnvironment) - Constructor for class freemarker.debug.EnvironmentSuspendedEvent
 
equals(Object) - Method in class freemarker.debug.Breakpoint
 
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.
EVALUATE_BODY - Static variable in interface freemarker.template.TransformControl
Constant returned from TransformControl.onStart() that tells the template engine to evaluate the body.
exec(List) - Method in interface freemarker.template.TemplateMethodModel
Executes a method call.
exec(List) - Method in interface freemarker.template.TemplateMethodModelEx
Executes a method call.
execute(Environment, Map<String, TemplateModel>, 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.

F

fallback() - Method in class freemarker.core.Environment
 
FALSE - Static variable in interface freemarker.template.TemplateBooleanModel
A singleton object to represent boolean false
FileTemplateLoader - Class in freemarker.cache
A TemplateLoader that uses files in a specified directory as the source of templates.
FileTemplateLoader() - Constructor for class freemarker.cache.FileTemplateLoader
Creates a new file template cache that will use the current directory (the value of the system property user.dir as the base directory for loading templates.
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 and a specified code source policy.
FileTemplateLoader(File, boolean, 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 and a specified code source policy.
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 object that acts as the source of the template with the given name.
findTemplateSource(String) - Method in class freemarker.cache.URLTemplateLoader
 
findTemplateSource(String) - Method in class freemarker.cache.WebappTemplateLoader
 
firstLine(TemplateNode) - Method in class freemarker.template.PostParseVisitor
 
formatDate(Date, int) - Method in class freemarker.core.Environment
 
formatNumber(Number) - Method in class freemarker.core.Environment
 
freemarker.cache - package freemarker.cache
Contains classes and interfaces that deal with template loading and caching.
freemarker.core - package freemarker.core
This package contains FreeMarker's core parsing/rendering functionality; most casual users do not need to be aware of the classes in this package, and can restrict their attention to the freemarker.template package.
freemarker.debug - package freemarker.debug
 
freemarker.log - package freemarker.log
Provides the FreeMarker logging facility.
freemarker.template - package freemarker.template
This package contains the core API's that most users will use.
freemarker.testcase - package freemarker.testcase
Test cases for various aspects of the FreeMarker implementation.
FreeMarkerPermission - Class in freemarker.core
A class representing all FreeMarker-related permissions.
FreeMarkerPermission(String) - Constructor for class freemarker.core.FreeMarkerPermission
 

G

get() - Method in class freemarker.core.CustomAttribute
 
get(int) - Method in interface freemarker.debug.DebugModel
 
get(int) - Method in class freemarker.template.SimpleSequence
 
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(int, int) - Method in interface freemarker.debug.DebugModel
 
get(Template) - Method in class freemarker.core.CustomAttribute
 
get(Object) - Method in interface freemarker.cache.CacheStorage
Retrieve a cached value associated with a key
get(Object) - Method in class freemarker.cache.MruCacheStorage
 
get(Object) - Method in class freemarker.cache.SoftCacheStorage
 
get(Object) - Method in class freemarker.cache.StrongCacheStorage
 
get(String) - Method in class freemarker.core.BaseScope
 
get(String) - Method in class freemarker.core.Environment
This method returns a variable from the "global" namespace and falls back to the data model.
get(String) - Method in interface freemarker.debug.DebugModel
 
get(String) - Method in class freemarker.template.Configuration
 
get(String) - Method in class freemarker.template.SimpleHash
 
get(String) - Method in interface freemarker.template.TemplateHashModel
Gets a TemplateModel from the hash.
get(String[]) - Method in interface freemarker.debug.DebugModel
 
getAbsoluteOffset(int, int) - Method in class freemarker.template.Template
 
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.
getArithmeticEngine() - Method in class freemarker.core.Configurable
Retrieves the arithmetic engine used to perform arithmetic operations.
getAsBoolean() - Method in interface freemarker.debug.DebugModel
 
getAsBoolean() - Method in interface freemarker.template.TemplateBooleanModel
 
getAsDate() - Method in interface freemarker.debug.DebugModel
 
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.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.template.LocalizedString
 
getAsString() - Method in class freemarker.template.SimpleScalar
 
getAsString() - Method in interface freemarker.template.TemplateScalarModel
Returns the string representation of this model.
getBlock() - Method in class freemarker.core.BlockScope
 
getBooleanFormat() - Method in class freemarker.core.Configurable
 
getBooleanFormat(boolean) - 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.
getCacheStorage() - Method in class freemarker.cache.TemplateCache
Returns the cache storage used by this cache.
getCauseException() - Method in exception freemarker.template.TemplateException
Returns the underlying exception that caused this exception to be generated.
getChildNodes() - Method in interface freemarker.template.TemplateNodeModel
 
getCNumberFormat() - Method in class freemarker.core.Environment
Returns the NumberFormat used for the c built-in.
getCodeSource() - Method in class freemarker.template.Template
 
getCodeSource(Object) - Method in class freemarker.cache.ClassTemplateLoader
 
getCodeSource(Object) - Method in class freemarker.cache.FileTemplateLoader
 
getCodeSource(Object) - Method in class freemarker.cache.MultiTemplateLoader
 
getCodeSource(Object) - Method in interface freemarker.cache.SecureTemplateLoader
Returns a code source for a template source.
getCodeSource(Object) - Method in class freemarker.cache.URLTemplateLoader
For jar: URLs, returns a code source that points to the URL of the JAR file as the code source URL.
getCodeSource(Object) - Method in class freemarker.cache.WebappTemplateLoader
 
getCollator() - Method in class freemarker.core.Environment
 
getCollection() - Method in interface freemarker.debug.DebugModel
 
getConfiguration() - Method in class freemarker.core.Environment
 
getConfiguration() - Method in class freemarker.template.Template
Returns the Configuration object associated with this template.
getCurrentConfiguration() - Static method in class freemarker.template.Configuration
 
getCurrentEnvironment() - Static method in class freemarker.core.Environment
Retrieves the environment object associated with the current thread.
getCurrentMacroContext() - Method in class freemarker.core.Environment
 
getCurrentNamespace() - Method in class freemarker.core.Environment
Returns the current name-space.
getCurrentObjectWrapper() - Static method in class freemarker.template.Configuration
 
getCurrentRecoveredErrorMessage() - Method in class freemarker.core.Environment
 
getCurrentScope() - Method in class freemarker.core.Environment
 
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.
getDataModel() - Method in class freemarker.core.Environment
Returns the data model hash.
getDateFormat() - Method in class freemarker.core.Configurable
Returns the date format used to convert date models representing date-only dates to strings.
getDateFormatObject(int) - Method in class freemarker.core.Environment
 
getDateFormatObject(int, String) - Method in class freemarker.core.Environment
 
getDateTimeFormat() - Method in class freemarker.core.Configurable
Returns the date format used to convert date models representing datetime dates to strings.
getDateType() - Method in interface freemarker.debug.DebugModel
 
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.
getDeclaredVariables() - Method in class freemarker.template.Template
 
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.
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.
getDefaultNS() - Method in class freemarker.core.Environment
 
getDefaultNS() - Method in class freemarker.template.Template
 
getDefaultObjectWrapper() - Static method in class freemarker.template.WrappingTemplateModel
Returns the default object wrapper that is used when a wrapping template model is constructed without being passed an explicit object wrapper.
getDelay() - Method in class freemarker.cache.TemplateCache
Gets the delay in milliseconds between checking for newer versions of a template source.
getDirectVariableNames() - Method in class freemarker.core.BaseScope
 
getDirectVariableNames() - Method in class freemarker.core.Environment
 
getDirectVariableNames() - Method in interface freemarker.core.Scope
Returns the names of variables directly managed by this scope (i.e.
getDirectVariableNames() - Method in class freemarker.template.Configuration
 
getEffectiveURLEscapingCharset() - Method in class freemarker.core.Environment
Returns the name of the charset that should be used for URL encoding.
getElementStack() - Method in class freemarker.core.Environment
 
getEnclosingScope() - Method in class freemarker.core.AbstractScope
 
getEnclosingScope() - Method in class freemarker.core.Environment
 
getEnclosingScope() - Method in interface freemarker.core.Scope
 
getEnclosingScope() - Method in class freemarker.template.Configuration
 
getEncoding() - Method in class freemarker.template.Template
Returns the character encoding used for reading included files.
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.
getEnvironment() - Method in class freemarker.core.AbstractScope
Returns the Environment of the enclosing scope
getEnvironment() - Method in class freemarker.core.Configurable
 
getEnvironment() - Method in class freemarker.core.Environment
 
getEnvironment() - Method in interface freemarker.core.Scope
 
getEnvironment() - Method in class freemarker.debug.EnvironmentSuspendedEvent
The environment that was suspended
getEnvironment() - Method in exception freemarker.template.TemplateException
 
getFTLInstructionStack() - Method in exception freemarker.template.TemplateException
Returns the quote of the problematic FTL instruction and the FTL stack strace.
getFTLStack() - Method in exception freemarker.template.TemplateException
 
getFullTemplatePath(Environment, String, String) - Static method in class freemarker.cache.TemplateCache
Resolves a relative template path to absolute template path for purposes of an inclusion via the include directive.
getGlobalNamespace() - Method in class freemarker.core.Environment
Returns a fictitious name-space that contains the globally visible variables that were created in the template, but not the variables of the data-model.
getHeaderElement() - Method in class freemarker.template.Template
 
getId() - Method in interface freemarker.debug.DebuggedEnvironment
Returns a unique identifier for this environment
getImports() - Method in class freemarker.template.Template
 
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.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
 
getLastReturnValue() - Method in class freemarker.core.Environment
 
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.
getLine(int) - Method in class freemarker.template.Template
 
getLocale() - Method in class freemarker.core.Configurable
Returns the assumed locale when searching for template files with no explicit requested locale.
getLocalizedLookup() - Method in class freemarker.cache.TemplateCache
Returns if localized template lookup is enabled or not.
getLocalizedLookup() - Method in class freemarker.template.Configuration
Returns if localized template lookup is enabled or not.
getLocalizedString(Locale) - Method in class freemarker.template.LocalizedString
 
getLocalizedString(Locale) - Method in class freemarker.template.ResourceBundleLocalizedString
 
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.
getLogger(String) - Method in class freemarker.log.SLF4JLoggerFactory
 
getLuckyNumber() - Method in class freemarker.testcase.TemplateTestCase.TestBean
 
getMacroContext(Macro) - Method in class freemarker.core.Environment
 
getMacroNamespace(Macro) - Method in class freemarker.core.Environment
 
getMacros() - Method in class freemarker.core.TemplateCore
 
getMainNamespace() - Method in class freemarker.core.Environment
Returns the main name-space.
getModelTypes() - Method in interface freemarker.debug.DebugModel
 
getName() - Method in class freemarker.template.Template
The path of the template file relative to the directory what you use to store the templates.
getName() - Method in class freemarker.testcase.TemplateTestCase.TestBean
 
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
 
getNewCNumberFormat() - Static method in class freemarker.core.Environment
 
getNodeName() - Method in interface freemarker.template.TemplateNodeModel
 
getNodeNamespace() - Method in interface freemarker.template.TemplateNodeModel
 
getNodeType() - Method in interface freemarker.template.TemplateNodeModel
 
getNumberFormat() - Method in class freemarker.core.Configurable
Returns the default number format used to convert numbers to strings.
getNumberFormatObject(String) - Method in class freemarker.core.Environment
 
getObjectWrapper() - Method in class freemarker.core.Configurable
Retrieves the object wrapper used to wrap objects to template models.
getObjectWrapper() - Method in class freemarker.template.WrappingTemplateModel
Returns the object wrapper instance used by this wrapping template model.
getOut() - Method in class freemarker.core.Environment
 
getOutputEncoding() - Method in class freemarker.core.Configurable
 
getParent() - Method in class freemarker.core.Configurable
Returns the parent Configurable object of this object.
getParentNode() - Method in interface freemarker.template.TemplateNodeModel
 
getParsingProblems() - Method in class freemarker.template.Template
 
getPlainTextTemplate(String, String, Configuration) - Static method in class freemarker.template.Template
Returns a trivial template, one that is just a single block of plain 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
 
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
 
getRootElement() - Method in class freemarker.core.TemplateCore
 
getRootTreeNode() - Method in class freemarker.template.Template
 
getSetting(String) - 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.setSetting(String, String) will work with them correctly.)
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 variables.
getSource(int, int, int, int) - Method in class freemarker.template.Template
 
getStrictVariableDefinition() - Method in class freemarker.template.Configuration
 
getSuspendedEnvironments() - Method in interface freemarker.debug.Debugger
Retrieves a collection of all DebuggedEnvironment objects that are currently suspended.
getTabAdjustedColumn(int, int, int) - Method in class freemarker.template.Template
 
getTagSyntax() - Method in class freemarker.template.Configuration
 
getTemplate() - Method in class freemarker.core.AbstractScope
Returns the template of the enclosing scope
getTemplate() - Method in class freemarker.core.BlockScope
 
getTemplate() - Method in class freemarker.core.Environment
Retrieves the currently processed template.
getTemplate() - Method in interface freemarker.core.Scope
 
getTemplate() - Method in class freemarker.core.TemplateNamespace
 
getTemplate() - Method in class freemarker.template.Configuration
 
getTemplate(String) - Method in class freemarker.template.Configuration
Equivalent to getTemplate(name, thisCfg.getLocale(), thisCfg.getEncoding(thisCfg.getLocale()), true).
getTemplate(String, String) - Method in class freemarker.template.Configuration
Equivalent to getTemplate(name, thisCfg.getLocale(), encoding, true).
getTemplate(String, Locale) - Method in class freemarker.template.Configuration
Equivalent to getTemplate(name, locale, thisCfg.getEncoding(locale), true).
getTemplate(String, Locale, String) - Method in class freemarker.template.Configuration
Equivalent to getTemplate(name, locale, encoding, true).
getTemplate(String, Locale, String, boolean) - Method in class freemarker.cache.TemplateCache
Loads a template with the given name, in the specified locale and using the specified character encoding.
getTemplate(String, Locale, String, boolean) - Method in class freemarker.template.Configuration
Retrieves a template specified by a name and locale, interpreted using the specified character encoding, either parsed or unparsed.
getTemplateCache() - Method in class freemarker.template.Configuration
 
getTemplateExceptionHandler() - Method in class freemarker.core.Configurable
Retrieves the exception handler used to handle template exceptions.
getTemplateForImporting(String) - Method in class freemarker.core.Environment
getTemplateForInclusion(String, String, boolean) - Method in class freemarker.core.Environment
getTemplateLoader() - Method in class freemarker.cache.TemplateCache
Returns the template loader used by this cache.
getTemplateLoader() - Method in class freemarker.template.Configuration
 
getTemplateModel() - Method in interface freemarker.template.TemplateModelAdapter
 
getTemplateName() - Method in class freemarker.debug.Breakpoint
Returns the template name of the breakpoint
getTestBean() - Method in class freemarker.testcase.TemplateTestCase
 
getTimeFormat() - Method in class freemarker.core.Configurable
Returns the date format used to convert date models representing time-only dates to strings.
getTimeZone() - Method in class freemarker.core.Configurable
Returns the time zone to use when formatting time values.
getTransform(Expression) - Method in class freemarker.core.Environment
 
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.
getURLEscapingCharset() - Method in class freemarker.core.Configurable
 
getVariable(String) - Method in class freemarker.core.Environment
Returns the variable that is visible in this context.
getVersionNumber() - Static method in class freemarker.template.Configuration
Returns FreeMarker version.
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.template.TemplateModelListSequence
 
getWriter(Writer, Map<String, TemplateModel>) - Method in interface freemarker.template.TemplateTransformModel
Deprecated.
Returns a writer that will be used by the engine to feed the transformation input to the transform.

H

handleTemplateException(TemplateException, Environment, Writer) - Method in interface freemarker.template.TemplateExceptionHandler
handle the exception.
handleUnknownType(Object) - Method in class freemarker.template.DefaultObjectWrapper
Called if an unknown type is passed in.
handleUnknownType(Object) - Method in class freemarker.template.SimpleObjectWrapper
Called if a type other than the simple ones we know about is passed in.
hashCode() - Method in class freemarker.debug.Breakpoint
 
hasNext() - Method in interface freemarker.template.TemplateModelIterator
 
hasParsingProblems() - Method in class freemarker.template.Template
 
HTML_DEBUG_HANDLER - Static variable in interface freemarker.template.TemplateExceptionHandler
This is a TemplateExceptionHandler used when you develop HTML templates.

I

IGNORE_HANDLER - Static variable in interface freemarker.template.TemplateExceptionHandler
This is a TemplateExceptionHandler which simply skips errors.
importLib(Template, String, boolean) - Method in class freemarker.core.Environment
Emulates import directive.
importLib(String, String) - Method in class freemarker.core.Environment
Emulates import directive, except that name must be tempate root relative.
include(Template, boolean) - Method in class freemarker.core.Environment
Processes a Template in the context of this Environment, including its output in the Environment's Writer.
include(String, String, boolean) - Method in class freemarker.core.Environment
Emulates include directive, except that name must be tempate root relative.
IncludedTemplateNamespace - Class in freemarker.core
This class is used for the scope of an included template.
info() - Static method in class freemarker.core.CommandLine
 
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.
INSTANCE - Static variable in exception freemarker.core.BreakException
 
INSTANCE - Static variable in exception freemarker.core.ReturnException
 
INVALID_EXPRESSION - Static variable in interface freemarker.template.TemplateModel
A singleton value used to represent the result of an invalid expression, such as 1 - "3"
InvalidReferenceException - Exception in freemarker.core
A subclass of TemplateException that says there is no value associated with a given expression.
InvalidReferenceException(Environment) - Constructor for exception freemarker.core.InvalidReferenceException
 
InvalidReferenceException(String, Environment) - Constructor for exception freemarker.core.InvalidReferenceException
 
invalidSettingValueException(String, String) - Method in class freemarker.core.Configurable
 
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.SoftCacheStorage
 
isConcurrent() - Method in class freemarker.cache.StrongCacheStorage
 
isDebugEnabled() - Method in class freemarker.log.Logger
Returns true if this logger will log debug messages.
isEmpty() - Method in class freemarker.core.AbstractScope
 
isEmpty() - Method in class freemarker.core.BaseScope
 
isEmpty() - Method in class freemarker.core.Environment
 
isEmpty() - Method in class freemarker.template.Configuration
 
isEmpty() - Method in class freemarker.template.SimpleHash
 
isEmpty() - Method in interface freemarker.template.TemplateHashModel
 
isErrorEnabled() - Method in class freemarker.log.Logger
Returns true if this logger will log error messages.
isFatalEnabled() - Method in class freemarker.log.Logger
Returns true if this logger will log fatal error messages.
isImplicitlyDeclared(String) - Method in class freemarker.template.Template
only used internally, it says whether the variable was implicitly declared, that means not in a #var statement but either via a legacy #assign or as the name of a macro or as the namespace name in an #import This is rather tricky and only necessary for backward compatibility with older style #include's
isInfoEnabled() - Method in class freemarker.log.Logger
Returns true if this logger will log informational messages.
isOutputtingLine(int, boolean) - Method in class freemarker.template.Template
 
isSecure() - Method in class freemarker.template.Configuration
 
isWarnEnabled() - Method in class freemarker.log.Logger
Returns true if this logger will log warning messages.
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.

J

JAVA_NULL - Static variable in interface freemarker.template.TemplateModel
A singleton value used to represent a java null which comes from a wrapped Java API, for example, i.e.

K

keys() - Method in class freemarker.core.BaseScope
 
keys() - Method in class freemarker.core.Environment
 
keys() - Method in interface freemarker.debug.DebugModel
 
keys() - Method in class freemarker.template.Configuration
 
keys() - Method in class freemarker.template.SimpleHash
 
keys() - Method in interface freemarker.template.TemplateHashModelEx
 

L

lastLine(TemplateNode) - Method in class freemarker.template.PostParseVisitor
 
LazilyEvaluatableArguments - Interface in freemarker.template
A marker interface that tells the FreeMarker that the method arguments can be lazily evaluated.
LIBRARY_AUTO - Static variable in class freemarker.log.Logger
Constant used with Logger.selectLoggerLibrary(int) that indicates the engine should automatically lookup and use any available logger library.
LIBRARY_JAVA - Static variable in class freemarker.log.Logger
Constant used with Logger.selectLoggerLibrary(int) that indicates the engine should use the java.util.logging logger package.
LIBRARY_NONE - Static variable in class freemarker.log.Logger
Constant used with Logger.selectLoggerLibrary(int) that indicates the engine should use no logger package (i.e.
LIBRARY_SLF4J - Static variable in class freemarker.log.Logger
Constant used with Logger.selectLoggerLibrary(int) that indicates the engine should use the SLF4J logger adapter package.
lineSaysLeftTrim(int) - Method in class freemarker.template.Template
 
lineSaysNoTrim(int) - Method in class freemarker.template.Template
 
lineSaysRightTrim(int) - Method in class freemarker.template.Template
 
list - Variable in class freemarker.template.SimpleSequence
 
loadBuiltInEncodingMap() - Method in class freemarker.template.Configuration
Loads a preset language-to-encoding map.
LOCALE_KEY - Static variable in class freemarker.core.Configurable
 
LOCALIZED_LOOKUP_KEY - Static variable in class freemarker.template.Configuration
 
LocalizedString - Class in freemarker.template
An abstract base class for scalars that vary by locale.
LocalizedString() - Constructor for class freemarker.template.LocalizedString
 
Logger - Class in freemarker.log
The FreeMarker logging facility.
Logger() - Constructor for class freemarker.log.Logger
 
LoopContext - Class in freemarker.core
Represents the local context of an iterator block
LoopContext(IteratorBlock, Scope, TemplateModel) - Constructor for class freemarker.core.LoopContext
 

M

MacroContext - Class in freemarker.core
Represents the context or scope of the execution of an FTL macro.
MacroContext(Macro, Environment, TemplateElement, ParameterList) - Constructor for class freemarker.core.MacroContext
 
MacroInvocationBodyContext - Class in freemarker.core
Represents the context or scope when a macro executes the body of a macro invocation via [#nested]
MacroInvocationBodyContext(Environment, PositionalArgsList) - Constructor for class freemarker.core.MacroInvocationBodyContext
 
main(String[]) - Static method in class freemarker.core.CommandLine
 
main(String[]) - Static method in class freemarker.testcase.PerformanceTest
 
main(String[]) - Static method in class freemarker.testcase.TemplateTestSuite
 
markAsOutputtingLine(int, boolean) - Method in class freemarker.template.Template
 
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.
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 multi template Loader that will use the specified loaders.

N

next() - Method in interface freemarker.template.TemplateModelIterator
Returns the next model.
NO_NS_PREFIX - Static variable in class freemarker.template.Template
 
NOTHING - Static variable in interface freemarker.template.TemplateModel
Deprecated.
Try not to use this.
NULL_CODE_SOURCE - Static variable in class freemarker.template.Template
 
NULL_WRITER - Static variable in class freemarker.core.Environment
 
NUMBER_FORMAT_KEY - Static variable in class freemarker.core.Configurable
 

O

OBJECT_WRAPPER_KEY - Static variable in class freemarker.core.Configurable
 
ObjectWrapper - Interface in freemarker.template
An object that knows how to "wrap" a java object as a TemplateModel instance.
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.
OUTPUT_ENCODING_KEY - Static variable in class freemarker.core.Configurable
 
outputInstructionStack(PrintWriter) - Method in class freemarker.core.Environment
Outputs the instruction stack.

P

Parameters - Annotation Type in freemarker.template
An annotation that indicates what the parameters an FTL transform or method can take.
ParserTestCase - Class in freemarker.testcase
Test case for parser.
ParserTestCase(String, String) - Constructor for class freemarker.testcase.ParserTestCase
 
PerformanceTest - Class in freemarker.testcase
This class executes a FreeMarker template repeatedly in an endless loop.
PerformanceTest() - Constructor for class freemarker.testcase.PerformanceTest
 
PostParseVisitor - Class in freemarker.template
A class that visits the AST after the parsing step proper, and makes various checks and adjustments.
PostParseVisitor(Template) - Constructor for class freemarker.template.PostParseVisitor
 
printStackTrace(PrintStream) - Method in exception freemarker.core.StopException
 
printStackTrace(PrintStream) - Method in exception freemarker.template.TemplateException
 
printStackTrace(PrintWriter) - Method in exception freemarker.core.StopException
 
printStackTrace(PrintWriter) - Method in exception freemarker.template.TemplateException
 
process() - Method in class freemarker.core.Environment
Processes the template to which this environment belongs.
process(LoopContext) - Method in class freemarker.core.Environment
"visit" an IteratorBlock
process(TemplateNodeModel, TemplateSequenceModel) - Method in class freemarker.core.Environment
 
process(Object, Writer) - Method in class freemarker.template.Template
Processes the template, using data from the map, and outputs the resulting text to the supplied Writer The elements of the map are converted to template models using the default object wrapper returned by the getObjectWrapper() method of the Configuration.
process(Object, Writer, ObjectWrapper) - Method in class freemarker.template.Template
Processes the template, using data from the root map object, and outputs the resulting text to the supplied writer, using the supplied object wrapper to convert map elements to template models.
process(Object, Writer, ObjectWrapper, TemplateNodeModel) - Method in class freemarker.template.Template
Processes the template, using data from the root map object, and outputs the resulting text to the supplied writer, using the supplied object wrapper to convert map elements to template models.
processTemplate(String) - Static method in class freemarker.core.CommandLine
processes template with an empty data model
put(Object, Object) - Method in interface freemarker.cache.CacheStorage
Associates a key with a cached value
put(Object, Object) - Method in class freemarker.cache.MruCacheStorage
 
put(Object, Object) - Method in class freemarker.cache.SoftCacheStorage
 
put(Object, Object) - Method in class freemarker.cache.StrongCacheStorage
 
put(String, boolean) - Method in class freemarker.template.SimpleHash
Puts a boolean in the map
put(String, TemplateModel) - Method in class freemarker.core.BaseScope
 
put(String, TemplateModel) - Method in class freemarker.core.BlockScope
 
put(String, TemplateModel) - Method in class freemarker.core.Environment
 
put(String, TemplateModel) - Method in class freemarker.core.IncludedTemplateNamespace
 
put(String, TemplateModel) - Method in interface freemarker.core.Scope
Set a variable in this scope.
put(String, TemplateModel) - Method in class freemarker.core.TemplateNamespace
 
put(String, TemplateModel) - Method in class freemarker.template.Configuration
 
put(String, Object) - Method in class freemarker.template.SimpleHash
Adds a key-value entry to the map.
putAll(Map) - Method in class freemarker.template.SimpleHash
Adds all the key/value entries in the map
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.

R

readConfig(File) - Method in class freemarker.testcase.TemplateTestSuite
Read the testcase configurations file and build up the test suite
readInTemplateText(Reader) - Method in class freemarker.template.Template
 
remove(Object) - Method in interface freemarker.cache.CacheStorage
Removes the value associated with a key, if it exists.
remove(Object) - Method in class freemarker.cache.MruCacheStorage
 
remove(Object) - Method in class freemarker.cache.SoftCacheStorage
 
remove(Object) - Method in class freemarker.cache.StrongCacheStorage
 
remove(String) - Method in class freemarker.core.BaseScope
 
remove(String) - Method in class freemarker.core.Environment
 
remove(String) - Method in interface freemarker.core.Scope
Removes a variable in this scope.
remove(String) - Method in class freemarker.template.Configuration
 
remove(String) - Method in class freemarker.template.SimpleHash
Removes the given key from the underlying map.
removeAutoImport(String) - Method in class freemarker.template.Configuration
Remove an auto-imported template
removeAutoInclude(String) - Method in class freemarker.template.Configuration
remove a template from the auto-include list.
removeAutoTemplateVisitors(ASTVisitor...) - Method in class freemarker.template.Configuration
 
removeBreakpoint(Breakpoint) - Method in interface freemarker.debug.Debugger
Removes a single breakpoint
removeBreakpoints() - Method in interface freemarker.debug.Debugger
Removes all breakpoints
removeBreakpoints(String) - Method in interface freemarker.debug.Debugger
Removes all breakpoints for a specific template
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.
render(Macro, ArgsList, ParameterList, TemplateElement) - Method in class freemarker.core.Environment
"visit" a macro.
render(TemplateElement) - Method in class freemarker.core.Environment
"Visit" the template element.
render(TemplateElement, TemplateElement, List<ParsingProblem>) - Method in class freemarker.core.Environment
Visit a block using buffering/recovery
render(TemplateElement, TemplateDirectiveModel, Map<String, TemplateModel>, List<String>) - Method in class freemarker.core.Environment
 
render(TemplateElement, TemplateTransformModel, Map<String, TemplateModel>) - Method in class freemarker.core.Environment
"Visit" the template element, passing the output through a TemplateTransformModel
render(Environment, TemplateElement) - Method in class freemarker.core.SecureRenderer
 
render(Environment, TemplateElement) - Method in class freemarker.core.SecureRendererImpl
 
render(MacroInvocationBodyContext) - Method in class freemarker.core.Environment
 
render(TemplateNodeModel, TemplateSequenceModel) - Method in class freemarker.core.Environment
"Visit" A TemplateNodeModel
render(Writer) - Method in interface freemarker.template.TemplateDirectiveBody
Renders the body of the directive body to the specified writer.
renderElementToString(TemplateElement) - Method in class freemarker.core.Environment
 
renderSecurely(TemplateElement, CodeSource) - Method in class freemarker.core.Environment
 
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.
resetState() - Method in class freemarker.cache.MultiTemplateLoader
 
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.
resolveVariable(String) - Method in class freemarker.core.AbstractScope
 
resolveVariable(String) - Method in class freemarker.core.Environment
 
resolveVariable(String) - Method in interface freemarker.core.Scope
Evaluates the variable of this name in this scope, falling back to the enclosing Scope if it is not defined in this one.
resolveVariable(String) - Method in class freemarker.template.Configuration
 
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
 
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
This is a TemplateExceptionHandler that simply rethrows the exception.
ReturnException - Exception in freemarker.core
An exception used to jump out of a macro or function
run() - Method in interface freemarker.core.TemplateRunnable
 
runInScope(Scope, TemplateRunnable<T>) - Method in class freemarker.core.Environment
 
runLoop() - Method in class freemarker.core.LoopContext
 
runTest() - Method in class freemarker.testcase.ParserTestCase
 
runTest() - Method in class freemarker.testcase.TemplateTestCase
 

S

Scope - Interface in freemarker.core
Represents a variable resolution context in FTL.
SCOPE_CONFIGURATION - Static variable in class freemarker.core.CustomAttribute
Constant used in the constructor specifying that this attribute is scoped by the configuration.
SCOPE_ENVIRONMENT - Static variable in class freemarker.core.CustomAttribute
Constant used in the constructor specifying that this attribute is scoped by the environment.
SCOPE_TEMPLATE - Static variable in class freemarker.core.CustomAttribute
Constant used in the constructor specifying that this attribute is scoped by the template.
SECURE - Static variable in class freemarker.template.Configuration
 
SecureRenderer - Class in freemarker.core
 
SecureRenderer() - Constructor for class freemarker.core.SecureRenderer
 
SecureRendererImpl - Class in freemarker.core
 
SecureRendererImpl() - Constructor for class freemarker.core.SecureRendererImpl
 
SecureTemplateLoader - Interface in freemarker.cache
A template loader that is able to provide a code source for the template.
selectLoggerLibrary(int) - Static method in class freemarker.log.Logger
Selects the logger library to use.
set(Object) - Method in class freemarker.core.CustomAttribute
Sets the value of the attribute in the context of the current environment.
set(Object, Template) - Method in class freemarker.core.CustomAttribute
Sets the value of a template-scope attribute in the context of the given template.
setAllSharedVariables(TemplateHashModelEx) - Method in class freemarker.template.Configuration
Adds all object in the hash as shared variable to the configuration.
setArithmeticEngine(ArithmeticEngine) - Method in class freemarker.core.Configurable
Sets the arithmetic engine used to perform arithmetic operations.
setAutoImports(Map<String, String>) - Method in class freemarker.template.Configuration
set a map of namespace names to templates for auto-importing a set of templates.
setAutoIncludes(List<String>) - Method in class freemarker.template.Configuration
set the list of automatically included templates.
setAutoTemplateVisitors(ASTVisitor...) - Method in class freemarker.template.Configuration
 
setBooleanFormat(String) - Method in class freemarker.core.Configurable
 
setCacheStorage(CacheStorage) - Method in class freemarker.template.Configuration
 
setCategoryPrefix(String) - Static method in class freemarker.log.Logger
Sets a category prefix.
setClassForTemplateLoading(Class, String) - Method in class freemarker.template.Configuration
Sets a class relative to which we do the Class.getResource() call to load templates.
setConfigParam(String, String, File) - Method in class freemarker.testcase.TemplateTestCase
 
setConfiguration(Configuration) - Method in class freemarker.cache.TemplateCache
Sets the configuration object to which this cache belongs.
setCurrentVisitorNode(TemplateNodeModel) - Method in class freemarker.core.Environment
sets TemplateNodeModel as the current visitor node.
setCurriedMacroNamespace(Macro, Macro) - Method in class freemarker.core.Environment
 
setCustomAttribute(String, Object) - Method in class freemarker.core.Configurable
Sets a named custom attribute for this configurable.
setDateFormat(String) - Method in class freemarker.core.Configurable
Sets the date format used to convert date models representing date-only dates to strings.
setDateFormat(String) - Method in class freemarker.core.Environment
 
setDateTimeFormat(String) - Method in class freemarker.core.Configurable
Sets the date format used to convert date models representing datetime dates to 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....
setDefaultEncoding(String) - Method in class freemarker.template.Configuration
Sets the default encoding for converting bytes to characters when reading template files in a locale for which no explicit encoding was specified.
setDefaultObjectWrapper(ObjectWrapper) - Static method in class freemarker.template.WrappingTemplateModel
Sets the default object wrapper that is used when a wrapping template model is constructed without being passed an explicit object wrapper.
setDelay(long) - Method in class freemarker.cache.TemplateCache
Sets the delay in milliseconds between checking for newer versions of a template sources.
setDirectoryForTemplateLoading(File) - Method in class freemarker.template.Configuration
Set the explicit directory from which to load templates.
setEncoding(String) - Method in class freemarker.template.Template
Sets the character encoding to use for included files.
setEncoding(Locale, String) - Method in class freemarker.template.Configuration
Sets the character set encoding to use for templates of a given locale.
setGlobalVariable(String, TemplateModel) - Method in class freemarker.core.Environment
Sets a variable that is visible globally.
setHeaderElement(TemplateHeaderElement) - Method in class freemarker.template.Template
 
setImplicitlyDeclaredVariables(Set<String>) - Method in class freemarker.template.Template
Used internally, this is a complication necessary for backward compatibility in includes.
setLastReturnValue(TemplateModel) - Method in class freemarker.core.Environment
 
setLineSaysLeftTrim(int) - Method in class freemarker.template.Template
 
setLineSaysNoTrim(int) - Method in class freemarker.template.Template
 
setLineSaysRightTrim(int) - Method in class freemarker.template.Template
 
setLineSaysTrim(int) - Method in class freemarker.template.Template
 
setLocale(Locale) - Method in class freemarker.core.Configurable
Sets the locale to assume when searching for template files with no explicit requested locale.
setLocale(Locale) - Method in class freemarker.core.Environment
 
setLocalizedLookup(boolean) - Method in class freemarker.cache.TemplateCache
Sets whether to enable localized template lookup 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).
setNumberFormat(String) - Method in class freemarker.core.Configurable
Sets the number format used to convert numbers to strings.
setNumberFormat(String) - Method in class freemarker.core.Environment
 
setNumbersForComputers(boolean) - Method in class freemarker.core.Configurable
 
setObjectWrapper(ObjectWrapper) - Method in class freemarker.core.Configurable
Sets the object wrapper used to wrap objects to template models.
setObjectWrapper(ObjectWrapper) - Method in class freemarker.template.WrappingTemplateModel
 
setOut(Writer) - Method in class freemarker.core.Environment
 
setOutputDirectory(String, File) - Method in class freemarker.testcase.TemplateTestCase
 
setOutputEncoding(String) - Method in class freemarker.core.Configurable
Sets the output encoding.
setOutputEncoding(String) - Method in class freemarker.core.Environment
 
setParent(Configurable) - Method in class freemarker.core.Configurable
Reparenting support.
setParent(Configurable) - Method in class freemarker.template.Template
 
setRootElement(TemplateElement) - Method in class freemarker.core.TemplateCore
 
setSecure(boolean) - Method in class freemarker.template.Configuration
Sets whether templates are secured.
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 setting by a name and string value.
setSetting(String, String) - Method in class freemarker.template.Configuration
Sets a setting by name and string value.
setSettings(InputStream) - Method in class freemarker.core.Configurable
Reads a setting list (key and element pairs) from the input stream.
setSettings(Properties) - Method in class freemarker.core.Configurable
Set the settings stored in a Properties object.
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.
setStrictBeanModels(boolean) - Method in class freemarker.core.Configurable
 
setStrictVariableDeclaration(boolean) - Method in class freemarker.template.Template
 
setStrictVariableDefinition(boolean) - Method in class freemarker.template.Configuration
Sets whether, by default, templates use strict variable definition syntax, such that any variable created at the top template level must be declared with a #var directive.
setStripWhitespace(boolean) - Method in class freemarker.template.Template
 
setTagSyntax(int) - Method in class freemarker.template.Configuration
Determines the syntax of the template files (angle bracket VS square bracket) that has no ftl directive in it.
setTemplateCache(TemplateCache) - Method in class freemarker.template.Configuration
 
setTemplateDirectory(String, File) - Method in class freemarker.testcase.TemplateTestCase
 
setTemplateExceptionHandler(TemplateExceptionHandler) - Method in class freemarker.core.Configurable
Sets the exception handler used to handle template exceptions.
setTemplateExceptionHandler(TemplateExceptionHandler) - Method in class freemarker.core.Environment
 
setTemplateLoader(TemplateLoader) - Method in class freemarker.template.Configuration
Sets a template loader that is used to look up and load templates.
setTemplateUpdateDelay(int) - Method in class freemarker.template.Configuration
Set the time in seconds that must elapse before checking whether there is a newer version of a template file.
setTimeFormat(String) - Method in class freemarker.core.Configurable
Sets the date format used to convert date models representing time-only values to 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 time values.
setTimeZone(TimeZone) - Method in class freemarker.core.Environment
 
setTolerateParsingProblems(boolean) - Method in class freemarker.template.Configuration
Set whether the getTemplate() methods throw exceptions when there is a (recoverable) parsing problem in the template.
setUp() - Method in class freemarker.testcase.TemplateTestCase
 
setURLEscapingCharset(String) - Method in class freemarker.core.Configurable
Sets the URL escaping charset.
setURLEscapingCharset(String) - Method in class freemarker.core.Environment
 
setVariable(String, TemplateModel) - Method in class freemarker.core.Environment
Sets a variable in the current namespace.
setWhitespaceStripping(boolean) - Method in class freemarker.template.Configuration
Sets whether the FTL parser will try to remove superfluous white-space around certain FTL tags.
SIMPLE_WRAPPER - Static variable in interface freemarker.template.ObjectWrapper
Object wrapper that uses SimpleXXX wrappers only.
SimpleCollection - Class in freemarker.template
A simple implementation of TemplateCollectionModel.
SimpleCollection(Collection) - Constructor for class freemarker.template.SimpleCollection
 
SimpleCollection(Collection, ObjectWrapper) - Constructor for class freemarker.template.SimpleCollection
 
SimpleCollection(Iterator) - Constructor for class freemarker.template.SimpleCollection
 
SimpleCollection(Iterator, 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 an underlying Map or SortedMap.
SimpleHash() - Constructor for class freemarker.template.SimpleHash
Constructs an empty hash that uses the default wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper).
SimpleHash(ObjectWrapper) - Constructor for class freemarker.template.SimpleHash
Creates an empty simple hash using the specified object wrapper.
SimpleHash(Map) - Constructor for class freemarker.template.SimpleHash
Creates a new simple hash with the copy of the underlying map and the default wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper).
SimpleHash(Map, ObjectWrapper) - Constructor for class freemarker.template.SimpleHash
Creates a new simple hash with the copy of the underlying map and either the default wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper), or the JavaBeans wrapper.
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.
 
SimpleNumber - Class in freemarker.template
A simple implementation of the TemplateNumberModel interface.
SimpleNumber(byte) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(double) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(float) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(int) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(long) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(short) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(Number) - Constructor for class freemarker.template.SimpleNumber
 
SimpleObjectWrapper - Class in freemarker.template
The default implementation of the ObjectWrapper interface.
SimpleObjectWrapper() - 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 convenient implementation of a list.
SimpleSequence() - Constructor for class freemarker.template.SimpleSequence
Constructs an empty simple sequence that will use the the default object wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper).
SimpleSequence(int) - Constructor for class freemarker.template.SimpleSequence
Constructs an empty simple sequence with preallocated capacity and using the default object wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper).
SimpleSequence(ObjectWrapper) - Constructor for class freemarker.template.SimpleSequence
Constructs an empty simple sequence using the specified object wrapper.
SimpleSequence(TemplateCollectionModel) - Constructor for class freemarker.template.SimpleSequence
Constructs a simple sequence from the passed collection model using the default object wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper).
SimpleSequence(Collection) - Constructor for class freemarker.template.SimpleSequence
Constructs a simple sequence that will contain the elements from the specified Collection and will use the the default object wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper).
SimpleSequence(Collection<?>, ObjectWrapper) - Constructor for class freemarker.template.SimpleSequence
Constructs a simple sequence that will contain the elements from the specified Collection and will use the specified object wrapper.
size() - Method in class freemarker.core.BaseScope
 
size() - Method in class freemarker.core.Environment
 
size() - Method in interface freemarker.debug.DebugModel
 
size() - Method in class freemarker.template.Configuration
 
size() - Method in class freemarker.template.SimpleHash
 
size() - Method in class freemarker.template.SimpleSequence
 
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.
SLF4JLoggerFactory - Class in freemarker.log
 
SLF4JLoggerFactory() - Constructor for class freemarker.log.SLF4JLoggerFactory
 
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
 
SoftCacheStorage(Map) - Constructor for class freemarker.cache.SoftCacheStorage
 
specifiedEncoding - Variable in exception freemarker.template.Template.WrongEncodingException
 
SQUARE_BRACKET_TAG_SYNTAX - Static variable in class freemarker.template.Configuration
 
StatefulTemplateLoader - Interface in freemarker.cache
Interface that can be implemented by template loaders 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.
StopException(Environment) - Constructor for exception freemarker.core.StopException
 
StopException(Environment, String) - Constructor for exception freemarker.core.StopException
 
STRICT_BEAN_MODELS - Static variable in class freemarker.core.Configurable
 
STRICT_SYNTAX_KEY - Static variable in class freemarker.template.Configuration
 
STRICT_VARS_KEY - Static variable in class freemarker.template.Configuration
 
strictVariableDeclaration() - Method in class freemarker.template.Template
 
StringTemplateLoader - Class in freemarker.cache
A TemplateLoader that uses a Map with Strings as its source of templates.
StringTemplateLoader() - Constructor for class freemarker.cache.StringTemplateLoader
 
StrongCacheStorage - Class in freemarker.cache
Strong cache storage is a cache storage that simply wraps a Map.
StrongCacheStorage() - Constructor for class freemarker.cache.StrongCacheStorage
 
suite() - Static method in class freemarker.testcase.TemplateTestSuite
 
synchronizedWrapper() - Method in class freemarker.template.SimpleHash
 
synchronizedWrapper() - Method in class freemarker.template.SimpleSequence
 

T

Template - Class in freemarker.template
A core FreeMarker API that represents a compiled template.
Template(String, Configuration, CodeSource) - Constructor for class freemarker.template.Template
A prime constructor to which all other constructors should delegate directly or indirectly.
Template(String, Reader) - Constructor for class freemarker.template.Template
Deprecated.
This constructor uses the "default" Configuration instance, which can easily lead to erroneous, unpredictable behaviuour. See more here....
Template(String, Reader, Configuration) - Constructor for class freemarker.template.Template
This is equivalent to Template(name, reader, cfg, null)
Template(String, Reader, Configuration, String) - Constructor for class freemarker.template.Template
 
Template(String, Reader, Configuration, String, CodeSource) - Constructor for class freemarker.template.Template
Constructs a template from a character stream.
TEMPLATE_EXCEPTION_HANDLER_KEY - Static variable in class freemarker.core.Configurable
 
TEMPLATE_UPDATE_DELAY_KEY - Static variable in class freemarker.template.Configuration
 
Template.WrongEncodingException - Exception in freemarker.template
 
TemplateBooleanModel - Interface in freemarker.template
Objects that will be interpreted as true/false in the appropriate context must implement this interface.
TemplateCache - Class in freemarker.cache
A class that performs caching and on-demand loading of the templates.
TemplateCache() - Constructor for class freemarker.cache.TemplateCache
Returns a template cache that will first try to load a template from the file system relative to the current user directory (i.e.
TemplateCache(TemplateLoader) - Constructor for class freemarker.cache.TemplateCache
Creates a new template cache with a custom template loader that is used to load the templates.
TemplateCache(TemplateLoader, CacheStorage) - Constructor for class freemarker.cache.TemplateCache
Creates a new template cache with a custom template loader and cache storage that are used to load and store the templates.
TemplateCacheTest - Class in freemarker.testcase
 
TemplateCacheTest(String) - Constructor for class freemarker.testcase.TemplateCacheTest
 
TemplateCollectionModel - Interface in freemarker.template
This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateCore - Class in freemarker.core
Abstract base class for Template.
TemplateCore(Configuration) - Constructor for class freemarker.core.TemplateCore
 
TemplateDateModel - Interface in freemarker.template
Date values in a template data model must implement this interface.
TemplateDirectiveBody - Interface in freemarker.template
Represents the body of a directive invocation.
TemplateDirectiveModel - Interface in freemarker.template
Objects that implement this interface can be used as user-defined directives (much like macros).
TemplateException - Exception in freemarker.template
The FreeMarker classes usually use this exception and its descendants to signal FreeMarker specific exceptions.
TemplateException(Environment) - Constructor for exception freemarker.template.TemplateException
Constructs a TemplateException with no specified detail message or underlying cause.
TemplateException(Exception, Environment) - Constructor for exception freemarker.template.TemplateException
Constructs a TemplateException with the given underlying Exception, but no detail message.
TemplateException(String, Environment) - Constructor for exception freemarker.template.TemplateException
Constructs a TemplateException with the given detail message, but no underlying cause exception.
TemplateException(String, Exception, 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.
TemplateExceptionHandler - Interface in freemarker.template
An API for objects that handle exceptions that are thrown during template rendering.
TemplateHashModel - Interface in freemarker.template
Hashes in a data model must implement this interface.
TemplateHashModelEx - Interface in freemarker.template
An extended hash interface with a couple of extra hooks.
TemplateLoader - Interface in freemarker.cache
A template loader is an object that can find the source stream for a template, can retrieve its time of last modification as well as the stream itself.
TemplateMethodModel - Interface in freemarker.template
Objects that act as methods in a template data model must implement this interface.
TemplateMethodModelEx - Interface in freemarker.template
A subinterface of TemplateMethodModel that acts on models, rather than on strings.
TemplateModel - Interface in freemarker.template
This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModel.InvalidExpressionModel - Class in freemarker.template
 
TemplateModel.JavaNull - Class in freemarker.template
The type of the TemplateModel.JAVA_NULL object.
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
Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateModelException() - Constructor for exception freemarker.template.TemplateModelException
Constructs a TemplateModelException with no specified detail message.
TemplateModelException(Exception) - Constructor for exception freemarker.template.TemplateModelException
Constructs a TemplateModelException with the given underlying Exception, but no detail message.
TemplateModelException(String) - Constructor for exception freemarker.template.TemplateModelException
Constructs a TemplateModelException with the specified detail message.
TemplateModelException(String, Exception) - 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.
TemplateModelIterator - Interface in freemarker.template
This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel.
TemplateModelListSequence - Class in freemarker.template
Sequence that wraps a java.util.List of already wrapped objects directly, with minimal resource usage.
TemplateModelListSequence(List) - Constructor for class freemarker.template.TemplateModelListSequence
 
TemplateNamespace - Class in freemarker.core
Represents the namespace associated with a template
TemplateNodeModel - Interface in freemarker.template
Describes objects that are nodes in a tree.
TemplateNumberModel - Interface in freemarker.template
Numeric values in a template data model must implement this interface.
TemplateRunnable<T> - Interface in freemarker.core
 
TemplateScalarModel - Interface in freemarker.template
String values in a template data model must implement this interface.
TemplateSequenceModel - Interface in freemarker.template
List values in a template data model whose elements are accessed by the index operator should implement this interface.
TemplateTestCase - Class in freemarker.testcase
 
TemplateTestCase(String, String) - Constructor for class freemarker.testcase.TemplateTestCase
 
TemplateTestCase.TestBean - Class in freemarker.testcase
 
TemplateTestSuite - Class in freemarker.testcase
Test suite for FreeMarker.
TemplateTestSuite() - Constructor for class freemarker.testcase.TemplateTestSuite
 
templateText - Variable in class freemarker.template.Template
 
TemplateTransformModel - Interface in freemarker.template
Deprecated.
TestBean() - Constructor for class freemarker.testcase.TemplateTestCase.TestBean
 
testCachedException() - Method in class freemarker.testcase.TemplateCacheTest
 
testCachedNotFound() - Method in class freemarker.testcase.TemplateCacheTest
 
TIME - Static variable in interface freemarker.template.TemplateDateModel
The date model represents a time-only value.
TIME_FORMAT_KEY - Static variable in class freemarker.core.Configurable
 
TIME_ZONE_KEY - Static variable in class freemarker.core.Configurable
 
toList() - Method in class freemarker.template.SimpleSequence
Note that this method creates and returns a deep-copy of the underlying list used internally.
toMap() - Method in class freemarker.template.SimpleHash
Note that this method creates and returns a deep-copy of the underlying hash used internally.
toString() - Method in class freemarker.template.SimpleDate
 
toString() - Method in class freemarker.template.SimpleHash
Convenience method for returning the String value 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.
TransformControl - Interface in freemarker.template
An interface that can be implemented by writers returned from TemplateTransformModel.getWriter(java.io.Writer, java.util.Map).
TRUE - Static variable in interface freemarker.template.TemplateBooleanModel
A singleton object to represent boolean true
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

UndeclaredVariableException - Exception in freemarker.core
This exception is thrown when a set directive in the template tries to set a variable which is not declared in that scope or an enclosing one.
UndeclaredVariableException(String) - Constructor for exception freemarker.core.UndeclaredVariableException
 
UNKNOWN - Static variable in interface freemarker.template.TemplateDateModel
It is not known whether the date model represents a time-only, a date-only, or a datetime value.
unknownSettingException(String) - Method in class freemarker.core.Configurable
 
unqualifiedSet(String, TemplateModel) - Method in class freemarker.core.Environment
Sets a variable in the most local scope available (corresponds to an unqualified #set instruction)
URL_ESCAPING_CHARSET_KEY - Static variable in class freemarker.core.Configurable
 
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
 

V

value() - Method in annotation type freemarker.template.Parameters
 
values() - Method in class freemarker.core.BaseScope
 
values() - Method in class freemarker.core.Environment
 
values() - Method in class freemarker.template.Configuration
 
values() - Method in class freemarker.template.SimpleHash
 
values() - Method in interface freemarker.template.TemplateHashModelEx
 
visit(AndExpression) - Method in class freemarker.template.PostParseVisitor
 
visit(ArithmeticExpression) - Method in class freemarker.template.PostParseVisitor
 
visit(AssignmentInstruction) - Method in class freemarker.template.PostParseVisitor
 
visit(BlockAssignment) - Method in class freemarker.template.PostParseVisitor
 
visit(BodyInstruction) - Method in class freemarker.template.PostParseVisitor
 
visit(BreakInstruction) - Method in class freemarker.template.PostParseVisitor
 
visit(BuiltInExpression) - Method in class freemarker.template.PostParseVisitor
 
visit(ComparisonExpression) - Method in class freemarker.template.PostParseVisitor
 
visit(Dot) - Method in class freemarker.template.PostParseVisitor
 
visit(DynamicKeyName) - Method in class freemarker.template.PostParseVisitor
 
visit(EscapeBlock) - Method in class freemarker.template.PostParseVisitor
 
visit(FallbackInstruction) - Method in class freemarker.template.PostParseVisitor
 
visit(HashLiteral) - Method in class freemarker.template.PostParseVisitor
 
visit(IfBlock) - Method in class freemarker.template.PostParseVisitor
 
visit(Include) - Method in class freemarker.template.PostParseVisitor
 
visit(Interpolation) - Method in class freemarker.template.PostParseVisitor
 
visit(InvalidExpression) - Method in class freemarker.template.PostParseVisitor
 
visit(IteratorBlock) - Method in class freemarker.template.PostParseVisitor
 
visit(LibraryLoad) - Method in class freemarker.template.PostParseVisitor
 
visit(Macro) - Method in class freemarker.template.PostParseVisitor
 
visit(MixedContent) - Method in class freemarker.template.PostParseVisitor
 
visit(MixedContent) - Method in class freemarker.template.WhitespaceAdjuster
 
visit(NoEscapeBlock) - Method in class freemarker.template.PostParseVisitor
 
visit(NumericalOutput) - Method in class freemarker.template.PostParseVisitor
 
visit(OOParamElement) - Method in class freemarker.template.PostParseVisitor
 
visit(OrExpression) - Method in class freemarker.template.PostParseVisitor
 
visit(PropertySetting) - Method in class freemarker.template.PostParseVisitor
 
visit(Range) - Method in class freemarker.template.PostParseVisitor
 
visit(ReturnInstruction) - Method in class freemarker.template.PostParseVisitor
 
visit(StringLiteral) - Method in class freemarker.template.PostParseVisitor
 
visit(SwitchBlock) - Method in class freemarker.template.PostParseVisitor
 
visit(TemplateHeaderElement) - Method in class freemarker.template.PostParseVisitor
 
visit(TextBlock) - Method in class freemarker.template.PostParseVisitor
 
visit(TextBlock) - Method in class freemarker.template.WhitespaceAdjuster
 
visit(TrimBlock) - Method in class freemarker.template.PostParseVisitor
 
visit(TrimInstruction) - Method in class freemarker.template.PostParseVisitor
 
visit(UnaryPlusMinusExpression) - Method in class freemarker.template.PostParseVisitor
 
visit(UnclosedElement) - Method in class freemarker.template.PostParseVisitor
 
visit(VarDirective) - Method in class freemarker.template.PostParseVisitor
 
visitMacroDef(Macro) - Method in class freemarker.core.Environment
 

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 resource template cache 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
 
WhitespaceAdjuster - Class in freemarker.template
 
WhitespaceAdjuster(Template) - Constructor for class freemarker.template.WhitespaceAdjuster
 
wrap(Object) - Method in class freemarker.template.DefaultObjectWrapper
 
wrap(Object) - Method in interface freemarker.template.ObjectWrapper
 
wrap(Object) - Method in class freemarker.template.WrappingTemplateModel
Wraps the passed object into a template model using this object's object wrapper, except that null is not wrapped but simply returned.
wrapDomNode(Object) - Method in class freemarker.template.DefaultObjectWrapper
 
WrappingTemplateModel - Class in freemarker.template
A base class for containers that wrap arbitrary Java objects into TemplateModel instances.
WrappingTemplateModel() - Constructor for class freemarker.template.WrappingTemplateModel
Protected constructor that creates a new wrapping template model using the default object wrapper.
WrappingTemplateModel(ObjectWrapper) - Constructor for class freemarker.template.WrappingTemplateModel
Protected constructor that creates a new wrapping template model using the specified object wrapper.
writeTemplateText(Writer) - Method in class freemarker.template.Template
 
writeTextAt(Writer, int, int, int, int) - Method in class freemarker.template.Template
 
WrongEncodingException(String) - Constructor for exception freemarker.template.Template.WrongEncodingException
 

_

__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 _ 
All Classes All Packages