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

A

accept(Environment) - Method in class freemarker.core.DebugBreak
 
accept(Environment) - Method in class freemarker.core.TextBlock
Simply outputs the text.
AdapterTemplateModel - Interface in freemarker.template
Supplemental interface that can be implemented by classes that also implement any of the TemplateModel interfaces.
add(Number, Number) - Method in class freemarker.core.ArithmeticEngine
 
add(Number, Number) - Method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
add(Number, Number) - Method in class freemarker.core.ArithmeticEngine.ConservativeEngine
 
add(Object) - Method in class freemarker.template.SimpleSequence
Adds an arbitrary object to the end of this SimpleSequence.
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_escapes(String) - Method in exception freemarker.core.ParseException
Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.
addAutoImport(String, String) - Method in class freemarker.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(Breakpoint) - Method in interface freemarker.debug.Debugger
Adds a breakpoint
addConfiguredJython(JythonAntTask) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.  
addConfiguredPrepareEnvironment(JythonAntTask) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.  
addConfiguredPrepareModel(JythonAntTask) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.  
addDebuggerListener(DebuggerListener) - Method in interface freemarker.debug.Debugger
Adds a listener for debugger events.
addEscapes(String) - Static method in error freemarker.core.TokenMgrError
Replaces unprintable characters by their espaced (or unicode escaped) equivalents in the given string
addImport(LibraryLoad) - Method in class freemarker.template.Template
Called by code internally to maintain a list of imports
AdditiveExpression() - Method in class freemarker.core.FMParser
 
addMacro(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.
AddSubExpression(Expression) - Method in class freemarker.core.FMParser
Production that builds up an expression using the dot or dynamic key name or the args list if this is a method invocation.
addText(String) - Method in class freemarker.ext.ant.JythonAntTask
 
adjustBeginLineColumn(int, int) - Method in class freemarker.core.SimpleCharStream
Method to adjust line and column numbers for the start of a token.
afterBody() - Method in interface freemarker.template.TransformControl
Called after the body has been evaluated.
AllHttpScopesHashModel - Class in freemarker.ext.servlet
An extension of SimpleHash that looks up keys in the hash, then in the request, session, and servlet context scopes.
AllHttpScopesHashModel(ObjectWrapper, ServletContext, HttpServletRequest) - Constructor for class freemarker.ext.servlet.AllHttpScopesHashModel
Creates a new instance of AllHttpScopesHashModel for handling a single HTTP servlet request.
AndExpression() - Method in class freemarker.core.FMParser
 
ANGLE_BRACKET_TAG_SYNTAX - Static variable in class freemarker.template.Configuration
 
ARITHMETIC_ENGINE_KEY - Static variable in class freemarker.core.Configurable
 
ArithmeticEngine - Class in freemarker.core
Class to perform arithmetic operations.
ArithmeticEngine() - Constructor for class freemarker.core.ArithmeticEngine
 
ArithmeticEngine.BigDecimalEngine - Class in freemarker.core
This is the default arithmetic engine in FreeMarker.
ArithmeticEngine.BigDecimalEngine() - Constructor for class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
ArithmeticEngine.ConservativeEngine - Class in freemarker.core
An arithmetic engine that conservatively widens the operation arguments to extent that they can hold the result of the operation.
ArithmeticEngine.ConservativeEngine() - Constructor for class freemarker.core.ArithmeticEngine.ConservativeEngine
 
ArrayModel - Class in freemarker.ext.beans
A class that will wrap an arbitrary array into TemplateCollectionModel and TemplateSequenceModel interfaces.
ArrayModel(Object, BeansWrapper) - Constructor for class freemarker.ext.beans.ArrayModel
Creates a new model that wraps the specified array object.
Assign() - Method in class freemarker.core.FMParser
 
Attempt() - Method in class freemarker.core.FMParser
 
attributeAdded(ServletContextAttributeEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
attributeAdded(HttpSessionBindingEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
attributeRemoved(ServletContextAttributeEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
attributeRemoved(HttpSessionBindingEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
attributeReplaced(ServletContextAttributeEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
attributeReplaced(HttpSessionBindingEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
AUTO_DETECT_TAG_SYNTAX - Static variable in class freemarker.template.Configuration
 
AUTO_IMPORT_KEY - Static variable in class freemarker.template.Configuration
 
AUTO_INCLUDE_KEY - Static variable in class freemarker.template.Configuration
 

B

backup(int) - Method in class freemarker.core.SimpleCharStream
 
baseDir - Variable in class freemarker.cache.FileTemplateLoader
 
BeanModel - Class in freemarker.ext.beans
A class that will wrap an arbitrary object into TemplateHashModel interface allowing calls to arbitrary property getters and invocation of accessible methods on the object from a template using the object.foo to access properties and object.bar(arg1, arg2) to invoke methods on it.
BeanModel(Object, BeansWrapper) - Constructor for class freemarker.ext.beans.BeanModel
Creates a new model that wraps the specified object.
BEANS_WRAPPER - Static variable in interface freemarker.template.ObjectWrapper
An ObjectWrapper that works similarly to ObjectWrapper.SIMPLE_WRAPPER, but exposes the objects methods and JavaBeans properties as hash elements and custom handling for Java Maps, ResourceBundles, etc.
BeansModelCache - Class in freemarker.ext.beans
 
BeansWrapper - Class in freemarker.ext.beans
Utility class that provides generic services to reflection classes.
BeansWrapper() - Constructor for class freemarker.ext.beans.BeansWrapper
Creates a new instance of BeansWrapper.
BeginToken() - Method in class freemarker.core.SimpleCharStream
 
BIGDECIMAL_ENGINE - Static variable in class freemarker.core.ArithmeticEngine
Arithmetic engine that converts all numbers to BigDecimal and then operates on them.
BOOLEAN_FORMAT_KEY - Static variable in class freemarker.core.Configurable
 
BooleanLiteral() - Method in class freemarker.core.FMParser
 
BooleanModel - Class in freemarker.ext.beans
A class that will wrap instances of Boolean into a TemplateBooleanModel.
BooleanModel(Boolean, BeansWrapper) - Constructor for class freemarker.ext.beans.BooleanModel
 
Break() - Method in class freemarker.core.FMParser
Production used to break out of a loop or a switch block.
Breakpoint - Class in freemarker.debug
Represents a breakpoint location consisting of a template name and a line number.
Breakpoint(String, int) - Constructor for class freemarker.debug.Breakpoint
Creates a new breakpoint.
bufcolumn - Variable in class freemarker.core.SimpleCharStream
 
buffer - Variable in class freemarker.core.SimpleCharStream
 
bufline - Variable in class freemarker.core.SimpleCharStream
 
bufpos - Variable in class freemarker.core.SimpleCharStream
 
BuiltIn(Expression) - Method in class freemarker.core.FMParser
 
BuiltinVariable() - Method in class freemarker.core.FMParser
 

C

CACHE_STORAGE_KEY - Static variable in class freemarker.template.Configuration
 
CacheStorage - Interface in freemarker.cache
Cache storage abstracts away the storage aspects of a cache - associating an object with a key, retrieval and removal via the key.
Call() - Method in class freemarker.core.FMParser
 
CAN_NOT_UNWRAP - Static variable in class freemarker.ext.beans.BeansWrapper
 
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 in freemarker.template.utility
Deprecated. Use block-assignments instead, as <assign x>...</assign>.
CaptureOutput() - Constructor for class freemarker.template.utility.CaptureOutput
Deprecated.  
Case() - Method in class freemarker.core.FMParser
 
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 variable in class freemarker.core.Configurable
 
ClassTemplateLoader - Class in freemarker.cache
A TemplateLoader that uses streams reachable through Class.getResourceAsStream(String) as its source of templates.
ClassTemplateLoader() - Constructor for class freemarker.cache.ClassTemplateLoader
Deprecated. confusing constructor, and seldom useful; use ClassTemplateLoader.ClassTemplateLoader(Class, String) instead.
ClassTemplateLoader(Class) - Constructor for class freemarker.cache.ClassTemplateLoader
Deprecated. it is confusing that the base path is ""; use ClassTemplateLoader.ClassTemplateLoader(Class, String) instead.
ClassTemplateLoader(Class, String) - Constructor for class freemarker.cache.ClassTemplateLoader
Creates a template loader that will use the Class.getResource(String) method of the specified class to load the resources, and the specified base path (absolute or relative).
ClassUtil - Class in freemarker.template.utility
 
clear() - Method in interface freemarker.cache.CacheStorage
 
clear() - Method in class freemarker.cache.MruCacheStorage
 
clear() - Method in class freemarker.cache.SoftCacheStorage
 
clear() - Method in class freemarker.cache.StrongCacheStorage
 
clear() - Method in class freemarker.cache.TemplateCache
Removes all entries from the cache, forcing reloading of templates on subsequent TemplateCache.getTemplate(String, Locale, String, boolean) calls.
clear() - Method in class freemarker.ext.util.IdentityHashMap
Removes all mappings from this map.
clear() - Method in class freemarker.template.EmptyMap
 
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.ext.util.IdentityHashMap
Returns a shallow copy of this IdentityHashMap instance: the keys and values themselves are not cloned.
clone() - Method in class freemarker.template.Configuration
 
closeTemplateSource(Object) - Method in class freemarker.cache.FileTemplateLoader
 
closeTemplateSource(Object) - Method in class freemarker.cache.MultiTemplateLoader
 
closeTemplateSource(Object) - Method in class freemarker.cache.StringTemplateLoader
 
closeTemplateSource(Object) - Method in interface freemarker.cache.TemplateLoader
Closes the template source.
closeTemplateSource(Object) - Method in class freemarker.cache.URLTemplateLoader
 
closeTemplateSource(Object) - Method in class freemarker.cache.WebappTemplateLoader
 
coerceBigDecimal(BigDecimal, Class) - Static method in class freemarker.ext.beans.BeansWrapper
 
coerceBigDecimals(AccessibleObject, Object[]) - Static method in class freemarker.ext.beans.BeansWrapper
Converts any BigDecimals in the passed array to the type of the corresponding formal argument of the method.
coerceBigDecimals(Class[], Object[]) - Static method in class freemarker.ext.beans.BeansWrapper
Converts any BigDecimals in the passed array to the type of the corresponding formal argument of the method.
CollectionAndSequence - Class in freemarker.core
Add sequence capabilities to an existing collection, or vice versa.
CollectionAndSequence(TemplateCollectionModel) - Constructor for class freemarker.core.CollectionAndSequence
 
CollectionAndSequence(TemplateSequenceModel) - Constructor for class freemarker.core.CollectionAndSequence
 
CollectionModel - Class in freemarker.ext.beans
A special case of BeanModel that can wrap Java collections and that implements the TemplateCollectionModel in order to be usable in a <foreach> block.
CollectionModel(Collection, BeansWrapper) - Constructor for class freemarker.ext.beans.CollectionModel
Creates a new model that wraps the specified collection object.
Collections12 - Class in freemarker.template.utility
Implementation of missing JDK 1.3 collection features for JDK 1.2
column - Variable in class freemarker.core.SimpleCharStream
 
columnNumber - Variable in exception freemarker.core.ParseException
 
CommandLine - Class in freemarker.core
FreeMarker command-line utility, the Main-Class of freemarker.jar.
CommandLine() - Constructor for class freemarker.core.CommandLine
 
Comment - Class in freemarker.core
A template element where the content is ignored, a Comment.
Comment() - Method in class freemarker.core.FMParser
 
compareNumbers(Number, Number) - Method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
compareNumbers(Number, Number) - Method in class freemarker.core.ArithmeticEngine
 
compareNumbers(Number, Number) - Method in class freemarker.core.ArithmeticEngine.ConservativeEngine
 
compareTo(Object) - Method in class freemarker.debug.Breakpoint
 
Compress() - Method in class freemarker.core.FMParser
 
ConcurrentCacheStorage - Interface in freemarker.cache
An optional interface for cache storage that knows whether it can be concurrently accessible without synchronization.
Configurable - Class in freemarker.core
This is a common superclass of Configuration, Template, and Environment classes.
Configurable() - Constructor for class freemarker.core.Configurable
 
Configurable(Configurable) - Constructor for class freemarker.core.Configurable
Creates a new instance.
Configurable.UnknownSettingException - Exception in freemarker.core
 
Configuration - Class in freemarker.template
Main entry point into the FreeMarker API, this class encapsulates the various configuration parameters with which FreeMarker is run, as well as serves as a central template loading and caching point.
Configuration() - Constructor for class freemarker.template.Configuration
 
CONSERVATIVE_ENGINE - Static variable in class freemarker.core.ArithmeticEngine
Arithmetic engine that uses (more-or-less) the widening conversions of Java language to determine the type of result of operation, instead of converting everything to BigDecimal up front.
Constants - Class in freemarker.template.utility
Frequently used constant TemplateModel values.
Constants() - Constructor for class freemarker.template.utility.Constants
 
containingElements(int, int) - Method in class freemarker.template.Template
 
contains(int, int) - Method in class freemarker.core.TemplateObject
 
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.
containsKey(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.
containsValue(Object) - Method in class freemarker.template.EmptyMap
 
Content() - Method in class freemarker.core.FMParser
 
contextDestroyed(ServletContextEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
contextInitialized(ServletContextEvent) - Method in class freemarker.ext.jsp.EventForwarding
 
convertArray(Object) - Method in class freemarker.template.DefaultObjectWrapper
Converts an array to a java.util.List
convertValueToText(Object, boolean, boolean, boolean, int, boolean) - Method in class freemarker.core.FreeMarkerTree
 
copyMap(Map) - Method in class freemarker.template.SimpleHash
 
create() - Method in class freemarker.core.CustomAttribute
This method is invoked when CustomAttribute.get() is invoked without CustomAttribute.set(Object) being invoked before it to define the value in the current scope.
create(Object) - Method in class freemarker.ext.beans.BeansModelCache
 
create(Object) - Method in class freemarker.ext.util.ModelCache
 
create(Object, ObjectWrapper) - Method in interface freemarker.ext.util.ModelFactory
Create a wrapping model for the specified object that belongs to the specified wrapper.
createConfiguration() - Method in class freemarker.ext.servlet.FreemarkerServlet
This method is called from FreemarkerServlet.init() to create the FreeMarker configuration object that this servlet will use for template loading.
createExpressionParser(String) - Static method in class freemarker.core.FMParser
Create an FM expression parser using a string.
createModel(ObjectWrapper, ServletContext, HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
 
createObjectWrapper() - Method in class freemarker.ext.servlet.FreemarkerServlet
This method is called from FreemarkerServlet.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, ObjectWrapper) - Method in class freemarker.template.Template
Creates a Environment object, using this template, the data model provided as the root map object, and the supplied object wrapper to convert map elements to template models.
createProcessingEnvironment(Object, Writer) - Method in class freemarker.template.Template
Same as createProcessingEnvironment(rootMap, out, null).
createRequestParametersHashModel(HttpServletRequest) - Method in class freemarker.ext.servlet.FreemarkerServlet
 
createTemplateLoader(String) - Method in class freemarker.ext.servlet.FreemarkerServlet
Create the template loader.
currentToken - Variable in exception freemarker.core.ParseException
This is the last token that has been consumed successfully.
CustomAttribute - Class in freemarker.core
A class that allows one to associate custom data with a configuration, a template, or environment.
CustomAttribute(int) - Constructor for class freemarker.core.CustomAttribute
Creates a new custom attribute with the specified scope

D

DATE - Static variable in interface freemarker.template.TemplateDateModel
The date model represents a date-only value.
DATE_FORMAT_KEY - Static variable in class freemarker.core.Configurable
 
DateModel - Class in freemarker.ext.beans
Wraps arbitrary subclass of Date into a reflective model.
DateModel(Date, BeansWrapper) - Constructor for class freemarker.ext.beans.DateModel
Creates a new model that wraps the specified date object.
DATETIME - Static variable in interface freemarker.template.TemplateDateModel
The date model represents a datetime value.
DATETIME_FORMAT_KEY - Static variable in class freemarker.core.Configurable
 
debug - Variable 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 variable in interface freemarker.template.TemplateExceptionHandler
This is a TemplateExceptionHandler used when you develop the templates.
DebugBreak - Class in freemarker.core
 
DebugBreak(TemplateElement) - Constructor for class freemarker.core.DebugBreak
 
DebuggedEnvironment - Interface in freemarker.debug
Represents the debugger-side mirror of a debugged Environment object in the remote VM.
Debugger - Interface in freemarker.debug
The main debugger interface.
DebuggerClient - Class in freemarker.debug
A utility class that allows you to connect to the FreeMarker debugger service running on a specific host and port.
DebuggerListener - Interface in freemarker.debug
An interface for components that wish to receive debugging events.
DebugModel - Interface in freemarker.debug
Represents the debugger-side mirror of a TemplateModel object, a Template object, or a Configuration object.
deduceLocale(String, HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
Returns the locale used for the Configuration.getTemplate(String, Locale) call.
deduceLocale(String) - Static method in class freemarker.template.utility.StringUtil
 
DeepUnwrap - Class in freemarker.template.utility
Utility methods for unwrapping TemplateModel-s.
DeepUnwrap() - Constructor for class freemarker.template.utility.DeepUnwrap
 
DEFAULT_ENCODING_KEY - Static variable in class freemarker.template.Configuration
 
DEFAULT_NAMESPACE_PREFIX - Static variable in class freemarker.template.Template
 
DEFAULT_PORT - Static variable in interface freemarker.debug.Debugger
 
DEFAULT_WRAPPER - Static variable in interface freemarker.template.ObjectWrapper
The default object wrapper implementation.
DefaultObjectWrapper - Class in freemarker.template
The default implementation of the ObjectWrapper interface.
DefaultObjectWrapper() - Constructor for class freemarker.template.DefaultObjectWrapper
 
DefaultTo(Expression) - Method in class freemarker.core.FMParser
 
disable_tracing() - Method in class freemarker.core.FMParser
 
divide(Number, Number) - Method in class freemarker.core.ArithmeticEngine.BigDecimalEngine
 
divide(Number, Number) - Method in class freemarker.core.ArithmeticEngine.ConservativeEngine
 
divide(Number, Number) - Method in class freemarker.core.ArithmeticEngine
 
doAfterBody() - Method in class freemarker.ext.jsp.FreemarkerTag
 
doEndTag() - Method in class freemarker.ext.jsp.FreemarkerTag
 
doGet(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
 
doInitBody() - Method in class freemarker.ext.jsp.FreemarkerTag
 
DOMNodeModel - Class in freemarker.template.utility
A convenient wrapper class for wrapping a Node in the W3C DOM API.
DOMNodeModel(Node) - Constructor for class freemarker.template.utility.DOMNodeModel
 
Done() - Method in class freemarker.core.SimpleCharStream
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
 
doStartTag() - Method in class freemarker.ext.jsp.FreemarkerTag
 
DotVariable(Expression) - Method in class freemarker.core.FMParser
production for when a key is specified by + keyname
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.
DynamicKey(Expression) - Method in class freemarker.core.FMParser
production for when the key is specified in brackets.

E

EMPTY_COLLECTION - Static variable in class freemarker.template.utility.Constants
 
EMPTY_HASH - Static variable in class freemarker.template.utility.Constants
 
EMPTY_ITERATOR - Static variable in class freemarker.template.utility.Constants
 
EMPTY_MAP - Static variable in class freemarker.template.utility.Collections12
 
EMPTY_SEQUENCE - Static variable in class freemarker.template.utility.Constants
 
EMPTY_STRING - Static variable in interface freemarker.template.TemplateScalarModel
A constant value to use as the empty string.
EMPTY_STRING - Static variable in class freemarker.template.utility.Constants
 
EmptyMap - Class in freemarker.template
 
EmptyMap() - Constructor for class freemarker.template.EmptyMap
 
enable_tracing() - Method in class freemarker.core.FMParser
 
END_EVALUATION - Static variable in interface freemarker.template.TransformControl
Constant returned from TransformControl.afterBody() that tells the template engine to end the transform and close the writer.
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.
entrySet() - Method in class freemarker.template.EmptyMap
 
EnumerationModel - Class in freemarker.ext.beans
A class that adds TemplateModelIterator functionality to the Enumeration interface implementers.
EnumerationModel(Enumeration, BeansWrapper) - Constructor for class freemarker.ext.beans.EnumerationModel
Creates a new model that wraps the specified enumeration object.
Environment - Class in freemarker.core
Object that represents the runtime environment during template processing.
Environment(Template, TemplateHashModel, Writer) - Constructor for class freemarker.core.Environment
 
Environment.Namespace - Class in freemarker.core
 
environmentSuspended(EnvironmentSuspendedEvent) - Method in interface freemarker.debug.DebuggerListener
Called whenever an environment gets suspended (ie hits a breakpoint).
EnvironmentSuspendedEvent - Class in freemarker.debug
Event describing a suspension of an environment (ie because it hit a breakpoint).
EnvironmentSuspendedEvent(Object, int, DebuggedEnvironment) - Constructor for class freemarker.debug.EnvironmentSuspendedEvent
 
eol - Variable in exception freemarker.core.ParseException
The end of line string for this machine.
EqualityExpression() - Method in class freemarker.core.FMParser
 
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.
Escape() - Method in class freemarker.core.FMParser
 
EVALUATE_BODY - Static variable in interface freemarker.template.TransformControl
Constant returned from TransformControl.onStart() that tells the template engine to evaluate the body.
EventForwarding - Class in freemarker.ext.jsp
An instance of this class should be registered as a <listener> in the web.xml descriptor in order to correctly dispatch events to event listeners that are specified in TLD files.
EventForwarding() - Constructor for class freemarker.ext.jsp.EventForwarding
 
exec(List) - Method in class freemarker.ext.beans.MapModel
The first argument is used as a key to call the map's get method.
exec(List) - Method in class freemarker.ext.beans.ResourceBundleModel
Takes first argument as a resource key, looks up a string in resource bundle with this key, then applies a MessageFormat.format on the string with the rest of the arguments.
exec(List) - Method in class freemarker.ext.beans.SimpleMapModel
 
exec(List) - Method in class freemarker.ext.beans.SimpleMethodModel
Invokes the method, passing it the arguments from the list.
exec(List) - Method in class freemarker.ext.dom.NodeModel
 
exec(List) - Method in class freemarker.ext.jdom.NodeListModel
Deprecated. Applies an XPath expression to the node list and returns the resulting node list.
exec(List) - Method in class freemarker.ext.jython.JythonModel
 
exec(List) - Method in class freemarker.ext.rhino.RhinoFunctionModel
 
exec(List) - Method in class freemarker.ext.xml.NodeListModel
Deprecated. Evaluates an XPath expression on XML nodes in this model.
exec(List) - Method in interface freemarker.template.TemplateMethodModel
Executes a method call.
exec(List) - Method in interface freemarker.template.TemplateMethodModelEx
Executes a method call.
exec(List) - Method in class freemarker.template.utility.Execute
Executes a method call.
exec(List) - Method in class freemarker.template.utility.ObjectConstructor
 
execute() - Method in class freemarker.ext.ant.FreemarkerXmlTask
Deprecated.  
execute(Map) - Method in class freemarker.ext.ant.JythonAntTask
 
execute(String, Map) - Method in class freemarker.ext.ant.UnlinkedJythonOperationsImpl
 
execute(File, Map) - Method in class freemarker.ext.ant.UnlinkedJythonOperationsImpl
 
execute(Environment, Map, TemplateModel[], TemplateDirectiveBody) - Method in interface freemarker.template.TemplateDirectiveModel
Executes this user-defined directive; called by FreeMarker when the user-defined directive is called in the template.
Execute - Class in freemarker.template.utility
Gives FreeMarker the the ability to execute external commands.
Execute() - Constructor for class freemarker.template.utility.Execute
 
executeQuery(Object, String) - Method in interface freemarker.ext.dom.XPathSupport
 
Exists(Expression) - Method in class freemarker.core.FMParser
 
ExpandBuff(boolean) - Method in class freemarker.core.SimpleCharStream
 
expectedTokenSequences - Variable in exception freemarker.core.ParseException
Each entry in this array is an array of integers.
EXPOSE_ALL - Static variable in class freemarker.ext.beans.BeansWrapper
At this level of exposure, all methods and properties of the wrapped objects are exposed to the template.
EXPOSE_NOTHING - Static variable in class freemarker.ext.beans.BeansWrapper
At this level of exposure, no bean properties and methods are exposed.
EXPOSE_PROPERTIES_ONLY - Static variable in class freemarker.ext.beans.BeansWrapper
At this level of exposure, only property getters are exposed.
EXPOSE_SAFE - Static variable in class freemarker.ext.beans.BeansWrapper
At this level of exposure, all methods and properties of the wrapped objects are exposed to the template except methods that are deemed not safe.
Expression - Class in freemarker.core
An abstract class for nodes in the parse tree that represent a FreeMarker expression.
Expression() - Constructor for class freemarker.core.Expression
 
Expression() - Method in class freemarker.core.FMParser
This is the same as OrExpression, since the OR is the operator with the lowest precedence.

F

FallBack() - Method in class freemarker.core.FMParser
 
FALSE - Static variable in interface freemarker.template.TemplateBooleanModel
A singleton object to represent boolean false
FALSE - Static variable in class freemarker.template.utility.Constants
 
FileTemplateLoader - Class in freemarker.cache
A TemplateLoader that uses files in a specified directory as the source of templates.
FileTemplateLoader() - Constructor for class freemarker.cache.FileTemplateLoader
Creates a new file template cache that will use the current directory (the value of the system property user.dir as the base directory for loading templates.
FileTemplateLoader(File) - Constructor for class freemarker.cache.FileTemplateLoader
Creates a new file template loader that will use the specified directory as the base directory for loading templates.
FileTemplateLoader(File, boolean) - Constructor for class freemarker.cache.FileTemplateLoader
Creates a new file template loader that will use the specified directory as the base directory for loading templates.
FillBuff() - Method in class freemarker.core.SimpleCharStream
 
findTemplateSource(String) - Method in class freemarker.cache.FileTemplateLoader
 
findTemplateSource(String) - Method in class freemarker.cache.MultiTemplateLoader
 
findTemplateSource(String) - Method in class freemarker.cache.StringTemplateLoader
 
findTemplateSource(String) - Method in interface freemarker.cache.TemplateLoader
Finds the object that acts as the source of the template with the given name.
findTemplateSource(String) - Method in class freemarker.cache.URLTemplateLoader
 
findTemplateSource(String) - Method in class freemarker.cache.WebappTemplateLoader
 
Flush() - Method in class freemarker.core.FMParser
 
FMParser - Class in freemarker.core
This class is generated by JavaCC from a grammar file.
FMParser(Template, Reader, boolean, boolean) - Constructor for class freemarker.core.FMParser
Constructs a new parser object.
FMParser(Template, Reader, boolean, boolean, int) - Constructor for class freemarker.core.FMParser
 
FMParser(String) - Constructor for class freemarker.core.FMParser
 
FMParser(InputStream) - Constructor for class freemarker.core.FMParser
 
FMParser(Reader) - Constructor for class freemarker.core.FMParser
 
FMParser(FMParserTokenManager) - Constructor for class freemarker.core.FMParser
 
ForEach() - Method in class freemarker.core.FMParser
 
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.
freemarker.cache - package freemarker.cache
Contains classes and interfaces that deal with template loading and caching.
freemarker.core - package freemarker.core
This package contains FreeMarker's core parsing/rendering functionality; most casual users do not need to be aware of the classes in this package, and can restrict their attention to the freemarker.template package.
freemarker.debug - package freemarker.debug
 
freemarker.ext.ant - package freemarker.ext.ant
An ant task that can be used to invoke the FreeMarker engine to generate documentation.
freemarker.ext.beans - package freemarker.ext.beans
Provides model implementations that allow access to arbitrary Java objects.
freemarker.ext.dom - package freemarker.ext.dom
 
freemarker.ext.jdom - package freemarker.ext.jdom
Provides adapter for JDOM including support for writing XML fragments, listing nodes, traversal, copying, and filtering, and a full XPath support.
freemarker.ext.jsp - package freemarker.ext.jsp
Classes for two-way FreeMarker-JSP integration.
freemarker.ext.jython - package freemarker.ext.jython
Provides model implementations that allow access to arbitrary Jython objects.
freemarker.ext.rhino - package freemarker.ext.rhino
Rhino (ECMAScript) support
freemarker.ext.servlet - package freemarker.ext.servlet
Provides a generic purpose servlet that generates dynamic response using FreeMarker.
freemarker.ext.util - package freemarker.ext.util
 
freemarker.ext.xml - package freemarker.ext.xml
Provides data model adapter for DOM, dom4j and JDOM; three widely used XML document object models.
freemarker.log - package freemarker.log
Provides the FreeMarker logging facility.
freemarker.template - package freemarker.template
This package contains the core API's that most users will use.
freemarker.template.utility - package freemarker.template.utility
Utility classes that may be used to customize aspects of FreeMarker.
FreemarkerDirective() - Method in class freemarker.core.FMParser
A production for FreeMarker directives.
FreemarkerServlet - Class in freemarker.ext.servlet
This is a general-purpose FreeMarker view servlet.
FreemarkerServlet() - Constructor for class freemarker.ext.servlet.FreemarkerServlet
 
FreemarkerTag - Class in freemarker.ext.jsp
Simple implementation of JSP tag to allow use of FreeMarker templates in JSP.
FreemarkerTag() - Constructor for class freemarker.ext.jsp.FreemarkerTag
 
FreeMarkerText() - Method in class freemarker.core.FMParser
A production freemarker text that may contain ${...} and #{...} but no directives.
FreeMarkerTree - Class in freemarker.core
 
FreeMarkerTree(Template) - Constructor for class freemarker.core.FreeMarkerTree
 
FreemarkerXmlTask - Class in freemarker.ext.ant
Deprecated. FMPP is a more complete solution.
FreemarkerXmlTask() - Constructor for class freemarker.ext.ant.FreemarkerXmlTask
Deprecated. Constructor creates the SAXBuilder.
FTLStringLiteralDec(String) - Static method in class freemarker.template.utility.StringUtil
FTL string literal decoding. \\, \", \', \n, \t, \r, \b and \f will be replaced according to Java rules.
FTLStringLiteralEnc(String) - Static method in class freemarker.template.utility.StringUtil
 

G

generateParseException() - Method in class freemarker.core.FMParser
 
get(Object) - Method in interface freemarker.cache.CacheStorage
 
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(int) - Method in class freemarker.core.CollectionAndSequence
 
get() - Method in class freemarker.core.CustomAttribute
 
get(Template) - Method in class freemarker.core.CustomAttribute
 
get(int) - Method in class freemarker.core.StringArraySequence
 
get(int) - Method in interface freemarker.debug.DebugModel
 
get(int, int) - Method in interface freemarker.debug.DebugModel
 
get(String) - Method in interface freemarker.debug.DebugModel
 
get(String[]) - Method in interface freemarker.debug.DebugModel
 
get(int) - Method in class freemarker.ext.beans.ArrayModel
 
get(String) - Method in class freemarker.ext.beans.BeanModel
Uses Beans introspection to locate a property or method with name matching the key name.
get(int) - Method in class freemarker.ext.beans.CollectionModel
Retrieves the i-th object from the collection, wrapped as a TemplateModel.
get(Object) - Method in class freemarker.ext.beans.HashAdapter
 
get(String) - Method in class freemarker.ext.beans.SimpleMapModel
 
get(int) - Method in class freemarker.ext.beans.SimpleMethodModel
 
get(String) - Method in class freemarker.ext.dom.NodeModel
 
get(int) - Method in class freemarker.ext.dom.NodeModel
 
get(String) - Method in class freemarker.ext.jdom.NodeListModel
Deprecated. Provides node list traversal as well as special functions: filtering by name, filtering by node type, shallow-copying, and duplicate removal.
get(int) - Method in class freemarker.ext.jdom.NodeListModel
Deprecated. Retrieves the i-th element of the node list.
get(String) - Method in class freemarker.ext.jsp.TaglibFactory
Retrieves a JSP tag library identified by an URI.
get(String) - Method in class freemarker.ext.jython.JythonModel
Calls PyObject.__findattr__(java.lang.String), then if it returns null calls PyObject.__finditem__(java.lang.String).
get(int) - Method in class freemarker.ext.jython.JythonSequenceModel
Returns PyObject.__finditem__(int).
get(String) - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
get(int) - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
get(String) - Method in class freemarker.ext.servlet.AllHttpScopesHashModel
 
get(String) - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
get(String) - Method in class freemarker.ext.servlet.HttpRequestParametersHashModel
 
get(String) - Method in class freemarker.ext.servlet.HttpSessionHashModel
 
get(String) - Method in class freemarker.ext.servlet.ServletContextHashModel
 
get(Object) - Method in class freemarker.ext.util.IdentityHashMap
Returns the value to which this map maps the specified key.
get(int) - Method in class freemarker.ext.xml.NodeListModel
Deprecated. Selects a single node from this model's nodelist by its list index and returns a new NodeListModel containing that single node.
get(String) - Method in class freemarker.ext.xml.NodeListModel
Deprecated. Returns a new NodeListModel containing the nodes that result from applying an operator to this model's nodes.
get(Object) - Method in class freemarker.template.EmptyMap
 
get(String) - Method in class freemarker.template.SimpleHash
 
get(int) - Method in class freemarker.template.SimpleSequence
 
get(String) - Method in interface freemarker.template.TemplateHashModel
Gets a TemplateModel from the hash.
get(int) - Method in class freemarker.template.TemplateModelListSequence
 
get(int) - Method in interface freemarker.template.TemplateSequenceModel
Retrieves the i-th template model in this sequence.
get(String) - Method in class freemarker.template.utility.DOMNodeModel
 
getAdaptedObject(Class) - Method in class freemarker.ext.beans.BeanModel
 
getAdaptedObject(Class) - Method in class freemarker.ext.beans.SimpleMapModel
 
getAdaptedObject(Class) - Method in class freemarker.ext.dom.NodeModel
 
getAdaptedObject(Class) - Method in class freemarker.ext.jython.JythonModel
 
getAdaptedObject(Class) - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
getAdaptedObject(Class) - Method in interface freemarker.template.AdapterTemplateModel
Retrieves the underlying object, or some other object semantically equivalent to its value narrowed by the class hint.
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 interface freemarker.debug.DebugModel
 
getAsBoolean() - Method in class freemarker.ext.beans.BooleanModel
 
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.ext.rhino.RhinoScriptableModel
 
getAsBoolean() - Method in interface freemarker.template.TemplateBooleanModel
 
getAsDate() - Method in interface freemarker.debug.DebugModel
 
getAsDate() - Method in class freemarker.ext.beans.DateModel
 
getAsDate() - Method in class freemarker.template.SimpleDate
 
getAsDate() - Method in interface freemarker.template.TemplateDateModel
Returns the date value.
getAsNumber() - Method in interface freemarker.debug.DebugModel
 
getAsNumber() - Method in class freemarker.ext.beans.NumberModel
 
getAsNumber() - Method in class freemarker.ext.jython.JythonNumberModel
Returns either PyObject.__tojava__(java.lang.Class) with Number.class as argument.
getAsNumber() - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
getAsNumber() - Method in class freemarker.template.SimpleNumber
 
getAsNumber() - Method in interface freemarker.template.TemplateNumberModel
Returns the numeric value.
getAsString() - Method in interface freemarker.debug.DebugModel
 
getAsString() - Method in class freemarker.ext.beans.StringModel
Returns the result of calling Object.toString() on the wrapped object.
getAsString() - Method in class freemarker.ext.jdom.NodeListModel
Deprecated. This method returns the string resulting from concatenation of string representations of its nodes.
getAsString() - Method in class freemarker.ext.jython.JythonModel
Returns the value of Object.toString().
getAsString() - Method in class freemarker.ext.rhino.RhinoScriptableModel
 
getAsString() - Method in class freemarker.ext.xml.NodeListModel
Deprecated. Returns the string representation of the wrapped nodes.
getAsString() - Method in class freemarker.template.LocalizedString
 
getAsString() - Method in class freemarker.template.SimpleScalar
 
getAsString() - Method in interface freemarker.template.TemplateScalarModel
Returns the string representation of this model.
getAsTemplateModel(Environment) - Method in class freemarker.core.Expression
 
getBeginColumn() - Method in class freemarker.core.SimpleCharStream
 
getBeginColumn() - Method in class freemarker.core.TemplateObject
 
getBeginLine() - Method in class freemarker.core.SimpleCharStream
 
getBeginLine() - Method in class freemarker.core.TemplateObject
 
getBooleanFormat() - Method in class freemarker.core.Configurable
 
getBreakpoints() - Method in interface freemarker.debug.Debugger
Retrieves a list of all Breakpoint objects.
getBreakpoints(String) - Method in interface freemarker.debug.Debugger
Retrieves a list of all Breakpoint objects for the specified template.
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
 
getCanonicalF