Alphabetical Index

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

_

__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

accept(freemarker.core.Environment) - method in class freemarker.core.DebugBreak
accept(freemarker.core.Environment) - method in class freemarker.core.TextBlock
Simply outputs the text.
AdapterTemplateModel - interface freemarker.template.AdapterTemplateModel
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(Number,Number) - method in class freemarker.core.ArithmeticEngine
add(Number,Number) - method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
add(Object) - method in class freemarker.template.SimpleSequence
Adds an arbitrary object to the end of this SimpleSequence.
add_escapes(String) - method in class freemarker.core.ParseException
Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.
addAutoImport(String,String) - method in class freemarker.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.
addBreakpoint(freemarker.debug.Breakpoint) - method in class freemarker.debug.Debugger
Adds a breakpoint
Adds a listener for debugger events.
addImport(freemarker.core.LibraryLoad) - method in class freemarker.template.Template
Called by code internally to maintain a list of imports
addMacro(freemarker.core.Macro) - method in class freemarker.template.Template
Called by code internally to maintain a table of macros
addPrefixNSMapping(String,String) - method in class freemarker.template.Template
This is used internally.
addText(String) - method in class freemarker.ext.ant.JythonAntTask
afterBody() - method in class freemarker.template.TransformControl
Called after the body has been evaluated.
AllHttpScopesHashModel - class freemarker.ext.servlet.AllHttpScopesHashModel
An extension of SimpleHash that looks up keys in the hash, then in the request, session, and servlet context scopes.
ANGLE_BRACKET_TAG_SYNTAX - static field in class freemarker.template.Configuration
ARITHMETIC_ENGINE_KEY - static field in class freemarker.core.Configurable
ArithmeticEngine - class freemarker.core.ArithmeticEngine
Class to perform arithmetic operations.
ArrayModel - class freemarker.ext.beans.ArrayModel
A class that will wrap an arbitrary array into TemplateCollectionModel and TemplateSequenceModel interfaces.
ArrayModel(Object,freemarker.ext.beans.BeansWrapper) - constructor for class freemarker.ext.beans.ArrayModel
Creates a new model that wraps the specified array object.
attributeAdded(HttpSessionBindingEvent) - method in class freemarker.ext.jsp.EventForwarding
attributeRemoved(HttpSessionBindingEvent) - method in class freemarker.ext.jsp.EventForwarding
attributeReplaced(HttpSessionBindingEvent) - method in class freemarker.ext.jsp.EventForwarding
AUTO_DETECT_TAG_SYNTAX - static field in class freemarker.template.Configuration
AUTO_IMPORT_KEY - static field in class freemarker.template.Configuration
AUTO_INCLUDE_KEY - static field in class freemarker.template.Configuration

B

baseDir - field in class freemarker.cache.FileTemplateLoader
BeanModel - class freemarker.ext.beans.BeanModel
A class that will wrap an arbitrary object into TemplateHashModel interface allowing calls to arbitrary property getters and invocation of accessible methods on the object from a template using the object.foo to access properties and object.bar(arg1, arg2) to invoke methods on it.
BeanModel(Object,freemarker.ext.beans.BeansWrapper) - constructor for class freemarker.ext.beans.BeanModel
Creates a new model that wraps the specified object.
BEANS_WRAPPER - static field in class freemarker.template.ObjectWrapper
An ObjectWrapper that works similarly to SIMPLE_WRAPPER, but exposes the objects methods and JavaBeans properties as hash elements and custom handling for Java Maps, ResourceBundles, etc.
BeansWrapper - class freemarker.ext.beans.BeansWrapper
Utility class that provides generic services to reflection classes.
BeansWrapper() - constructor for class freemarker.ext.beans.BeansWrapper
Creates a new instance of BeansWrapper.
BIGDECIMAL_ENGINE - static field in class freemarker.core.ArithmeticEngine
Arithmetic engine that converts all numbers to BigDecimal and then operates on them.
This is the default arithmetic engine in FreeMarker.
BOOLEAN_FORMAT_KEY - static field in class freemarker.core.Configurable
BooleanModel - class freemarker.ext.beans.BooleanModel
A class that will wrap instances of java.lang.Boolean into a TemplateBooleanModel.
BooleanModel(Boolean,freemarker.ext.beans.BeansWrapper) - constructor for class freemarker.ext.beans.BooleanModel
Breakpoint - class freemarker.debug.Breakpoint
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 field in class freemarker.template.Configuration
CacheStorage - interface freemarker.cache.CacheStorage
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.
capitalize(String) - static method in class freemarker.template.utility.StringUtil
CaptureOutput - class freemarker.template.utility.CaptureOutput
A transform that captures the output of a block of FTL code and stores that in a variable.
children() - method in class freemarker.core.TemplateElement
chomp(String) - static method in class freemarker.template.utility.StringUtil
Removes the line-break from the end of the string.
CLASSIC_COMPATIBLE_KEY - static field in class freemarker.core.Configurable
ClassTemplateLoader - class freemarker.cache.ClassTemplateLoader
A TemplateLoader that uses streams reachable through Class.getResourceAsStream(String) as its source of templates.
ClassTemplateLoader() - constructor for class freemarker.cache.ClassTemplateLoader
Creates a template loader that will use the Class.getResource(String) method of its own class to load the resources, and "/" as base path.
ClassTemplateLoader(Class) - 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 "" as base path.
ClassTemplateLoader(Class,String) - constructor for class freemarker.cache.ClassTemplateLoader
Creates a template loader that will use the Class.getResource(String) method of the specified class to load the resources, and the specified base path (absolute or relative).
ClassUtil - class freemarker.template.utility.ClassUtil
clear() - method in class freemarker.cache.CacheStorage
clear() - method in class freemarker.template.EmptyMap
clear() - method in class freemarker.ext.util.IdentityHashMap
Removes all mappings from this map.
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 getTemplate(String,Locale,String,boolean) calls.
clearCache() - method in class freemarker.ext.util.ModelCache
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
clone() - method in class freemarker.ext.util.IdentityHashMap
Returns a shallow copy of this IdentityHashMap instance: the keys and values themselves are not cloned.
closeTemplateSource(Object) - method in class freemarker.cache.FileTemplateLoader
Closes the template source.
closeTemplateSource(Object) - method in class freemarker.cache.MultiTemplateLoader
Closes the template source.
closeTemplateSource(Object) - method in class freemarker.cache.StringTemplateLoader
Closes the template source.
closeTemplateSource(Object) - method in class freemarker.cache.TemplateLoader
Closes the template source.
closeTemplateSource(Object) - method in class freemarker.cache.URLTemplateLoader
Closes the template source.
closeTemplateSource(Object) - method in class freemarker.cache.WebappTemplateLoader
Closes the template source.
coerceBigDecimals(AccessibleObject,Object[]) - static method in class freemarker.ext.beans.BeansWrapper
Converts any BigDecimals in the passed array to the type of the corresponding formal argument of the method.
Add sequence capabilities to an existing collection, or vice versa.
CollectionModel - class freemarker.ext.beans.CollectionModel
A special case of BeanModel that can wrap Java collections and that implements the TemplateCollectionModel in order to be usable in a <foreach> block.
Creates a new model that wraps the specified collection object.
Collections12 - class freemarker.template.utility.Collections12
Implementation of missing JDK 1.3 collection features for JDK 1.2
columnNumber - field in class freemarker.core.ParseException
CommandLine - class freemarker.core.CommandLine
FreeMarker command-line utility, the Main-Class of freemarker.jar.
Comment - class freemarker.core.Comment
A template element where the content is ignored, a Comment.
compareNumbers(Number,Number) - method in class freemarker.core.ArithmeticEngine
compareTo(Object) - method in class freemarker.debug.Breakpoint
Configurable - class freemarker.core.Configurable
This is a common superclass of Configuration, Template, and Environment classes.
Configurable() - constructor for class freemarker.core.Configurable
Configurable(freemarker.core.Configurable) - constructor for class freemarker.core.Configurable
Creates a new instance.
Configuration - class freemarker.template.Configuration
Main entry point into the FreeMarker API, this class encapsulates the various configuration parameters with which FreeMarker is run, as well as serves as a central template loading and caching point.
Configuration() - constructor for class freemarker.template.Configuration
CONSERVATIVE_ENGINE - static field in class freemarker.core.ArithmeticEngine
Arithmetic engine that uses (more-or-less) the widening conversions of Java language to determine the type of result of operation, instead of converting everything to BigDecimal up front.
An arithmetic engine that conservatively widens the operation arguments to extent that they can hold the result of the operation.
Constants - class freemarker.template.utility.Constants
Frequently used constant TemplateModel values.
containingElements(int,int) - method in class freemarker.template.Template
contains(int,int) - method in class freemarker.core.TemplateObject
containsKey(Object) - method in class freemarker.template.EmptyMap
containsKey(Object) - method in class freemarker.ext.beans.HashAdapter
containsKey(Object) - method in class freemarker.ext.util.IdentityHashMap
Returns true if this map contains a mapping for the specified key.
containsValue(Object) - method in class freemarker.template.EmptyMap
containsValue(Object) - method in class freemarker.ext.util.IdentityHashMap
Returns true if this map maps one or more keys to the specified value.
contextDestroyed(ServletContextEvent) - method in class freemarker.ext.jsp.EventForwarding
contextInitialized(ServletContextEvent) - method in class freemarker.ext.jsp.EventForwarding
convertArray(Object) - method in class freemarker.template.DefaultObjectWrapper
Converts an array to a java.util.List
copyMap(Map) - method in class freemarker.template.SimpleHash
create() - method in class freemarker.core.CustomAttribute
This method is invoked when get() is invoked without set(Object) being invoked before it to define the value in the current scope.
Create a wrapping model for the specified object that belongs to the specified wrapper.
create(Object,Object) - method in class freemarker.ext.beans.BeansWrapper
createConfiguration() - method in class freemarker.ext.servlet.FreemarkerServlet
This method is called from init() to create the FreeMarker configuration object that this servlet will use for template loading.
createObjectWrapper() - method in class freemarker.ext.servlet.FreemarkerServlet
This method is called from init() to create the FreeMarker object wrapper object that this servlet will use for adapting request, session, and servlet context attributes into template models..
createProcessingEnvironment(Object,Writer) - method in class freemarker.template.Template
Same as createProcessingEnvironment(rootMap, out, null).
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.
currentToken - field in class freemarker.core.ParseException
This is the last token that has been consumed successfully.
CustomAttribute - class freemarker.core.CustomAttribute
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 field in class freemarker.template.TemplateDateModel
The date model represents a date-only value.
DATE_FORMAT_KEY - static field in class freemarker.core.Configurable
DateModel - class freemarker.ext.beans.DateModel
Wraps arbitrary subclass of java.util.Date into a reflective model.
DateModel(Date,freemarker.ext.beans.BeansWrapper) - constructor for class freemarker.ext.beans.DateModel
Creates a new model that wraps the specified date object.
DATETIME - static field in class freemarker.template.TemplateDateModel
The date model represents a datetime value.
DATETIME_FORMAT_KEY - static field in class freemarker.core.Configurable
debug - field in class freemarker.ext.servlet.FreemarkerServlet
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 field in class freemarker.template.TemplateExceptionHandler
This is a TemplateExceptionHandler used when you develop the templates.
DebugBreak - class freemarker.core.DebugBreak
DebugBreak(freemarker.core.TemplateElement) - constructor for class freemarker.core.DebugBreak
DebuggedEnvironment - interface freemarker.debug.DebuggedEnvironment
Represents the debugger-side mirror of a debugged Environment object in the remote VM.
Debugger - interface freemarker.debug.Debugger
The main debugger interface.
DebuggerClient - class freemarker.debug.DebuggerClient
A utility class that allows you to connect to the FreeMarker debugger service running on a specific host and port.
DebuggerListener - interface freemarker.debug.DebuggerListener
An interface for components that wish to receive debugging events.
DebugModel - interface freemarker.debug.DebugModel
Represents the debugger-side mirror of a TemplateModel object, a Template object, or a Configuration object.
deduceLocale(String) - static method in class freemarker.template.utility.StringUtil
Returns the locale used for the Configuration.getTemplate(String,Locale) call.
DeepUnwrap - class freemarker.template.utility.DeepUnwrap
Utility methods for unwrapping TemplateModel-s.
DEFAULT_ENCODING_KEY - static field in class freemarker.template.Configuration
DEFAULT_NAMESPACE_PREFIX - static field in class freemarker.template.Template
DEFAULT_PORT - static field in class freemarker.debug.Debugger
DEFAULT_WRAPPER - static field in class freemarker.template.ObjectWrapper
The default object wrapper implementation.
DefaultObjectWrapper - class freemarker.template.DefaultObjectWrapper
The default implementation of the ObjectWrapper interface.
divide(Number,Number) - method in class freemarker.core.ArithmeticEngine
doAfterBody() - method in class freemarker.ext.jsp.FreemarkerTag
doEndTag() - method in class freemarker.ext.jsp.FreemarkerTag
doGet(HttpServletRequest,HttpServletResponse) - method in class freemarker.ext.servlet.FreemarkerServlet
doInitBody() - method in class freemarker.ext.jsp.FreemarkerTag
DOMNodeModel - class freemarker.template.utility.DOMNodeModel
A convenient wrapper class for wrapping a Node in the W3C DOM API.
DOMNodeModel(Node) - constructor for class freemarker.template.utility.DOMNodeModel
doPost(HttpServletRequest,HttpServletResponse) - method in class freemarker.ext.servlet.FreemarkerServlet
doStartTag() - method in class freemarker.ext.jsp.FreemarkerTag
dump(PrintStream) - method in class freemarker.template.Template
Dump the raw template in canonical form.
dump(Writer) - method in class freemarker.template.Template
Dump the raw template in canonical form.

E

EMPTY_COLLECTION - static field in class freemarker.template.utility.Constants
EMPTY_HASH - static field in class freemarker.template.utility.Constants
EMPTY_ITERATOR - static field in class freemarker.template.utility.Constants
EMPTY_MAP - static field in class freemarker.template.utility.Collections12
EMPTY_SEQUENCE - static field in class freemarker.template.utility.Constants
EMPTY_STRING - static field in class freemarker.template.utility.Constants
EMPTY_STRING - static field in class freemarker.template.TemplateScalarModel
A constant value to use as the empty string.
EmptyMap - class freemarker.template.EmptyMap
END_EVALUATION - static field in class freemarker.template.TransformControl
Constant returned from afterBody() that tells the template engine to end the transform and close the writer.
entrySet() - method in class freemarker.template.EmptyMap
entrySet() - method in class freemarker.ext.beans.HashAdapter
entrySet() - method in class freemarker.ext.util.IdentityHashMap
Returns a collection view of the mappings contained in this map.
EnumerationModel - class freemarker.ext.beans.EnumerationModel
A class that adds TemplateModelIterator functionality to the Enumeration interface implementers.
Creates a new model that wraps the specified enumeration object.
Environment - class freemarker.core.Environment
Object that represents the runtime environment during template processing.
Called whenever an environment gets suspended (ie hits a breakpoint).
Event describing a suspension of an environment (ie because it hit a breakpoint).
eol - field in class freemarker.core.ParseException
The end of line string for this machine.
equals(Object) - method in class freemarker.debug.Breakpoint
equals(Object) - method in class freemarker.ext.dom.NodeModel
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 field in class freemarker.template.TransformControl
Constant returned from onStart() that tells the template engine to evaluate the body.
EventForwarding - class freemarker.ext.jsp.EventForwarding
An instance of this class should be registered as a <listener> in the web.xml descriptor in order to correctly dispatch events to event listeners that are specified in TLD files.
exec(List) - method in class freemarker.template.utility.Execute
Executes a method call.
exec(List) - method in class freemarker.ext.jython.JythonModel
exec(List) - method in class freemarker.ext.beans.MapModel
The first argument is used as a key to call the map's get method.
exec(List) - method in class freemarker.ext.jdom.NodeListModel
Applies an XPath expression to the node list and returns the resulting node list.
exec(List) - method in class freemarker.ext.xml.NodeListModel
Evaluates an XPath expression on XML nodes in this model.
exec(List) - method in class freemarker.ext.dom.NodeModel
exec(List) - method in class freemarker.template.utility.ObjectConstructor
exec(List) - method in class freemarker.ext.beans.ResourceBundleModel
Takes first argument as a resource key, looks up a string in resource bundle with this key, then applies a MessageFormat.format on the string with the rest of the arguments.
exec(List) - method in class freemarker.ext.rhino.RhinoFunctionModel
exec(List) - method in class freemarker.ext.beans.SimpleMapModel
exec(List) - method in class freemarker.template.TemplateMethodModel
Executes a method call.
Execute - class freemarker.template.utility.Execute
Gives FreeMarker the the ability to execute external commands.
execute() - method in class freemarker.ext.ant.FreemarkerXmlTask
execute(File,Map) - method in class freemarker.ext.ant.UnlinkedJythonOperationsImpl
execute(Map) - method in class freemarker.ext.ant.JythonAntTask
execute(String,Map) - method in class freemarker.ext.ant.UnlinkedJythonOperationsImpl
executeQuery(Object,String) - method in class freemarker.ext.dom.XPathSupport
expectedTokenSequences - field in class freemarker.core.ParseException
Each entry in this array is an array of integers.
EXPOSE_ALL - static field in class freemarker.ext.beans.BeansWrapper
At this level of exposure, all methods and properties of the wrapped objects are exposed to the template.
EXPOSE_NOTHING - static field in class freemarker.ext.beans.BeansWrapper
At this level of exposure, no bean properties and methods are exposed.
EXPOSE_PROPERTIES_ONLY - static field in class freemarker.ext.beans.BeansWrapper
At this level of exposure, only property getters are exposed.
EXPOSE_SAFE - static field in class freemarker.ext.beans.BeansWrapper
At this level of exposure, all methods and properties of the wrapped objects are exposed to the template except methods that are deemed not safe.
Expression - class freemarker.core.Expression
An abstract class for nodes in the parse tree that represent a FreeMarker expression.

F

FALSE - static field in class freemarker.template.utility.Constants
FALSE - static field in class freemarker.template.TemplateBooleanModel
A singleton object to represent boolean false
FileTemplateLoader - class freemarker.cache.FileTemplateLoader
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.
findTemplateSource(String) - method in class freemarker.cache.FileTemplateLoader
Finds the object that acts as the source of the template with the given name.
findTemplateSource(String) - method in class freemarker.cache.MultiTemplateLoader
Finds the object that acts as the source of the template with the given name.
findTemplateSource(String) - method in class freemarker.cache.StringTemplateLoader
Finds the object that acts as the source of the template with the given name.
findTemplateSource(String) - method in class 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
Finds the object that acts as the source of the template with the given name.
findTemplateSource(String) - method in class freemarker.cache.WebappTemplateLoader
Finds the object that acts as the source of the template with the given name.
format(String,Object[]) - method in class freemarker.ext.beans.ResourceBundleModel
Provides direct access to caching format engine from code (instead of from script).
forName(String) - static method in class freemarker.template.utility.ClassUtil
Similar to Class.forName(java.lang.String), but attempts to load through the thread context class loader.
Contains classes and interfaces that deal with template loading and caching.
freemarker.core - package
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.
An ant task that can be used to invoke the FreeMarker engine to generate documentation.
Provides model implementations that allow access to arbitrary Java objects.
Provides adapter for JDOM including support for writing XML fragments, listing nodes, traversal, copying, and filtering, and a full XPath support.
Classes for two-way FreeMarker-JSP integration.
Provides model implementations that allow access to arbitrary Jython objects.
Rhino (ECMAScript) support; Experimental: no backward compatibility guarantees; any feedback is highly welcome!
Provides a generic purpose servlet that generates dynamic response using FreeMarker.
Provides data model adapter for DOM, dom4j and JDOM; three widely used XML document object models.
freemarker.log - package
Provides the FreeMarker logging facility.
This package contains the core API's that most users will use.
Utility classes that may be used to customize aspects of FreeMarker.
FreemarkerServlet - class freemarker.ext.servlet.FreemarkerServlet
This is a general-purpose FreeMarker view servlet.
FreemarkerTag - class freemarker.ext.jsp.FreemarkerTag
Simple implementation of JSP tag to allow use of FreeMarker templates in JSP.
FreeMarkerTree - class freemarker.core.FreeMarkerTree
FreeMarkerTree(freemarker.template.Template) - constructor for class freemarker.core.FreeMarkerTree
FreemarkerXmlTask - class freemarker.ext.ant.FreemarkerXmlTask
This is an Ant task for transforming XML documents using FreeMarker templates.
FreemarkerXmlTask() - constructor for class freemarker.ext.ant.FreemarkerXmlTask
Constructor creates the SAXBuilder.
FTLStringLiteralDec(String) - static method in class freemarker.template.utility.StringUtil
FTL string literal decoding.
FTLStringLiteralEnc(String) - static method in class freemarker.template.utility.StringUtil

G

get() - method in class freemarker.core.CustomAttribute
get(freemarker.template.Template) - method in class freemarker.core.CustomAttribute
get(int) - method in class freemarker.ext.beans.ArrayModel
get(int) - method in class freemarker.core.CollectionAndSequence
Retrieves the i-th template model in this sequence.
get(int) - method in class freemarker.ext.beans.CollectionModel
Retrieves the i-th object from the collection, wrapped as a TemplateModel.
get(int) - method in class freemarker.debug.DebugModel
get(int) - method in class freemarker.ext.jython.JythonSequenceModel
Returns PyObject.__finditem__(int).
get(int) - method in class freemarker.ext.jdom.NodeListModel
Retrieves the i-th element of the node list.
get(int) - method in class freemarker.ext.xml.NodeListModel
Selects a single node from this model's nodelist by its list index and returns a new NodeListModel containing that single node.
get(int) - method in class freemarker.ext.dom.NodeModel
get(int) - method in class freemarker.ext.rhino.RhinoScriptableModel
get(int) - method in class freemarker.template.SimpleSequence
get(int) - method in class freemarker.core.StringArraySequence
get(int) - method in class freemarker.template.TemplateModelListSequence
Retrieves the i-th template model in this sequence.
get(int) - method in class freemarker.template.TemplateSequenceModel
Retrieves the i-th template model in this sequence.
get(int,int) - method in class freemarker.debug.DebugModel
get(Object) - method in class freemarker.cache.CacheStorage
get(Object) - method in class freemarker.template.EmptyMap
get(Object) - method in class freemarker.ext.beans.HashAdapter
get(Object) - method in class freemarker.ext.util.IdentityHashMap
Returns the value to which this map maps the specified 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.ext.servlet.AllHttpScopesHashModel
get(String) - method in class freemarker.ext.beans.BeanModel
Uses Beans introspection to locate a property or method with name matching the key name.
get(String) - method in class freemarker.debug.DebugModel
get(String) - method in class freemarker.template.utility.DOMNodeModel
get(String) - method in class freemarker.ext.servlet.HttpRequestHashModel
get(String) - method in class freemarker.ext.servlet.HttpRequestParametersHashModel
get(String) - method in class freemarker.ext.servlet.HttpSessionHashModel
get(String) - method in class freemarker.ext.jython.JythonModel
Calls PyObject.__findattr__(java.lang.String), then if it returns null calls PyObject.__finditem__(java.lang.String).
get(String) - method in class freemarker.ext.jdom.NodeListModel
Provides node list traversal as well as special functions: filtering by name, filtering by node type, shallow-copying, and duplicate removal.
get(String) - method in class freemarker.ext.xml.NodeListModel
Returns a new NodeListModel containing the nodes that result from applying an operator to this model's nodes.
get(String) - method in class freemarker.ext.dom.NodeModel
get(String) - method in class freemarker.ext.rhino.RhinoScriptableModel
get(String) - method in class freemarker.ext.servlet.ServletContextHashModel
Gets a TemplateModel from the hash.
get(String) - method in class freemarker.template.SimpleHash
get(String) - method in class freemarker.ext.beans.SimpleMapModel
get(String) - method in class freemarker.ext.jsp.TaglibFactory
Retrieves a JSP tag library identified by an URI.
get(String) - method in class freemarker.template.TemplateHashModel
Gets a TemplateModel from the hash.
get(String[]) - method in class freemarker.debug.DebugModel
getAdaptedObject(Class) - method in class freemarker.template.AdapterTemplateModel
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.
getAdaptedObject(Class) - method in class freemarker.ext.beans.BeanModel
getAdaptedObject(Class) - method in class freemarker.ext.jython.JythonModel
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.
getAdaptedObject(Class) - method in class freemarker.ext.dom.NodeModel
getAdaptedObject(Class) - method in class freemarker.ext.rhino.RhinoScriptableModel
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.
getAdaptedObject(Class) - method in class freemarker.ext.beans.SimpleMapModel
getAllowsChildren() - method in class freemarker.core.TemplateElement
getArgumentNames() - method in class freemarker.core.Macro
getArithmeticEngine() - method in class freemarker.core.Configurable
Retrieves the arithmetic engine used to perform arithmetic operations.
getAsBoolean() - method in class freemarker.ext.beans.BooleanModel
getAsBoolean() - method in class freemarker.debug.DebugModel
getAsBoolean() - method in class freemarker.ext.beans.EnumerationModel
Returns Enumeration.hasMoreElements().
getAsBoolean() - method in class freemarker.ext.beans.IteratorModel
Returns Iterator.hasNext().
getAsBoolean() - method in class freemarker.ext.jython.JythonModel
Returns the value of PyObject.__nonzero__().
getAsBoolean() - method in class freemarker.template.TemplateBooleanModel
getAsDate() - method in class freemarker.ext.beans.DateModel
getAsDate() - method in class freemarker.debug.DebugModel
getAsDate() - method in class freemarker.template.SimpleDate
getAsDate() - method in class freemarker.template.TemplateDateModel
Returns the date value.
getAsNumber() - method in class freemarker.debug.DebugModel
getAsNumber() - method in class freemarker.ext.jython.JythonNumberModel
Returns either PyObject.__tojava__(java.lang.Class) with java.lang.Number.class as argument.
getAsNumber() - method in class freemarker.ext.beans.NumberModel
getAsNumber() - method in class freemarker.template.SimpleNumber
getAsNumber() - method in class freemarker.template.TemplateNumberModel
Returns the numeric value.
getAsString() - method in class freemarker.debug.DebugModel
getAsString() - method in class freemarker.ext.jython.JythonModel
Returns the value of Object.toString().
getAsString() - method in class freemarker.template.LocalizedString
Returns the string representation of this model.
getAsString() - method in class freemarker.ext.jdom.NodeListModel
This method returns the string resulting from concatenation of string representations of its nodes.
getAsString() - method in class freemarker.ext.xml.NodeListModel
Returns the string representation of the wrapped nodes.
getAsString() - method in class freemarker.template.SimpleScalar
Returns the string representation of this model.
getAsString() - method in class freemarker.ext.beans.StringModel
Returns the result of calling Object.toString() on the wrapped object.
getAsString() - method in class freemarker.template.TemplateScalarModel
Returns the string representation of this model.
getBeginColumn() - method in class freemarker.core.TemplateObject
getBeginLine() - method in class freemarker.core.TemplateObject
getBooleanFormat() - method in class freemarker.core.Configurable
getBreakpoints() - method in class freemarker.debug.Debugger
Retrieves a list of all Breakpoint objects.
getBreakpoints(String) - method in class freemarker.debug.Debugger
Retrieves a list of all Breakpoint objects for the specified template.
getBundle() - method in class freemarker.ext.beans.ResourceBundleModel
getCacheStorage() - method in class freemarker.cache.TemplateCache
getCaching() - method in class freemarker.ext.jsp.FreemarkerTag
getCanonicalForm() - method in class freemarker.core.Comment
getCanonicalForm() - method in class freemarker.core.DebugBreak
getCanonicalForm() - method in class freemarker.core.LibraryLoad
getCanonicalForm() - method in class freemarker.core.Macro
getCanonicalForm() - method in class freemarker.core.ReturnInstruction
getCanonicalForm() - method in class freemarker.core.TemplateObject
getCanonicalForm() - method in class freemarker.core.TextBlock
getCatchAll() - method in class freemarker.core.Macro
getCause() - method in class freemarker.template.TemplateException
Returns the same exception as getCauseException.
getCauseException() - method in class freemarker.template.TemplateException
Returns the underlying exception that caused this exception to be generated.
getChildAt(int) - method in class freemarker.core.TemplateElement
getChildCount() - method in class freemarker.core.TemplateElement
getChildNodes() - method in class freemarker.ext.xml.NodeListModel
getChildNodes() - method in class freemarker.ext.dom.NodeModel
getChildNodes() - method in class freemarker.core.TemplateElement
getChildNodes() - method in class freemarker.template.TemplateNodeModel
getCollection() - method in class freemarker.debug.DebugModel
getColumnNumber() - method in class freemarker.core.ParseException
getConfiguration() - method in class freemarker.core.Environment
getConfiguration() - method in class freemarker.ext.servlet.FreemarkerServlet
Returns the Configuration object used by this servlet.
getConfiguration() - method in class freemarker.template.Template
Returns the Configuration object associated with this template.
getCurrentEnvironment() - static method in class freemarker.core.Environment
Retrieves the environment object associated with the current thread.
getCurrentNamespace() - method in class freemarker.core.Environment
Returns the main name-space.
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.
getDateTimeFormat() - method in class freemarker.core.Configurable
Returns the date format used to convert date models representing datetime dates to strings.
getDateType() - method in class freemarker.ext.beans.DateModel
getDateType() - method in class freemarker.debug.DebugModel
getDateType() - method in class freemarker.template.SimpleDate
getDateType() - method in class freemarker.template.TemplateDateModel
Returns the type of the date.
getDebugger(InetAddress,int,String) - static method in class freemarker.debug.DebuggerClient
Connects to the FreeMarker debugger service running on a specific host and port.
getDefaultConfiguration() - static method in class freemarker.template.Configuration
Returns the default (singleton) Configuration object.
getDefaultDateType() - method in class freemarker.ext.beans.BeansWrapper
getDefaultEncoding() - method in class freemarker.template.Configuration
Gets the default encoding for converting bytes to characters when reading template files in a locale for which no explicit encoding was specified.
getDefaultInstance() - static method in class freemarker.ext.beans.BeansWrapper
Returns the default instance of the wrapper.
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.
getDescription() - method in class freemarker.core.Comment
getDescription() - method in class freemarker.core.DebugBreak
getDescription() - method in class freemarker.core.LibraryLoad
getDescription() - method in class freemarker.core.Macro
getDescription() - method in class freemarker.core.ReturnInstruction
getDescription() - method in class freemarker.core.TemplateElement
getDescription() - method in class freemarker.core.TextBlock
getDocumentBuilderFactory() - static method in class freemarker.ext.dom.NodeModel
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.
getEndColumn() - method in class freemarker.core.TemplateObject
getEndLine() - method in class freemarker.core.TemplateObject
getEndLocation() - method in class freemarker.core.TemplateObject
getEnumModels() - method in class freemarker.ext.beans.BeansWrapper
Returns a hash model that represents the so-called class enum models.
getEnvironment() - method in class freemarker.core.Configurable
getEnvironment() - method in class freemarker.debug.EnvironmentSuspendedEvent
The environment that was suspended
getEnvironment() - method in class freemarker.template.TemplateException
getFTLInstructionStack() - method in class freemarker.template.TemplateException
Returns the quote of the problematic FTL instruction and the FTL stack strace.
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.
getGlobalVariable(String) - method in class freemarker.core.Environment
Returns the globally visible variable of the given name (or null).
getGlobalVariables() - method in class freemarker.core.Environment
Returns the read-only hash of globally visible variables.
getId() - method in class freemarker.debug.DebuggedEnvironment
Returns a unique identifier for this environment
getImports() - method in class freemarker.template.Template
getIndex(TreeNode) - method in class freemarker.core.TemplateElement
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
Returns the time of last modification of the specified template source.
getLastModified(Object) - method in class freemarker.cache.MultiTemplateLoader
Returns the time of last modification of the specified template source.
getLastModified(Object) - method in class freemarker.cache.StringTemplateLoader
Returns the time of last modification of the specified template source.
getLastModified(Object) - method in class freemarker.cache.TemplateLoader
Returns the time of last modification of the specified template source.
getLastModified(Object) - method in class freemarker.cache.URLTemplateLoader
Returns the time of last modification of the specified template source.
getLastModified(Object) - method in class freemarker.cache.WebappTemplateLoader
Returns the time of last modification of the specified template source.
getLine() - method in class freemarker.debug.Breakpoint
Returns the line number of the breakpoint
getLine() - method in class freemarker.debug.EnvironmentSuspendedEvent
The line number in the template where the execution of the environment was suspended.
getLineNumber() - method in class freemarker.core.ParseException
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.template.Configuration
Returns if localized template lookup is enabled or not.
getLocalizedLookup() - method in class freemarker.cache.TemplateCache
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
getLocalVariable(String) - method in class freemarker.core.Environment
Returns the loop or macro local variable corresponding to this variable name.
getLocalVariable(String) - method in class freemarker.core.LocalContext
getLocalVariableNames() - method in class freemarker.core.LocalContext
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.
getMacros() - method in class freemarker.template.Template
getMainNamespace() - method in class freemarker.core.Environment
Returns the main name-space.
getMessage() - method in class freemarker.core.ParseException
This method has the standard behavior when this object has been created using the standard constructors.
getModelTypes() - method in class freemarker.debug.DebugModel
getName() - method in class freemarker.core.Macro
getName() - method in class freemarker.template.Template
The path of the template file relative to the directory what you use to store the templates.
getNamespace(String) - method in class freemarker.core.Environment
Returns the name-space for the name if exists, or null.
getNamespaceForPrefix(String) - method in class freemarker.core.Environment
getNamespaceForPrefix(String) - method in class freemarker.template.Template
getNode() - method in class freemarker.ext.dom.NodeModel
getNodeName() - method in class freemarker.ext.xml.NodeListModel
getNodeName() - method in class freemarker.core.TemplateElement
getNodeName() - method in class freemarker.template.TemplateNodeModel
getNodeNamespace() - method in class freemarker.ext.xml.NodeListModel
getNodeNamespace() - method in class freemarker.ext.dom.NodeModel
getNodeNamespace() - method in class freemarker.core.TemplateElement
getNodeNamespace() - method in class freemarker.template.TemplateNodeModel
getNodeType() - method in class freemarker.ext.xml.NodeListModel
getNodeType() - method in class freemarker.ext.dom.NodeModel
getNodeType() - method in class freemarker.core.TemplateElement
getNodeType() - method in class freemarker.template.TemplateNodeModel
getNumberFormat() - method in class freemarker.core.Configurable
Returns the default number format used to convert numbers to strings.
getObjectWrapper() - method in class freemarker.core.Configurable
Retrieves the object wrapper used to wrap objects to template models.
getObjectWrapper() - method in class freemarker.ext.servlet.FreemarkerServlet
getObjectWrapper() - method in class freemarker.ext.servlet.HttpRequestHashModel
getObjectWrapper() - method in class freemarker.template.WrappingTemplateModel
Returns the object wrapper instance used by this wrapping template model.
getOut() - method in class freemarker.core.Environment
getOuterIdentity() - method in class freemarker.ext.beans.BeansWrapper
By default returns this.
getOutputEncoding() - method in class freemarker.core.Configurable
getParent() - method in class freemarker.core.Configurable
Returns the parent Configurable object of this object.
getParent() - method in class freemarker.ext.jsp.FreemarkerTag
getParent() - method in class freemarker.core.TemplateElement
getParentNode() - method in class freemarker.ext.xml.NodeListModel
getParentNode() - method in class freemarker.ext.dom.NodeModel
getParentNode() - method in class freemarker.core.TemplateElement
getParentNode() - method in class freemarker.template.TemplateNodeModel
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
Returns the character stream of a template represented by the specified template source.
getReader(Object,String) - method in class freemarker.cache.MultiTemplateLoader
Returns the character stream of a template represented by the specified template source.
getReader(Object,String) - method in class freemarker.cache.StringTemplateLoader
Returns the character stream of a template represented by the specified template source.
getReader(Object,String) - method in class 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
Returns the character stream of a template represented by the specified template source.
getReader(Object,String) - method in class freemarker.cache.WebappTemplateLoader
Returns the character stream of a template represented by the specified template source.
getRequest() - method in class freemarker.ext.servlet.HttpRequestHashModel
getResponse() - method in class freemarker.ext.servlet.HttpRequestHashModel
getRootTreeNode() - method in class freemarker.template.Template
getServlet() - method in class freemarker.ext.servlet.ServletContextHashModel
Returns the underlying servlet.
getSetting(String) - method in class freemarker.core.Configurable
Returns the textual representation of a setting.
getSettings() - method in class freemarker.core.Configurable
This meant to return the String-to-String Map of the settings.
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() - method in class freemarker.core.TemplateObject
getSource(int,int,int,int) - method in class freemarker.template.Template
Returns the template source at the location specified by the coordinates given.
getStartLocation() - method in class freemarker.core.TemplateObject
Returns a string that indicates where in the template source, this object is.
getStaticModels() - method in class freemarker.ext.beans.BeansWrapper
Returns a hash model that represents the so-called class static models.
getStrictSyntaxMode() - method in class freemarker.template.Configuration
Tells whether directives such as if, else, etcetera must be written as #if, #else, etcetera.
getSuspendedEnvironments() - method in class freemarker.debug.Debugger
Retrieves a collection of all DebuggedEnvironment objects that are currently suspended.
getSystemProperty(String) - static method in class freemarker.template.utility.SecurityUtilities
getSystemProperty(String,int) - static method in class freemarker.template.utility.SecurityUtilities
getSystemProperty(String,String) - static method in class freemarker.template.utility.SecurityUtilities
getTagSyntax() - method in class freemarker.template.Configuration
getTemplate() - method in class freemarker.core.Environment
Retrieves the currently processed template.
getTemplate() - method in class freemarker.core.Environment.Namespace
getTemplate() - method in class freemarker.core.TemplateObject
getTemplate(String) - method in class freemarker.template.Configuration
Equivalent to getTemplate(name, thisCfg.getLocale(), thisCfg.getEncoding(thisCfg.getLocale()), 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.template.Configuration
Retrieves a template specified by a name and locale, interpreted using the specified character encoding, either parsed or unparsed.
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,String) - method in class freemarker.template.Configuration
Equivalent to getTemplate(name, thisCfg.getLocale(), encoding, true).
getTemplateExceptionHandler() - method in class freemarker.core.Configurable
Retrieves the exception handler used to handle template exceptions.
getTemplateForImporting(String) - method in class freemarker.core.Environment
Gets a template for importing; used with importLib(Template importedTemplate, String namespace).
Gets a template for inclusion; used with include(Template includedTemplate).
getTemplateLoader() - method in class freemarker.template.Configuration
getTemplateLoader() - method in class freemarker.cache.TemplateCache
getTemplateModel() - method in class freemarker.ext.beans.HashAdapter
getTemplateModel() - method in class freemarker.template.TemplateModelAdapter
getTemplateName() - method in class freemarker.debug.Breakpoint
Returns the template name of the breakpoint
getTemplateName() - method in class freemarker.core.LibraryLoad
getTemplatePath() - method in class freemarker.ext.servlet.FreemarkerServlet
getText() - method in class freemarker.core.Comment
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.
getUndeclaredThrowable() - method in class freemarker.template.utility.UndeclaredThrowableException
getURL(String) - method in class freemarker.cache.ClassTemplateLoader
Given a template name (plus potential locale decorations) retrieves an URL that points the template source.
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 number string.
getWhitespaceStripping() - method in class freemarker.template.Configuration
Gets whether the FTL parser will try to remove superfluous white-space around certain FTL tags.
getWrappedObject() - method in class freemarker.ext.beans.BeanModel
getWrappedObject() - method in class freemarker.ext.jython.JythonModel
Retrieves the object wrapped by this model.
getWrappedObject() - method in class freemarker.ext.dom.NodeModel
getWrappedObject() - method in class freemarker.ext.beans.SimpleMapModel
getWrappedObject() - method in class freemarker.template.TemplateModelListSequence
getWrappedObject() - method in class freemarker.ext.util.WrapperTemplateModel
Retrieves the object wrapped by this model.
getWriter(Writer,Map) - method in class freemarker.template.utility.CaptureOutput
getWriter(Writer,Map) - method in class freemarker.template.utility.HtmlEscape
getWriter(Writer,Map) - method in class freemarker.template.utility.JythonRuntime
Returns a writer that will be used by the engine to feed the transformation input to the transform.
getWriter(Writer,Map) - method in class freemarker.template.utility.NormalizeNewlines
getWriter(Writer,Map) - method in class freemarker.template.utility.StandardCompress
getWriter(Writer,Map) - method in class freemarker.template.TemplateTransformModel
Returns a writer that will be used by the engine to feed the transformation input to the transform.
getWriter(Writer,Map) - method in class freemarker.template.utility.XmlEscape
getXPathSupportClass() - static method in class freemarker.ext.dom.NodeModel
Get the currently used freemarker.ext.dom.XPathSupport used as the XPath engine.
getYesNo(String) - static method in class freemarker.template.utility.StringUtil

H

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.
HashAdapter - class freemarker.ext.beans.HashAdapter
hashCode() - method in class freemarker.debug.Breakpoint
hashCode() - method in class freemarker.ext.dom.NodeModel
hasNext() - method in class freemarker.ext.beans.EnumerationModel
Calls underlying Enumeration.nextElement().
hasNext() - method in class freemarker.ext.beans.IteratorModel
Calls underlying Iterator.hasNext().
hasNext() - method in class freemarker.template.TemplateModelIterator
hasPlainGetMethod() - method in class freemarker.ext.beans.BeanModel
Whether the model has a plain get(String) or get(Object) method
HTML_DEBUG_HANDLER - static field in class freemarker.template.TemplateExceptionHandler
This is a TemplateExceptionHandler used when you develop HTML templates.
HTMLEnc(String) - static method in class freemarker.template.utility.StringUtil
HTML encoding (does not convert line breaks).
HtmlEscape - class freemarker.template.utility.HtmlEscape
Performs an HTML escape of a given template fragment.
HttpRequestHashModel - class freemarker.ext.servlet.HttpRequestHashModel
TemplateHashModel wrapper for a HttpServletRequest attributes.
TemplateHashModel wrapper for a HttpServletRequest parameters.
HttpSessionHashModel - class freemarker.ext.servlet.HttpSessionHashModel
TemplateHashModel wrapper for a HttpSession attributes.
Use this constructor when the session isn't already created.
Use this constructor when the session already exists.

I

IdentityHashMap - class freemarker.ext.util.IdentityHashMap
A variant of java.util.HashMap that uses System.identityHashCode(Object) for hashing, and reference comparison instead of Object.equals(Object).
IdentityHashMap() - constructor for class freemarker.ext.util.IdentityHashMap
Constructs a new, empty map with a default capacity and load factor, which is 0.75.
IdentityHashMap(int) - constructor for class freemarker.ext.util.IdentityHashMap
Constructs a new, empty map with the specified initial capacity and default load factor, which is 0.75.
IdentityHashMap(int,float) - constructor for class freemarker.ext.util.IdentityHashMap
Constructs a new, empty map with the specified initial capacity and the specified load factor.
IdentityHashMap(Map) - constructor for class freemarker.ext.util.IdentityHashMap
Constructs a new map with the same mappings as the given map.
IGNORE_HANDLER - static field in class freemarker.template.TemplateExceptionHandler
This is a TemplateExceptionHandler which simply skips errors.
Emulates import directive.
importLib(String,String) - method in class freemarker.core.Environment
Emulates import directive, except that name must be tempate root relative.
include(freemarker.template.Template) - 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.
info(String) - method in class freemarker.log.Logger
Logs an informational message.
info(String,Throwable) - method in class freemarker.log.Logger
Logs an informational message with accompanying throwable.
init() - method in class freemarker.ext.servlet.FreemarkerServlet
Called when servlet detects in a request processing that application-global (that is, ServletContext-specific) attributes are not yet set.
Called when servlet detects in a request processing that session-global (that is, HttpSession-specific) attributes are not yet set.
insertDefaults(Map) - method in class freemarker.ext.ant.FreemarkerXmlTask
instance - static field in class freemarker.template.EmptyMap
INSTANCE - static field in class freemarker.ext.jython.JythonWrapper
INSTANCE - static field in class freemarker.template.utility.StandardCompress
An exception thrown when there is an attempt to access an invalid bean property when we are in a "strict bean" mode
InvalidPropertyException(String) - constructor for class freemarker.ext.beans.InvalidPropertyException
Constructs a TemplateModelException with the specified detail message.
A subclass of TemplateException that says there is no value associated with a given expression.
invokeGenericGet(Map,Class,String) - method in class freemarker.ext.beans.BeanModel
invokeGenericGet(Map,Class,String) - method in class freemarker.ext.beans.MapModel
Overridden to invoke the generic get method by casting to Map instead of through reflection - should yield better performance.
invokeGenericGet(Map,Class,String) - method in class freemarker.ext.beans.ResourceBundleModel
Overridden to invoke the getObject method of the resource bundle.
isClassicCompatible() - method in class freemarker.core.Configurable
Returns whether the engine runs in the "Classic Compatibile" mode.
isDebugEnabled() - method in class freemarker.log.Logger
Returns true if this logger will log debug messages.
isEmpty() - method in class freemarker.ext.beans.ArrayModel
Tells whether the model is empty.
isEmpty() - method in class freemarker.ext.beans.BeanModel
Tells whether the model is empty.
isEmpty() - method in class freemarker.template.utility.DOMNodeModel
isEmpty() - method in class freemarker.template.EmptyMap
isEmpty() - method in class freemarker.ext.beans.HashAdapter
isEmpty() - method in class freemarker.ext.servlet.HttpRequestHashModel
isEmpty() - method in class freemarker.ext.servlet.HttpRequestParametersHashModel
isEmpty() - method in class freemarker.ext.servlet.HttpSessionHashModel
isEmpty() - method in class freemarker.ext.util.IdentityHashMap
Returns true if this map contains no key-value mappings.
isEmpty() - method in class freemarker.ext.jython.JythonModel
Returns PyObject.__len__() == 0.
isEmpty() - method in class freemarker.ext.beans.MapModel
Tells whether the model is empty.
isEmpty() - method in class freemarker.ext.jdom.NodeListModel
Returns true if this model contains no nodes.
isEmpty() - method in class freemarker.ext.xml.NodeListModel
Returns true if this NodeListModel contains no nodes.
isEmpty() - method in class freemarker.ext.beans.ResourceBundleModel
Returns true if this bundle contains no objects.
isEmpty() - method in class freemarker.ext.rhino.RhinoScriptableModel
isEmpty() - method in class freemarker.ext.servlet.ServletContextHashModel
isEmpty() - method in class freemarker.template.SimpleHash
isEmpty() - method in class freemarker.ext.beans.SimpleMapModel
isEmpty() - method in class freemarker.ext.jsp.TaglibFactory
Returns false.
isEmpty() - method in class freemarker.template.TemplateHashModel
isErrorEnabled() - method in class freemarker.log.Logger
Returns true if this logger will log error messages.
isExposeFields() - method in class freemarker.ext.beans.BeansWrapper
isFatalEnabled() - method in class freemarker.log.Logger
Returns true if this logger will log fatal error messages.
isFunction() - method in class freemarker.core.Macro
isInfoEnabled() - method in class freemarker.log.Logger
Returns true if this logger will log informational messages.
isLeaf() - method in class freemarker.core.TemplateElement
isSimpleMapWrapper() - method in class freemarker.ext.beans.BeansWrapper
isStrict() - method in class freemarker.ext.beans.BeansWrapper
isWarnEnabled() - method in class freemarker.log.Logger
Returns true if this logger will log warning messages.
isXMLID(String) - static method in class freemarker.template.utility.StringUtil
iterator() - method in class freemarker.ext.beans.ArrayModel
iterator() - method in class freemarker.core.CollectionAndSequence
Retrieves a template model iterator that is used to iterate over the elements in this collection.
iterator() - method in class freemarker.ext.beans.CollectionModel
Retrieves a template model iterator that is used to iterate over the elements in this collection.
iterator() - method in class freemarker.ext.beans.EnumerationModel
This allows the enumeration to be used in a <foreach> block.
iterator() - method in class freemarker.ext.beans.IteratorModel
This allows the iterator to be used in a <foreach> block.
iterator() - method in class freemarker.ext.jython.JythonSequenceModel
iterator() - method in class freemarker.ext.jdom.NodeListModel
Retrieves a template model iterator that is used to iterate over the elements in this collection.
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 class freemarker.template.TemplateCollectionModel
Retrieves a template model iterator that is used to iterate over the elements in this collection.
IteratorModel - class freemarker.ext.beans.IteratorModel
A class that adds TemplateModelIterator functionality to the Iterator interface implementers.
Creates a new model that wraps the specified iterator object.

J

javaScriptStringEnc(String) - static method in class freemarker.template.utility.StringUtil
Escapes a String according the JavaScript string literal escaping rules.
javaStringEnc(String) - static method in class freemarker.template.utility.StringUtil
Escapes the String with the escaping rules of Java language string literals, so it is safe to insert the value into a string literal.
jQuote(String) - static method in class freemarker.template.utility.StringUtil
Quotes string as Java Language string literal.
JythonAntTask - class freemarker.ext.ant.JythonAntTask
Used internally, public for technical reasons only.
JythonHashModel - class freemarker.ext.jython.JythonHashModel
Model for Jython dictionaries (org.python.core.PyDictionary and org.python.core.PyStringMap).
JythonModel - class freemarker.ext.jython.JythonModel
Generic model for arbitrary Jython objects.
JythonModel(PyObject,freemarker.ext.jython.JythonWrapper) - constructor for class freemarker.ext.jython.JythonModel
JythonNumberModel - class freemarker.ext.jython.JythonNumberModel
Model for Jython numeric objects (org.python.core.PyInteger, org.python.core.PyLong, org.python.core.PyFloat).
JythonRuntime - class freemarker.template.utility.JythonRuntime
A crude first pass at an embeddable Jython interpreter
JythonSequenceModel - class freemarker.ext.jython.JythonSequenceModel
Model for Jython sequence objects (org.python.core.PySequence descendants).
JythonWrapper - class freemarker.ext.jython.JythonWrapper
An object wrapper that wraps Jython objects into FreeMarker template models and vice versa.
JythonWrapper() - constructor for class freemarker.ext.jython.JythonWrapper

K

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

L

leftPad(String,int) - static method in class freemarker.template.utility.StringUtil
Pads the string at the left with spaces until it reaches the desired length.
leftPad(String,int,char) - static method in class freemarker.template.utility.StringUtil
Pads the string at the left with the specified character until it reaches the desired length.
leftPad(String,int,String) - static method in class freemarker.template.utility.StringUtil
Pads the string at the left with a filling pattern until it reaches the desired length.
LIBRARY_AUTO - static field in class freemarker.log.Logger
Constant used with selectLoggerLibrary(int) that indicates the engine should automatically lookup and use any available logger library.
LIBRARY_AVALON - static field in class freemarker.log.Logger
Constant used with selectLoggerLibrary(int) that indicates the engine should use the Apache Jakarta Avalon LogKit logger package.
LIBRARY_JAVA - static field in class freemarker.log.Logger
Constant used with selectLoggerLibrary(int) that indicates the engine should use the java.util.logging logger package.
LIBRARY_LOG4J - static field in class freemarker.log.Logger
Constant used with selectLoggerLibrary(int) that indicates the engine should use the Apache Jakarta Log4J logger package.
LIBRARY_NONE - static field in class freemarker.log.Logger
Constant used with selectLoggerLibrary(int) that indicates the engine should use no logger package (i.e.
LibraryLoad - class freemarker.core.LibraryLoad
An instruction that gets another template and processes it within the current template.
lineNumber - field in class freemarker.core.ParseException
list - field in class freemarker.template.SimpleSequence
loadBuiltInEncodingMap() - method in class freemarker.template.Configuration
Loads a preset language-to-encoding map.
LocalContext - interface freemarker.core.LocalContext
An interface that represents a local context.
LOCALE_KEY - static field in class freemarker.core.Configurable
LOCALIZED_LOOKUP_KEY - static field in class freemarker.template.Configuration
LocalizedString - class freemarker.template.LocalizedString
An abstract base class for scalars that vary by locale.
Logger - class freemarker.log.Logger
The FreeMarker logging facility.

M

Macro - class freemarker.core.Macro
An element representing a macro declaration.
main(String[]) - static method in class freemarker.core.CommandLine
main(String[]) - static method in class freemarker.ext.jdom.NodeListModel
Loads a template from a file passed as the first argument, loads an XML document from the standard input, passes it to the template as variable document and writes the result of template processing to standard output.
main(String[]) - static method in class freemarker.template.utility.ToCanonical
main(String[]) - static method in class freemarker.ext.dom.Transform
A convenient main() method for command-line invocation.
MapModel - class freemarker.ext.beans.MapModel
A special case of BeanModel that adds implementation for TemplateMethodModelEx on map objects that is a shortcut for the Map.get() method.
MapModel(Map,freemarker.ext.beans.BeansWrapper) - constructor for class freemarker.ext.beans.MapModel
Creates a new model that wraps the specified map object.
matchesName(String,String,String,freemarker.core.Environment) - static method in class freemarker.template.utility.StringUtil
maxScale - field in class freemarker.core.ArithmeticEngine
mergeAdjacentText(Node) - static method in class freemarker.ext.dom.NodeModel
Merges adjacent text/cdata nodes, so that there are no adjacent text/cdata nodes.
minScale - field in class freemarker.core.ArithmeticEngine
MINUS_ONE - static field in class freemarker.template.utility.Constants
ModelCache - class freemarker.ext.util.ModelCache
Internally used by various wrapper implementations to implement model caching.
ModelCache(freemarker.template.ObjectWrapper) - constructor for class freemarker.ext.util.ModelCache
ModelFactory - interface freemarker.ext.util.ModelFactory
Internal interface used to create various wrapper models in the ModelCache.
modulus(Number,Number) - method in class freemarker.core.ArithmeticEngine
MruCacheStorage - class freemarker.cache.MruCacheStorage
A cache storage that implements a two-level Most Recently Used cache.
MruCacheStorage(int,int) - constructor for class freemarker.cache.MruCacheStorage
Creates a new MRU cache storage with specified maximum cache sizes.
multiply(Number,Number) - method in class freemarker.core.ArithmeticEngine
MultiTemplateLoader - class freemarker.cache.MultiTemplateLoader
A TemplateLoader that uses a set of other loaders to load the templates.
Creates a new multi template Loader that will use the specified loaders.

N

newInstance(Class,List) - method in class freemarker.ext.beans.BeansWrapper
next() - method in class freemarker.ext.beans.EnumerationModel
Calls underlying Enumeration.nextElement() and wraps the result.
next() - method in class freemarker.ext.beans.IteratorModel
Calls underlying Iterator.next() and wraps the result.
next() - method in class freemarker.template.TemplateModelIterator
Returns the next model.
NO_NS_PREFIX - static field in class freemarker.template.Template
NodeListModel - class freemarker.ext.jdom.NodeListModel
Provides a template for wrapping JDOM objects.
NodeListModel - class freemarker.ext.xml.NodeListModel
A data model adapter for three widespread XML document object model representations: W3C DOM, dom4j, and JDOM.
NodeListModel(Document) - constructor for class freemarker.ext.jdom.NodeListModel
Creates a node list that holds a single Document node.
NodeListModel(Element) - constructor for class freemarker.ext.jdom.NodeListModel
Creates a node list that holds a single Element node.
NodeListModel(List) - constructor for class freemarker.ext.jdom.NodeListModel
Creates a node list that holds a list of nodes.
NodeListModel(List,boolean) - constructor for class freemarker.ext.jdom.NodeListModel
Creates a node list that holds a list of nodes.
NodeListModel(Object) - constructor for class freemarker.ext.xml.NodeListModel
Creates a new NodeListModel, wrapping the passed nodes.
NodeModel - class freemarker.ext.dom.NodeModel
A base class for wrapping a W3C DOM Node as a FreeMarker template model.
NodeModel(Node) - constructor for class freemarker.ext.dom.NodeModel
A subclass of TemplateException that indicates that the internals expected an expression to evaluate to a boolean value and it didn't.
A subclass of TemplateException that indicates that the internals expected an expression to evaluate to a numerical value and it didn't.
NonStringException - class freemarker.core.NonStringException
A subclass of TemplateException that indicates that the internals expected an expression to evaluate to a string or numeric value and it didn't.
Constructs a TemplateException with no specified detail message or underlying cause.
Constructs a TemplateException with the given detail message, but no underlying cause exception.
NormalizeNewlines - class freemarker.template.utility.NormalizeNewlines
Transformer that supports FreeMarker legacy behavior: all newlines appearing within the transformed area will be transformed into the platform's default newline.
NOTHING - static field in class freemarker.template.TemplateModel
A general-purpose object to represent nothing.
NUMBER_FORMAT_KEY - static field in class freemarker.core.Configurable
NumberModel - class freemarker.ext.beans.NumberModel
Wraps arbitrary subclass of java.lang.Number into a reflective model.
NumberModel(Number,freemarker.ext.beans.BeansWrapper) - constructor for class freemarker.ext.beans.NumberModel
Creates a new model that wraps the specified number object.

O

object - field in class freemarker.ext.beans.BeanModel
object - field in class freemarker.ext.jython.JythonModel
OBJECT_WRAPPER_KEY - static field in class freemarker.core.Configurable
ObjectConstructor - class freemarker.template.utility.ObjectConstructor
An object that you can make available in a template to instantiate arbitrary beans-wrapped objects in a template.
ObjectWrapper - interface freemarker.template.ObjectWrapper
An object that knows how to "wrap" a java object as a TemplateModel instance.
ONE - static field in class freemarker.template.utility.Constants
onError(Throwable) - method in class freemarker.template.TransformControl
Called if any exception occurs during the transform between the TemplateTransformModel.getWriter(java.io.Writer, java.util.Map) call and the java.io.Writer.close() call.
onStart() - method in class freemarker.template.TransformControl
Called before the body is evaluated for the first time.
optimizeListStorage(List) - static method in class freemarker.template.utility.OptimizerUtil
optimizeNumberRepresentation(Number) - static method in class freemarker.template.utility.OptimizerUtil
This is needed to reverse the extreme conversions in arithmetic operations so that numbers can be meaningfully used with models that don't know what to do with a BigDecimal.
OptimizerUtil - class freemarker.template.utility.OptimizerUtil
OUTPUT_ENCODING_KEY - static field in class freemarker.core.Configurable
outputInstructionStack(PrintWriter) - method in class freemarker.core.Environment
Outputs the instruction stack.

P

parse(File) - static method in class freemarker.ext.dom.NodeModel
Create a NodeModel from an XML file.
parse(File,boolean,boolean) - static method in class freemarker.ext.dom.NodeModel
Create a NodeModel from an XML file.
parse(InputSource) - static method in class freemarker.ext.dom.NodeModel
Create a NodeModel from an XML input source.
parse(InputSource,boolean,boolean) - static method in class freemarker.ext.dom.NodeModel
Create a NodeModel from a SAX input source.
ParseException - class freemarker.core.ParseException
This exception is thrown when parse errors are encountered.
ParseException() - constructor for class freemarker.core.ParseException
The following constructors are for use by you for whatever purpose you can think of.
ParseException(String,int,int) - constructor for class freemarker.core.ParseException
ParseException(Token,int[][],String[]) - constructor for class freemarker.core.ParseException
This constructor is used by the method "generateParseException" in the generated parser.
parseNameValuePairList(String,String) - static method in class freemarker.template.utility.StringUtil
Parses a name-value pair list, where the pairs are separated with comma, and the name and value is separated with colon.
Called after the execution returns from template.process().
premissiveUnwrap(freemarker.template.TemplateModel) - static method in class freemarker.template.utility.DeepUnwrap
Same as unwrap(TemplateModel), but it doesn't throw exception if it doesn't know how to unwrap the object, but returns it as is.
Called as the first step in request processing, before the templating mechanism is put to work.
Called before the execution is passed to template.process().
printStackTrace() - method in class freemarker.template.utility.UndeclaredThrowableException
printStackTrace(java.io.PrintStream) - method in class freemarker.template.TemplateException
printStackTrace(PrintStream) - method in class freemarker.core.StopException
printStackTrace(PrintStream) - method in class freemarker.template.utility.UndeclaredThrowableException
printStackTrace(PrintWriter) - method in class freemarker.core.StopException
printStackTrace(PrintWriter) - method in class freemarker.template.TemplateException
printStackTrace(PrintWriter) - method in class freemarker.template.utility.UndeclaredThrowableException
process() - method in class freemarker.core.Environment
Processes the template to which this environment belongs.
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.
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.
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.
put(Object,Object) - method in class freemarker.cache.CacheStorage
put(Object,Object) - method in class freemarker.template.EmptyMap
put(Object,Object) - method in class freemarker.ext.util.IdentityHashMap
Associates the specified value with the specified key in this map.
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,Object) - method in class freemarker.template.SimpleHash
Adds a key-value entry to the map.
putAll(Map) - method in class freemarker.template.EmptyMap
putAll(Map) - method in class freemarker.ext.util.IdentityHashMap
Copies all of the mappings from the specified map to this one.
putAll(Map) - method in class freemarker.template.SimpleHash
Adds all the key/value entries in the map
putTemplate(String,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.
Stores a model in the hash so that it doesn't show up in keys() and values() methods.

R

registerNamespace(String,String) - method in class freemarker.ext.jdom.NodeListModel
Registers an XML namespace with this node list.
registerNamespace(String,String) - method in class freemarker.ext.xml.NodeListModel
Registers a namespace prefix-URI pair for subsequent use in get(String) as well as for use in XPath expressions.
release() - method in class freemarker.ext.jsp.FreemarkerTag
remove(Object) - method in class freemarker.cache.CacheStorage
remove(Object) - method in class freemarker.template.EmptyMap
remove(Object) - method in class freemarker.ext.util.IdentityHashMap
Removes the mapping for this key from this map if present.
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.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.
removeBreakpoint(freemarker.debug.Breakpoint) - method in class freemarker.debug.Debugger
Removes a single breakpoint
removeBreakpoints() - method in class freemarker.debug.Debugger
Removes all breakpoints
removeBreakpoints(String) - method in class freemarker.debug.Debugger
Removes all breakpoints for a specific template
removeComments(Node) - static method in class freemarker.ext.dom.NodeModel
Recursively removes all comment nodes from the subtree.
removeCustomAttribute(String) - method in class freemarker.core.Configurable
Removes a named custom attribute for this configurable.
removeDebuggerListener(Object) - method in class freemarker.debug.Debugger
Removes a previously added debugger listener.
removePIs(Node) - static method in class freemarker.ext.dom.NodeModel
Recursively removes all processing instruction nodes from the subtree.
REPEAT_EVALUATION - static field in class freemarker.template.TransformControl
Constant returned from afterBody() that tells the template engine to repeat transform body evaluation and feed it again to the transform.
replace(String,String,String,boolean,boolean) - static method in class freemarker.template.utility.StringUtil
Replaces all occurrences of a sub-string in a string.
requestUrlToTemplatePath(HttpServletRequest) - method in class freemarker.ext.servlet.FreemarkerServlet
Maps the request URL to a template path that is passed to Configuration.getTemplate(String,Locale).
resetState() - method in class freemarker.cache.MultiTemplateLoader
Invoked by Configuration.clearTemplateCache() to instruct this template loader to throw away its current state and start afresh.
resetState() - method in class freemarker.cache.StatefulTemplateLoader
Invoked by Configuration.clearTemplateCache() to instruct this template loader to throw away its current state and start afresh.
A concrete implementation of LocalizedString that gets a localized string from a java.util.ResourceBundle
ResourceBundleModel - class freemarker.ext.beans.ResourceBundleModel
A hash model that wraps a resource bundle.
resume() - method in class freemarker.debug.DebuggedEnvironment
Resumes the processing of the environment in the remote VM after it was stopped on a breakpoint.
RETHROW_HANDLER - static field in class freemarker.template.TemplateExceptionHandler
This is a TemplateExceptionHandler that simply rethrows the exception.
ReturnInstruction - class freemarker.core.ReturnInstruction
Represents a <return> instruction to jump out of a macro.
RhinoFunctionModel - class freemarker.ext.rhino.RhinoFunctionModel
Experimental: no backward compatibility guarantees; any feedback is highly welcome!
RhinoScriptableModel - class freemarker.ext.rhino.RhinoScriptableModel
Experimental: no backward compatibility guarantees; any feedback is highly welcome!
RhinoWrapper - class freemarker.ext.rhino.RhinoWrapper
Experimental: no backward compatibility guarantees; any feedback is highly welcome!
rightPad(String,int) - static method in class freemarker.template.utility.StringUtil
Pads the string at the right with spaces until it reaches the desired length.
rightPad(String,int,char) - static method in class freemarker.template.utility.StringUtil
Pads the string at the right with the specified character until it reaches the desired length.
rightPad(String,int,String) - static method in class freemarker.template.utility.StringUtil
Pads the string at the right with a filling pattern until it reaches the desired length.
roundingPolicy - field in class freemarker.core.ArithmeticEngine
RTFEnc(String) - static method in class freemarker.template.utility.StringUtil
Rich Text Format encoding (does not replace line breaks).

S

SCOPE_CONFIGURATION - static field in class freemarker.core.CustomAttribute
Constant used in the constructor specifying that this attribute is scoped by the configuration.
SCOPE_ENVIRONMENT - static field in class freemarker.core.CustomAttribute
Constant used in the constructor specifying that this attribute is scoped by the environment.
SCOPE_TEMPLATE - static field in class freemarker.core.CustomAttribute
Constant used in the constructor specifying that this attribute is scoped by the template.
SecurityUtilities - class freemarker.template.utility.SecurityUtilities
selectLoggerLibrary(int) - static method in class freemarker.log.Logger
Selects the logger library to use.
serialVersionUID - static field in class freemarker.ext.servlet.FreemarkerServlet
serialVersionUID - static field in class freemarker.ext.util.IdentityHashMap
ServletContextHashModel - class freemarker.ext.servlet.ServletContextHashModel
TemplateHashModel wrapper for a ServletContext attributes.
sessionCreated(HttpSessionEvent) - method in class freemarker.ext.jsp.EventForwarding
sessionDestroyed(HttpSessionEvent) - method in class freemarker.ext.jsp.EventForwarding
set(Object) - method in class freemarker.core.CustomAttribute
Sets the value of the attribute in the context of the current environment.
Sets the value of a template-scope attribute in the context of the given template.
Adds all object in the hash as shared variable to the configuration.
Sets the arithmetic engine used to perform arithmetic operations.
setAttributesShadowItems(boolean) - method in class freemarker.ext.jython.JythonWrapper
Sets whether attributes shadow items in wrapped objects.
setAutoImports(Map) - method in class freemarker.template.Configuration
set a map of namespace names to templates for auto-importing a set of templates.
setAutoIncludes(List) - method in class freemarker.template.Configuration
set the list of automatically included templates.
setBasedir(File) - method in class freemarker.ext.ant.FreemarkerXmlTask
Set the base directory.
setBodyContent(BodyContent) - method in class freemarker.ext.jsp.FreemarkerTag
setBooleanFormat(String) - method in class freemarker.core.Configurable
setCaching(boolean) - method in class freemarker.ext.jsp.FreemarkerTag
setCatchAll(String) - method in class freemarker.core.Macro
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.
setClassicCompatible(boolean) - method in class freemarker.core.Configurable
Toggles the "Classic Compatibile" mode.
Sets the configuration object to which this cache belongs.
sets TemplateNodeModel as the current visitor node.
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
Sets the date format used to convert date models representing date-only dates to strings.
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
Sets the date format used to convert date models representing datetime dates to strings.
Sets the Configuration object that will be retrieved from future calls to getDefaultConfiguration().
setDefaultDateType(int) - method in class freemarker.ext.beans.BeansWrapper
Sets the default date type to use for date models that result from a plain java.util.Date instead of java.sql.Date or java.sql.Time or java.sql.Timestamp.
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.
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.
setDestdir(File) - method in class freemarker.ext.ant.FreemarkerXmlTask
Set the destination directory into which the generated files should be copied to
setDirectoryForTemplateLoading(File) - method in class freemarker.template.Configuration
Set the explicit directory from which to load templates.
setDocumentBuilderFactory(DocumentBuilderFactory) - static method in class freemarker.ext.dom.NodeModel
Sets the DOM Parser implementation to be used when building NodeModel objects from XML files.
setEncoding(Locale,String) - method in class freemarker.template.Configuration
Sets the character set encoding to use for templates of a given locale.
setEncoding(String) - method in class freemarker.ext.ant.FreemarkerXmlTask
Set encoding for generated files.
setEncoding(String) - method in class freemarker.template.Template
Sets the character encoding to use for included files.
setErrorHandler(ErrorHandler) - static method in class freemarker.ext.dom.NodeModel
sets the error handler to use when parsing the document.
setExposeFields(boolean) - method in class freemarker.ext.beans.BeansWrapper
setExposureLevel(int) - method in class freemarker.ext.beans.BeansWrapper
Sets the method exposure level.
setExtension(String) - method in class freemarker.ext.ant.FreemarkerXmlTask
Set the output file extension.
setFile(File) - method in class freemarker.ext.ant.JythonAntTask
Sets a variable that is visible globally.
setIncremental(String) - method in class freemarker.ext.ant.FreemarkerXmlTask
Turn on/off incremental processing.
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
Sets the locale to assume when searching for template files with no explicit requested locale.
setLocalizedLookup(boolean) - method in class freemarker.template.Configuration
Enables/disables localized template lookup.
setLocalizedLookup(boolean) - method in class freemarker.cache.TemplateCache
Setis if localized template lookup is enabled or not.
Sets a local variable (one effective only during a macro invocation).
setMaxScale(int) - method in class freemarker.core.ArithmeticEngine
Sets the maximal scale to use when multiplying BigDecimal numbers.
setMethodsShadowItems(boolean) - method in class freemarker.ext.beans.BeansWrapper
Sets whether methods shadow items in beans.
setMinScale(int) - method in class freemarker.core.ArithmeticEngine
Sets the minimal scale to use when dividing BigDecimal numbers.
setModels(String) - method in class freemarker.ext.ant.FreemarkerXmlTask
setName(String) - method in class freemarker.ext.jsp.FreemarkerTag
setNullModel(freemarker.template.TemplateModel) - method in class freemarker.ext.beans.BeansWrapper
Sets the null model.
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
Sets the number format used to convert numbers to strings.
Sets the object wrapper used to wrap objects to template models.
setOut(Writer) - method in class freemarker.core.Environment
When wrapping an object, the BeansWrapper commonly needs to wrap "sub-objects", for example each element in a wrapped collection.
setOutputEncoding(String) - method in class freemarker.core.Configurable
Sets the output encoding.
setOutputEncoding(String) - method in class freemarker.core.Environment
Sets the output encoding.
setPageContext(PageContext) - method in class freemarker.ext.jsp.FreemarkerTag
setParent(Tag) - method in class freemarker.ext.jsp.FreemarkerTag
setProjectfile(String) - method in class freemarker.ext.ant.FreemarkerXmlTask
Set the path to the project XML file
setRoundingPolicy(int) - method in class freemarker.core.ArithmeticEngine
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.
Adds a shared variable to the configuration.
setSharedVariable(String,Object) - method in class freemarker.template.Configuration
Adds shared variable to the configuration.
setSimpleMapWrapper(boolean) - method in class freemarker.ext.beans.BeansWrapper
By default the BeansWrapper wraps classes implementing java.util.Map using MapModel.
setStrict(boolean) - method in class freemarker.ext.beans.BeansWrapper
Specifies if an attempt to read a bean property that doesn't exist in the wrapped object should throw an InvalidPropertyException.
setStrictBeanModels(boolean) - method in class freemarker.core.Configurable
setStrictSyntaxMode(boolean) - method in class freemarker.template.Configuration
Sets whether directives such as if, else, etcetera must be written as #if, #else, etcetera.
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.
setTemplate(String) - method in class freemarker.ext.ant.FreemarkerXmlTask
setTemplateDir(File) - method in class freemarker.ext.ant.FreemarkerXmlTask
setTemplateEncoding(String) - method in class freemarker.ext.ant.FreemarkerXmlTask
Sets the exception handler used to handle template exceptions.
Sets the exception handler used to handle template exceptions.
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
Sets the date format used to convert date models representing time-only values to strings.
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
Sets the time zone to use when formatting time values.
setURLEscapingCharset(String) - method in class freemarker.core.Configurable
Sets the URL escaping charset.
setURLEscapingCharset(String) - method in class freemarker.core.Environment
Sets the URL escaping charset.
setUseCache(boolean) - method in class freemarker.ext.beans.BeansWrapper
Sets whether this wrapper caches model instances.
setUseCache(boolean) - method in class freemarker.ext.jython.JythonWrapper
Sets whether this wrapper caches model instances.
setUseCache(boolean) - method in class freemarker.ext.util.ModelCache
Sets whether this wrapper caches model instances.
setValidation(boolean) - method in class freemarker.ext.ant.FreemarkerXmlTask
Sets whether to validate the XML input.
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.
setXPathSupportClass(Class) - static method in class freemarker.ext.dom.NodeModel
Set an alternative implementation of freemarker.ext.dom.XPathSupport to use as the XPath engine.
SIMPLE_WRAPPER - static field in class freemarker.template.ObjectWrapper
Object wrapper that uses SimpleXXX wrappers only.
SimpleCollection - class freemarker.template.SimpleCollection
A simple implementation of TemplateCollectionModel.
SimpleCollection(Collection) - constructor for class freemarker.template.SimpleCollection
SimpleCollection(Iterator) - constructor for class freemarker.template.SimpleCollection
SimpleDate - class freemarker.template.SimpleDate
A simple implementation of the TemplateDateModel interface.
SimpleDate(java.sql.Date) - constructor for class freemarker.template.SimpleDate
Creates a new date model wrapping the specified date object and having DATE type.
SimpleDate(java.sql.Time) - constructor for class freemarker.template.SimpleDate
Creates a new date model wrapping the specified time object and having TIME type.
SimpleDate(java.sql.Timestamp) - constructor for class freemarker.template.SimpleDate
Creates a new date model wrapping the specified time object and having DATETIME type.
SimpleDate(java.util.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 freemarker.template.SimpleHash
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(freemarker.template.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,freemarker.template.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 freemarker.template.SimpleList
This is a trivial subclass that exists for backward compatibility with the SimpleList from FreeMarker Classic.
SimpleList() - constructor for class freemarker.template.SimpleList
Constructs an empty simple sequence that will use the the default object wrapper set in WrappingTemplateModel.setDefaultObjectWrapper(ObjectWrapper).
SimpleList(java.util.List) - constructor for class freemarker.template.SimpleList
SimpleMapModel - class freemarker.ext.beans.SimpleMapModel
Model used by BeansWrapper when simpleMapWrapper mode is enabled.
SimpleMapModel(Map,freemarker.ext.beans.BeansWrapper) - constructor for class freemarker.ext.beans.SimpleMapModel
SimpleNumber - class freemarker.template.SimpleNumber
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(Number) - constructor for class freemarker.template.SimpleNumber
SimpleNumber(short) - constructor for class freemarker.template.SimpleNumber
SimpleObjectWrapper - class freemarker.template.SimpleObjectWrapper
The default implementation of the ObjectWrapper interface.
SimpleScalar - class freemarker.template.SimpleScalar
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 freemarker.template.SimpleSequence
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(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).
Constructs a simple sequence that will contain the elements from the specified Collection and will use the specified object wrapper.
SimpleSequence(freemarker.template.ObjectWrapper) - constructor for class freemarker.template.SimpleSequence
Constructs an empty simple sequence using the specified object wrapper.
Constructs a simple sequence from the passed collection model using 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).
simplify(Node) - static method in class freemarker.ext.dom.NodeModel
Removes comments and processing instruction, and then unites adjacent text nodes.
singletonList(Object) - static method in class freemarker.template.utility.Collections12
singletonMap(Object,Object) - static method in class freemarker.template.utility.Collections12
size() - method in class freemarker.ext.beans.ArrayModel
size() - method in class freemarker.ext.beans.BeanModel
size() - method in class freemarker.core.CollectionAndSequence
size() - method in class freemarker.ext.beans.CollectionModel
size() - method in class freemarker.debug.DebugModel
size() - method in class freemarker.template.EmptyMap
size() - method in class freemarker.ext.servlet.HttpRequestHashModel
size() - method in class freemarker.ext.servlet.HttpRequestParametersHashModel
size() - method in class freemarker.ext.util.IdentityHashMap
Returns the number of key-value mappings in this map.
size() - method in class freemarker.ext.jython.JythonHashModel
Returns PyObject.__len__().
size() - method in class freemarker.ext.jython.JythonSequenceModel
Returns PyObject.__len__().
size() - method in class freemarker.ext.beans.MapModel
size() - method in class freemarker.ext.jdom.NodeListModel
size() - method in class freemarker.ext.xml.NodeListModel
Returns the number of nodes in this model's nodelist.
size() - method in class freemarker.ext.dom.NodeModel
size() - method in class freemarker.ext.beans.ResourceBundleModel
size() - method in class freemarker.ext.rhino.RhinoScriptableModel
size() - method in class freemarker.template.SimpleHash
size() - method in class freemarker.ext.beans.SimpleMapModel
size() - method in class freemarker.template.SimpleSequence
size() - method in class freemarker.core.StringArraySequence
size() - method in class freemarker.template.TemplateHashModelEx
size() - method in class freemarker.template.TemplateModelListSequence
size() - method in class freemarker.template.TemplateSequenceModel
SKIP_BODY - static field in class freemarker.template.TransformControl
Constant returned from onStart() that tells the template engine to skip evaluation of the body.
SoftCacheStorage - class freemarker.cache.SoftCacheStorage
Strong 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
specialConstructor - field in class freemarker.core.ParseException
This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).
specifiedEncoding - field in class freemarker.template.Template.WrongEncodingException
split(String,char) - static method in class freemarker.template.utility.StringUtil
Splits a string at the specified character.
split(String,String,boolean) - static method in class freemarker.template.utility.StringUtil
Splits a string at the specified string.
SQUARE_BRACKET_TAG_SYNTAX - static field in class freemarker.template.Configuration
StandardCompress - class freemarker.template.utility.StandardCompress
A filter that compresses each sequence of consecutive whitespace to a single line break (if the sequence contains a line break) or a single space.
StandardCompress() - constructor for class freemarker.template.utility.StandardCompress
StandardCompress(int) - constructor for class freemarker.template.utility.StandardCompress
StatefulTemplateLoader - interface freemarker.cache.StatefulTemplateLoader
Interface that can be implemented by template loaders that maintain some sort of internal state (i.e.
stop() - method in class freemarker.debug.DebuggedEnvironment
Stops the processing of the environment after it was stopped on a breakpoint.
StopException - class freemarker.core.StopException
This exception is thrown when a <stop> directive is encountered.
STRICT_BEAN_MODELS - static field in class freemarker.core.Configurable
STRICT_SYNTAX_KEY - static field in class freemarker.template.Configuration
Sequence variable implementation that wraps a String[] with relatively low resource utilization.
StringArraySequence(String[]) - constructor for class freemarker.core.StringArraySequence
Warning: Does not copy the argument array!
StringModel - class freemarker.ext.beans.StringModel
Subclass of BeanModel that exposes the return value of the java.lang.Object.toString() method through the TemplateScalarModel interface.
StringModel(Object,freemarker.ext.beans.BeansWrapper) - constructor for class freemarker.ext.beans.StringModel
Creates a new model that wraps the specified object with BeanModel + scalar functionality.
A TemplateLoader that uses a Map with Strings as its source of templates.
StringUtil - class freemarker.template.utility.StringUtil
Some text related utilities.
StrongCacheStorage - class freemarker.cache.StrongCacheStorage
Strong cache storage is a cache storage that simply wraps a HashMap.
subtract(Number,Number) - method in class freemarker.core.ArithmeticEngine
synchronizedWrapper() - method in class freemarker.template.SimpleHash
synchronizedWrapper() - method in class freemarker.template.SimpleSequence

T

TAG_SYNTAX_KEY - static field in class freemarker.template.Configuration
TaglibFactory - class freemarker.ext.jsp.TaglibFactory
A hash model associated with a servlet context that can load JSP tag libraries associated with that servlet context.
TaglibFactory(ServletContext) - constructor for class freemarker.ext.jsp.TaglibFactory
Creates a new JSP taglib factory that will be used to load JSP taglibs for the web application represented by the passed servlet context.
Template - class freemarker.template.Template
A core FreeMarker API that represents a compiled template.
Template(String,Reader) - constructor for class freemarker.template.Template
Constructs a template from a character stream.
Template(String,Reader,freemarker.template.Configuration) - constructor for class freemarker.template.Template
This is equivalent to Template(name, reader, cfg, null)
Constructs a template from a character stream.
TEMPLATE_EXCEPTION_HANDLER_KEY - static field in class freemarker.core.Configurable
TEMPLATE_UPDATE_DELAY_KEY - static field in class freemarker.template.Configuration
TemplateBooleanModel - interface freemarker.template.TemplateBooleanModel
Objects that will be interpreted as true/false in the appropriate context must implement this interface.
TemplateCache - class freemarker.cache.TemplateCache
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(freemarker.cache.TemplateLoader) - constructor for class freemarker.cache.TemplateCache
Creates a new template cache with a custom template loader that is used to load the templates.
Creates a new template cache with a custom template loader that is used to load the templates.
TemplateCollectionModel - interface freemarker.template.TemplateCollectionModel
This interface can be implemented by a class to make a variable "foreach-able", i.e.
TemplateDateModel - interface freemarker.template.TemplateDateModel
Date values in a template data model must implement this interface.
TemplateElement - class freemarker.core.TemplateElement
Objects that represent elements in the compiled tree representation of the template necessarily descend from this abstract class.
TemplateException - class freemarker.template.TemplateException
The FreeMarker classes usually use this exception and its descendants to signal FreeMarker specific exceptions.
Constructs a TemplateException with the given underlying Exception, but no detail message.
TemplateException(freemarker.core.Environment) - constructor for class freemarker.template.TemplateException
Constructs a TemplateException with no specified detail message or underlying cause.
Constructs a TemplateException with both a description of the error that occurred and the underlying Exception that caused this exception to be raised.
Constructs a TemplateException with the given detail message, but no underlying cause exception.
TemplateExceptionHandler - interface freemarker.template.TemplateExceptionHandler
An API for objects that handle exceptions that are thrown during template rendering.
TemplateHashModel - interface freemarker.template.TemplateHashModel
Hashes in a data model must implement this interface.
TemplateHashModelEx - interface freemarker.template.TemplateHashModelEx
An extended hash interface with a couple of extra hooks.
TemplateLoader - interface freemarker.cache.TemplateLoader
A template loader is an object that can find the source stream for a template, can retrieve its time of last modification as well as the stream itself.
TemplateMethodModel - interface freemarker.template.TemplateMethodModel
Objects that act as methods in a template data model must implement this interface.
TemplateMethodModelEx - interface freemarker.template.TemplateMethodModelEx
A subinterface of TemplateMethodModel that acts on models, rather than on strings.
TemplateModel - interface freemarker.template.TemplateModel
This is a marker interface that indicates that an object can be put in a template's data model.
TemplateModelAdapter - interface freemarker.template.TemplateModelAdapter
Implemented by classes that serve as adapters for template model objects in some other object model.
Template model implementation classes should throw this exception if requested data cannot be retrieved.
TemplateModelException() - constructor for class freemarker.template.TemplateModelException
Constructs a TemplateModelException with no specified detail message.
TemplateModelException(Exception) - constructor for class freemarker.template.TemplateModelException
Constructs a TemplateModelException with the given underlying Exception, but no detail message.
TemplateModelException(String) - constructor for class freemarker.template.TemplateModelException
Constructs a TemplateModelException with the specified detail message.
TemplateModelException(String,Exception) - constructor for class 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 freemarker.template.TemplateModelIterator
This interface is used to iterate over a set of template models, and is usually returned from an instance of TemplateCollectionModel.
Sequence that wraps a java.util.List of already wrapped objects directly, with minimal resource usage.
TemplateModelListSequence(List) - constructor for class freemarker.template.TemplateModelListSequence
TemplateNodeModel - interface freemarker.template.TemplateNodeModel
Describes objects that are nodes in a tree.
TemplateNumberModel - interface freemarker.template.TemplateNumberModel
Numeric values in a template data model must implement this interface.
TemplateObject - class freemarker.core.TemplateObject
Objects that represent instructions or expressions in the compiled tree representation of the template all descend from this abstract base class.
TemplateScalarModel - interface freemarker.template.TemplateScalarModel
String values in a template data model must implement this interface.
TemplateSequenceModel - interface freemarker.template.TemplateSequenceModel
List values in a template data model whose elements are accessed by the index operator should implement this interface.
TemplateTransformModel - interface freemarker.template.TemplateTransformModel
Objects that implement this interface can be used in a <transform> block to perform arbitrary transformations on a part of the template processing output.
TextBlock - class freemarker.core.TextBlock
A TemplateElement representing a block of plain text.
TextBlock(String) - constructor for class freemarker.core.TextBlock
TextBlock(String,boolean) - constructor for class freemarker.core.TextBlock
TIME - static field in class freemarker.template.TemplateDateModel
The date model represents a time-only value.
TIME_FORMAT_KEY - static field in class freemarker.core.Configurable
TIME_ZONE_KEY - static field in class freemarker.core.Configurable
ToCanonical - class freemarker.template.utility.ToCanonical
Read in a template and convert it to a canonical format.
tokenImage - field in class freemarker.core.ParseException
This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.
toList() - method in class freemarker.template.SimpleSequence
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.
toNumber(String) - method in class freemarker.core.ArithmeticEngine
toNumber(String) - method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
toNumber(String) - method in class freemarker.core.ArithmeticEngine.ConservativeEngine
toString() - method in class freemarker.ext.beans.BeanModel
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.
toString() - method in class freemarker.core.TemplateObject
transcode(String) - method in class freemarker.ext.servlet.HttpRequestParametersHashModel
Transform - class freemarker.ext.dom.Transform
A class that contains a main() method for command-line invocation of a FreeMarker XML transformation.
transform(Reader,Writer) - method in class freemarker.template.utility.NormalizeNewlines
Performs newline normalization on FreeMarker output.
TransformControl - interface freemarker.template.TransformControl
An interface that can be implemented by writers returned from TemplateTransformModel.getWriter(java.io.Writer, java.util.Map).
TRUE - static field in class freemarker.template.utility.Constants
TRUE - static field in class freemarker.template.TemplateBooleanModel
A singleton object to represent boolean true
TYPE_BOOLEAN - static field in class freemarker.debug.DebugModel
TYPE_COLLECTION - static field in class freemarker.debug.DebugModel
TYPE_CONFIGURATION - static field in class freemarker.debug.DebugModel
TYPE_DATE - static field in class freemarker.debug.DebugModel
TYPE_ENVIRONMENT - static field in class freemarker.debug.DebugModel
TYPE_HASH - static field in class freemarker.debug.DebugModel
TYPE_HASH_EX - static field in class freemarker.debug.DebugModel
TYPE_METHOD - static field in class freemarker.debug.DebugModel
TYPE_METHOD_EX - static field in class freemarker.debug.DebugModel
TYPE_NAMES - static field in class freemarker.template.TemplateDateModel
TYPE_NUMBER - static field in class freemarker.debug.DebugModel
TYPE_SCALAR - static field in class freemarker.debug.DebugModel
TYPE_SEQUENCE - static field in class freemarker.debug.DebugModel
TYPE_TEMPLATE - static field in class freemarker.debug.DebugModel
TYPE_TRANSFORM - static field in class freemarker.debug.DebugModel

U

The equivalent of JDK 1.3 UndeclaredThrowableException.
UndeclaredThrowableException(Throwable) - constructor for class freemarker.template.utility.UndeclaredThrowableException
UNKNOWN - static field in class 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
Used internally, public for technical reasons only.
unwrap(freemarker.template.TemplateModel) - method in class freemarker.ext.beans.BeanModel
unwrap(freemarker.template.TemplateModel) - method in class freemarker.ext.beans.BeansWrapper
Attempts to unwrap a model into underlying object.
unwrap(freemarker.template.TemplateModel) - static method in class freemarker.template.utility.DeepUnwrap
Unwraps TemplateModel-s recursively.
unwrap(freemarker.template.TemplateModel) - method in class freemarker.ext.jython.JythonWrapper
Coerces a template model into a PyObject.
unwrap(freemarker.template.TemplateModel,Class) - method in class freemarker.ext.beans.BeansWrapper
URL_ESCAPING_CHARSET_KEY - static field in class freemarker.core.Configurable
URLEnc(String,String) - static method in class freemarker.template.utility.StringUtil
URL encoding (like%20this).
URLTemplateLoader - class freemarker.cache.URLTemplateLoader
This is an abstract template loader that can load templates whose location can be described by an URL.
useDefaultXPathSupport() - static method in class freemarker.ext.dom.NodeModel
Tells the system to use (restore) the default (initial) XPath system used by this FreeMarker version on this system.
useJaxenXPathSupport() - static method in class freemarker.ext.dom.NodeModel
Convenience method.
useXalanXPathSupport() - static method in class freemarker.ext.dom.NodeModel
Convenience method.

V

values() - method in class freemarker.ext.beans.BeanModel
values() - method in class freemarker.template.EmptyMap
values() - method in class freemarker.ext.servlet.HttpRequestHashModel
values() - method in class freemarker.ext.servlet.HttpRequestParametersHashModel
values() - method in class freemarker.ext.util.IdentityHashMap
Returns a collection view of the values contained in this map.
values() - method in class freemarker.ext.jython.JythonHashModel
Returns object.__findattr__("values").__call__().
values() - method in class freemarker.ext.rhino.RhinoScriptableModel
values() - method in class freemarker.template.SimpleHash
values() - method in class freemarker.ext.beans.SimpleMapModel
values() - method in class freemarker.template.TemplateHashModelEx

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.
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 field in class freemarker.template.Configuration
wrap(Node) - static method in class freemarker.ext.dom.NodeModel
wrap(Object) - method in class freemarker.ext.beans.BeanModel
wrap(Object) - method in class freemarker.ext.beans.BeansWrapper
Wraps the object with a template model that is most specific for the object's class.
wrap(Object) - method in class freemarker.template.DefaultObjectWrapper
wrap(Object) - method in class freemarker.ext.jython.JythonWrapper
Wraps the passed Jython object into a FreeMarker template model.
wrap(Object) - method in class freemarker.template.ObjectWrapper
wrap(Object) - method in class freemarker.ext.rhino.RhinoWrapper
wrap(Object) - method in class freemarker.template.WrappingTemplateModel
Wraps the passed object into a template model using this object's object wrapper.
wrapDomNode(Object) - method in class freemarker.template.DefaultObjectWrapper
wrapper - field in class freemarker.ext.beans.BeanModel
wrapper - field in class freemarker.ext.jython.JythonModel
WrapperTemplateModel - interface freemarker.ext.util.WrapperTemplateModel
A generic interface for template models that wrap some underlying object, and wish to provide access to the wrapped object.
WrappingTemplateModel - class freemarker.template.WrappingTemplateModel
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.
Protected constructor that creates a new wrapping template model using the specified object wrapper.
WrongEncodingException(String) - constructor for class freemarker.template.Template.WrongEncodingException

X

XMLEnc(String) - static method in class freemarker.template.utility.StringUtil
XML Encoding.
XMLEncNA(String) - static method in class freemarker.template.utility.StringUtil
XML encoding without replacing apostrophes.
XMLEncNQG(String) - static method in class freemarker.template.utility.StringUtil
XML encoding without replacing apostrophes and quotation marks and greater-than signs.
XMLEncQAttr(String) - static method in class freemarker.template.utility.StringUtil
XML encoding for attributes valies quoted with " (not with '!).
XmlEscape - class freemarker.template.utility.XmlEscape
Performs an XML escaping of a given template fragment.
XPathSupport - interface freemarker.ext.dom.XPathSupport

Z

ZERO - static field in class freemarker.template.utility.Constants