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

A

add_escapes(String) - Method in class freemarker.template.compiler.ParseException
Used to convert raw characters to their escaped version when these raw version cannot be used as part of an ASCII string literal.
add(boolean) - Method in class freemarker.template.SimpleSequence
Adds a boolean to the end of this SimpleSequence, by first wrapping the boolean in a SimpleScalar.
add(String) - Method in class freemarker.template.SimpleSequence
Adds a string to the end of this SimpleSequence, by first wrapping the string in a SimpleScalar.
add(TemplateModel) - Method in class freemarker.template.SimpleSequence
Adds a string to the end of this SimpleSequence, by first wrapping the string in a SimpleScalar.
addEscapes(String) - Static method in class freemarker.template.compiler.TokenMgrError
Replaces unprintable characters by their espaced (or unicode escaped) equivalents in the given string
addFunction(Function) - Method in class freemarker.template.Template
Adds a function to the template.
AdditiveExpression() - Method in class freemarker.template.compiler.FMParser
 
AddSubExpression(Expression) - Method in class freemarker.template.compiler.FMParser
Production that builds up an expression using the dot or dynamic key name or the args list if this is a method invocation.
adjustBeginLineColumn(int, int) - Method in class freemarker.template.compiler.SimpleCharStream
Method to adjust line and column numbers for the start of a token.
AND - Static variable in interface freemarker.template.compiler.FMParserConstants
 
AndExpression() - Method in class freemarker.template.compiler.FMParser
 
ANY_SCOPE - Static variable in class freemarker.ext.jsp.JspContextModel
 
APPLICATION_SCOPE - Static variable in class freemarker.ext.jsp.JspContextModel
 
ArgList(Expression) - Method in class freemarker.template.compiler.FMParser
 
ArrayModel - class freemarker.ext.beans.ArrayModel.
A class that will wrap an arbitrary array into TemplateCollectionModel, TemplateSequenceModel, and TemplateHashModel interfaces.
ArrayModel(Object) - Constructor for class freemarker.ext.beans.ArrayModel
Creates a new model that wraps the specified array object.
ASSIGN - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Assign() - Method in class freemarker.template.compiler.FMParser
 

B

backup(int) - Method in class freemarker.template.compiler.SimpleCharStream
 
BeanModel - class freemarker.ext.beans.BeanModel.
A class that will wrap an arbitrary object into TemplateHashModel interface allowing calls to arbitrary property getters and invokation 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) - Constructor for class freemarker.ext.beans.BeanModel
Creates a new model that wraps the specified object.
BeansWrapper - class freemarker.ext.beans.BeansWrapper.
Utility class that provides generic services to reflection classes.
beginColumn - Variable in class freemarker.template.compiler.Token
beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.
beginLine - Variable in class freemarker.template.compiler.Token
beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.
BeginToken() - Method in class freemarker.template.compiler.SimpleCharStream
 
BLANK - Static variable in interface freemarker.template.compiler.FMParserConstants
 
BooleanScalar - class freemarker.ext.beans.BooleanScalar.
Provides singleton template models for representing boolean values.
BREAK - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Break() - Method in class freemarker.template.compiler.FMParser
Production used to break out of a loop or a switch block.
bufpos - Variable in class freemarker.template.compiler.SimpleCharStream
 
BUILT_IN - Static variable in interface freemarker.template.compiler.FMParserConstants
 
BuiltIn(Expression) - Method in class freemarker.template.compiler.FMParser
 

C

CALL - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Call() - Method in class freemarker.template.compiler.FMParser
 
CASE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Case() - Method in class freemarker.template.compiler.FMParser
 
CLASSIC_COMPATIBILITY - Static variable in class freemarker.template.Template
 
clear() - Method in interface freemarker.template.TemplateCache
Clears the cache.
clear() - Method in class freemarker.template.FileTemplateCache
 
clear() - Method in class freemarker.ext.util.IdentityHashMap
Removes all mappings from this map.
clone() - Method in class freemarker.ext.util.IdentityHashMap
Returns a shallow copy of this IdentityHashMap instance: the keys and values themselves are not cloned.
CLOSE_BRACE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
CLOSE_BRACKET - Static variable in interface freemarker.template.compiler.FMParserConstants
 
CLOSE_PAREN - Static variable in interface freemarker.template.compiler.FMParserConstants
 
CLOSE_TAG - Static variable in interface freemarker.template.compiler.FMParserConstants
 
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 iterable in a <list> block.
CollectionModel(Collection) - Constructor for class freemarker.ext.beans.CollectionModel
Creates a new model that wraps the specified collection object.
COLON - Static variable in interface freemarker.template.compiler.FMParserConstants
 
COMMA - Static variable in interface freemarker.template.compiler.FMParserConstants
 
COMMENT - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Comment() - Method in class freemarker.template.compiler.FMParser
 
Comparison() - Method in class freemarker.template.compiler.FMParser
An AdditiveExpression followed by zero or more equality subexpressions
compileFromFile(File) - Method in class freemarker.template.Template
Deprecated. Expect this to be removed later. You should either pass in a Reader, or an explicit encoding.
compileFromFile(String) - Method in class freemarker.template.Template
Deprecated. Expect this to be removed later. You should either pass in a Reader, or an explicit encoding.
compileFromStream(InputStream) - Method in class freemarker.template.Template
Deprecated. Expect this to be removed later. You should either pass in a Reader, or an explicit encoding.
compileFromStream(InputStream, String) - Method in class freemarker.template.Template
Compiles the template from an InputStream, using the specified character encoding.
compileFromStream(Reader) - Method in class freemarker.template.Template
Compiles the template from a Reader.
COMPRESS - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Compress() - Method in class freemarker.template.compiler.FMParser
 
CompressWhitespace - class freemarker.template.utility.CompressWhitespace.
A transform model that compresses each occurrence of consecutive whitespace down to a single space character.
CompressWhitespace() - Constructor for class freemarker.template.utility.CompressWhitespace
Creates new CompressWhitespace
ConsumeWhiteSpace() - Method in class freemarker.template.compiler.FMParser
Consumes any meaningless whitespace between this point and the next Freemarker directive.
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.ext.util.IdentityHashMap
Returns true if this map maps one or more keys to the specified value.
Content() - Method in class freemarker.template.compiler.FMParser
 
create(Class) - Static method in class freemarker.ext.beans.StaticModel
Creates a model representing the static fields and methods of the passed class.
createCache() - Method in class freemarker.ext.servlet.FreemarkerServlet
 
createNodeListModel(List, boolean) - Static method in class freemarker.ext.jdom.NodeListModel
Factory method for creating a NodeListModel that best suits the passed list.
createRequestParametersHashModel(HttpServletRequest) - Method in class freemarker.ext.servlet.FreemarkerServlet
 
curChar - Variable in class freemarker.template.compiler.FMParserTokenManager
 
currentToken - Variable in class freemarker.template.compiler.ParseException
This is the last token that has been consumed successfully.

D

debug - Variable in class freemarker.ext.servlet.FreemarkerServlet
 
debugStream - Variable in class freemarker.template.compiler.FMParserTokenManager
 
DECIMAL - Static variable in interface freemarker.template.compiler.FMParserConstants
 
DEFAUL - Static variable in interface freemarker.template.compiler.FMParserConstants
 
DEFAULT - Static variable in interface freemarker.template.compiler.FMParserConstants
 
DIRECTIVE_END - Static variable in interface freemarker.template.compiler.FMParserConstants
 
disable_tracing() - Method in class freemarker.template.compiler.FMParser
 
DIVIDE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
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
 
Done() - Method in class freemarker.template.compiler.SimpleCharStream
 
doPost(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
 
doStartTag() - Method in class freemarker.ext.jsp.FreemarkerTag
 
DOT - Static variable in interface freemarker.template.compiler.FMParserConstants
 
DOT_DOT - Static variable in interface freemarker.template.compiler.FMParserConstants
 
DotVariable(Expression) - Method in class freemarker.template.compiler.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(PrintWriter) - Method in class freemarker.template.Template
Dump the raw template in canonical form.
DynamicKey(Expression) - Method in class freemarker.template.compiler.FMParser
production for when the key is specified in brackets.

E

ELSE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
ELSE_IF - Static variable in interface freemarker.template.compiler.FMParserConstants
 
EMPTY_SCALAR - Static variable in class freemarker.ext.beans.Models
A singleton empty scalar.
enable_tracing() - Method in class freemarker.template.compiler.FMParser
 
END_COMPRESS - Static variable in interface freemarker.template.compiler.FMParserConstants
 
END_FOREACH - Static variable in interface freemarker.template.compiler.FMParserConstants
 
END_FUNCTION - Static variable in interface freemarker.template.compiler.FMParserConstants
 
END_IF - Static variable in interface freemarker.template.compiler.FMParserConstants
 
END_LIST - Static variable in interface freemarker.template.compiler.FMParserConstants
 
END_SWITCH - Static variable in interface freemarker.template.compiler.FMParserConstants
 
END_TAG - Static variable in interface freemarker.template.compiler.FMParserConstants
 
END_TRANSFORM - Static variable in interface freemarker.template.compiler.FMParserConstants
 
endColumn - Variable in class freemarker.template.compiler.Token
beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.
endLine - Variable in class freemarker.template.compiler.Token
beginLine and beginColumn describe the position of the first character of this token; endLine and endColumn describe the position of the last character of this token.
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.
EnumerationModel(Enumeration) - Constructor for class freemarker.ext.beans.EnumerationModel
Creates a new model that wraps the specified enumeration object.
EOF - Static variable in interface freemarker.template.compiler.FMParserConstants
 
eol - Variable in class freemarker.template.compiler.ParseException
The end of line string for this machine.
EQUALS - Static variable in interface freemarker.template.compiler.FMParserConstants
 
ESCAPED_GT - Static variable in interface freemarker.template.compiler.FMParserConstants
 
ESCAPED_GTE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
exec(List) - Method in interface freemarker.template.TemplateMethodModel
Executes a method call.
exec(List) - Method in class freemarker.template.utility.Execute
Executes a method call.
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.jdom.NodeListModel
Applies an XPath expression to the node set and returns the resulting node set.
Execute - class freemarker.template.utility.Execute.
Gives FreeMarker the the ability to execute external commands.
execute() - Method in class freemarker.ext.ant.FreemarkerXmlTask
 
Execute() - Constructor for class freemarker.template.utility.Execute
Creates new Execute FreeMarker template
expectedTokenSequences - Variable in class freemarker.template.compiler.ParseException
Each entry in this array is an array of integers.
Expression - class freemarker.template.compiler.Expression.
An abstract class for nodes in the parse tree that represent a FreeMarker expression.
Expression() - Constructor for class freemarker.template.compiler.Expression
 
Expression() - Method in class freemarker.template.compiler.FMParser
This is the same as OrExpression, since the OR is the operator with the lowest precedence.

F

FALSE - Static variable in class freemarker.template.SimpleScalar
 
FALSE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
FALSE - Static variable in class freemarker.ext.beans.BooleanScalar
TemplateScalarModel for representing boolean false value
FALSE_ALERT - Static variable in interface freemarker.template.compiler.FMParserConstants
 
FileTemplateCache - class freemarker.template.FileTemplateCache.
A Cache that loads templates from the filesystem or via the Class.getResource() mechanism.
FileTemplateCache() - Constructor for class freemarker.template.FileTemplateCache
This will create an instance that simply attempts to load files via the classloader of this class
FileTemplateCache(Class) - Constructor for class freemarker.template.FileTemplateCache
This will create an instance that simply attempts to load files via the classloader mechanism of the specified class loader.
FileTemplateCache(Class, String) - Constructor for class freemarker.template.FileTemplateCache
Constructs a cache which loads template files relative to the classloader of a given class.
FileTemplateCache(File) - Constructor for class freemarker.template.FileTemplateCache
Constructs a cache which loads template files from an explicit directory on the file system.
FM_EXPRESSION - Static variable in interface freemarker.template.compiler.FMParserConstants
 
FMParser - class freemarker.template.compiler.FMParser.
This class is generated by JavaCC from a grammar file.
FMParser(FMParserTokenManager) - Constructor for class freemarker.template.compiler.FMParser
 
FMParser(InputStream) - Constructor for class freemarker.template.compiler.FMParser
 
FMParser(Reader) - Constructor for class freemarker.template.compiler.FMParser
 
FMParser(Template, Reader) - Constructor for class freemarker.template.compiler.FMParser
 
FMParserConstants - interface freemarker.template.compiler.FMParserConstants.
 
FMParserTokenManager - class freemarker.template.compiler.FMParserTokenManager.
 
FMParserTokenManager(SimpleCharStream) - Constructor for class freemarker.template.compiler.FMParserTokenManager
 
FMParserTokenManager(SimpleCharStream, int) - Constructor for class freemarker.template.compiler.FMParserTokenManager
 
FOREACH - Static variable in interface freemarker.template.compiler.FMParserConstants
 
ForEach() - Method in class freemarker.template.compiler.FMParser
 
format(String, Object[]) - Method in class freemarker.ext.beans.ResourceBundleModel
Provides direct access to caching format engine from code (instead of from script).
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.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 that allow FreeMarker to work as a taglib within JSP.
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.template - package freemarker.template
Allows Java servlets and applications to generate HTML pages or other text output based on templates, so that graphic design and other presentation details can be kept separate from application logic.
freemarker.template.compiler - package freemarker.template.compiler
The guts of the FreeMarker engine.
freemarker.template.utility - package freemarker.template.utility
Utility classes that may be used to customise aspects of FreeMarker.
FreemarkerDirective() - Method in class freemarker.template.compiler.FMParser
A production for Freemarker directives.
FreemarkerServlet - class freemarker.ext.servlet.FreemarkerServlet.
This is a general-purpose FreeMarker servlet with following features:
FreemarkerServlet() - Constructor for class freemarker.ext.servlet.FreemarkerServlet
 
FreemarkerTag - class freemarker.ext.jsp.FreemarkerTag.
Simple implementation of JSP tag to allow use of FreeMarker templates in JSP.
FreemarkerTag() - Constructor for class freemarker.ext.jsp.FreemarkerTag
 
FreeMarkerToHtml - class freemarker.template.utility.FreeMarkerToHtml.
A FreeMarker transformer that performs syntax colouring of FreeMarker source files, and outputs the results in HTML.
FreeMarkerToHtml() - Constructor for class freemarker.template.utility.FreeMarkerToHtml
Creates new FreeMarkerToHtml
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.
Function - class freemarker.template.compiler.Function.
An element representing a function declaration.
FUNCTION - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Function() - Method in class freemarker.template.compiler.FMParser
 
Function(String, List, TemplateElement) - Constructor for class freemarker.template.compiler.Function
 

G

generateParseException() - Method in class freemarker.template.compiler.FMParser
 
get(int) - Method in interface freemarker.template.TemplateSequenceModel
Retrieves the i-th template model in this sequence.
get(int) - Method in class freemarker.template.NumericalRange
 
get(int) - Method in class freemarker.template.SimpleSequence
 
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.ext.beans.ArrayModel
 
get(int) - Method in class freemarker.ext.jdom.NodeListModel
Retrieves the i-th element of the node set (as despite its name it really is a list).
get(Object) - Method in class freemarker.ext.util.IdentityHashMap
Returns the value to which this map maps the specified key.
get(String) - Method in class freemarker.template.SimpleHash
Gets a TemplateModel from the underlying hash.
get(String) - Method in interface freemarker.template.TemplateHashModel
Gets a TemplateModel from the hash.
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.ext.beans.CollectionModel
 
get(String) - Method in class freemarker.ext.beans.StaticModels
Returns a StaticModel for the fully qualified class name passed as the key.
get(String) - Method in class freemarker.ext.beans.StaticModel
Returns the field or method named by the key parameter.
get(String) - Method in class freemarker.ext.beans.RootMapModel
Returns BeansWrapper.wrap(map.get(key)) where map is the underlying map.
get(String) - Method in class freemarker.ext.beans.ArrayModel
If the key is named "length", the length of the array is returned.
get(String) - Method in class freemarker.ext.servlet.HttpSessionHashModel
 
get(String) - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
get(String) - Method in class freemarker.ext.servlet.ServletContextHashModel
 
get(String) - Method in class freemarker.ext.servlet.HttpRequestParametersHashModel
 
get(String) - Method in class freemarker.ext.jdom.NodeListModel
Provides node set 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.jsp.JspContextModel
 
getArgumentNames() - Method in class freemarker.template.compiler.Function
 
getAsNumber() - Method in class freemarker.template.SimpleNumber
 
getAsNumber() - Method in interface freemarker.template.TemplateNumberModel
Returns the number.
getAsNumber() - Method in class freemarker.ext.beans.NumberModel
 
getAsString(Locale) - Method in class freemarker.template.SimpleNumber
We use the locale to figure out the decimal separator to use.
getAsString(Locale) - Method in class freemarker.template.SimpleScalar
Note that this implementation does not use the locale parameter.
getAsString(Locale) - Method in interface freemarker.template.TemplateScalarModel
Since 2.0 final, this method takes a locale as an argument.
getAsString(Locale) - Method in class freemarker.ext.jdom.NodeListModel
This method returns the string resulting from concatenation of string representations of its nodes.
getAsTemplateModel(TemplateModelRoot) - Method in class freemarker.template.SimpleNumber
 
getAsTemplateModel(TemplateModelRoot) - Method in class freemarker.template.SimpleScalar
 
getAsTemplateModel(TemplateModelRoot) - Method in class freemarker.template.compiler.Expression
 
getBeginColumn() - Method in class freemarker.template.compiler.SimpleCharStream
 
getBeginLine() - Method in class freemarker.template.compiler.SimpleCharStream
 
getBoolean(TemplateModel) - Static method in class freemarker.ext.beans.BooleanScalar
Returns true if the passed object is the TRUE singleton.
getBooleanObject(Object) - Static method in class freemarker.ext.beans.BooleanScalar
Returns Boolean.TRUE if the passed object is the TRUE singleton, otherwise returns Boolean.FALSE.
getBundle() - Method in class freemarker.ext.beans.ResourceBundleModel
 
getCache() - Method in class freemarker.template.Template
Retrieve the cache that this object is stored in.
getCaching() - Method in class freemarker.ext.jsp.FreemarkerTag
 
getCauseException() - Method in class freemarker.template.TemplateException
Returns the underlying exception that caused this exception to be generated.
getCharset(Locale) - Static method in class freemarker.template.LocaleUtil
Gets the preferred charset for the given locale, or the default platform encoding if the locale is not in the table.
getColumn() - Method in class freemarker.template.compiler.SimpleCharStream
Deprecated.  
getDebugMode() - Static method in class freemarker.template.Template
 
getDecimalSeparator(Locale) - Static method in class freemarker.template.LocaleUtil
 
getEncoding() - Method in class freemarker.template.Template
 
getEndColumn() - Method in class freemarker.template.compiler.SimpleCharStream
 
getEndLine() - Method in class freemarker.template.compiler.SimpleCharStream
 
getFilenames(String, Locale) - Static method in class freemarker.template.LocaleUtil
Returns an array of potential filenames, given the base filename and the locale.
getFunction(String) - Method in class freemarker.template.Template
Retrieves a function from the template.
getFunctionNames() - Method in class freemarker.template.Template
 
GetImage() - Method in class freemarker.template.compiler.SimpleCharStream
 
getInstance(boolean) - Static method in class freemarker.ext.beans.BooleanScalar
Returns the boolean singleton TemplateScalarModel appropriate for representing the specified boolean value.
getInstance(Boolean) - Static method in class freemarker.ext.beans.BooleanScalar
Returns the boolean singleton TemplateScalarModel appropriate for representing the specified boolean value.
getInstance(Collection) - Static method in class freemarker.ext.beans.CollectionModel
Returns a model wrapping the specified collection object.
getInstance(Enumeration) - Static method in class freemarker.ext.beans.EnumerationModel
Returns a model wrapping the specified enumeration object.
getInstance(Iterator) - Static method in class freemarker.ext.beans.IteratorModel
Returns a model wrapping the specified iterator object.
getInstance(Map) - Static method in class freemarker.ext.beans.MapModel
Returns a model wrapping the specified map object.
getInstance(Number) - Static method in class freemarker.ext.beans.NumberModel
Returns a model wrapping the specified number object.
getInstance(Object) - Static method in class freemarker.ext.beans.BeanModel
Returns a model wrapping the specified object.
getInstance(Object) - Static method in class freemarker.ext.beans.ArrayModel
Returns a model wrapping the specified array object.
getInstance(ResourceBundle) - Static method in class freemarker.ext.beans.ResourceBundleModel
Returns a model wrapping the specified resource bundle object.
getLine() - Method in class freemarker.template.compiler.SimpleCharStream
Deprecated.  
getLocale() - Method in class freemarker.template.SimpleHash
 
getLocale() - Method in interface freemarker.template.TemplateModelRoot
gets the locale to be used for number/date formatting (A hook for later user currently -- revusky)
getLocale() - Method in class freemarker.template.Template
 
getLocale() - Method in class freemarker.ext.beans.RootMapModel
 
getMessage() - Method in class freemarker.template.compiler.ParseException
This method has the standard behavior when this object has been created using the standard constructors.
getMessage() - Method in class freemarker.template.compiler.TokenMgrError
You can also modify the body of this method to customize your error messages.
getName() - Method in class freemarker.template.SimpleNumber
 
getName() - Method in class freemarker.template.Template
 
getName() - Method in class freemarker.template.compiler.Function
 
getNextToken() - Method in class freemarker.template.compiler.FMParser
 
getNextToken() - Method in class freemarker.template.compiler.FMParserTokenManager
 
getNumericalValue(TemplateModelRoot) - Method in class freemarker.template.SimpleNumber
 
getNumericalValue(TemplateModelRoot) - Method in class freemarker.template.SimpleScalar
 
getParent() - Method in class freemarker.ext.jsp.FreemarkerTag
 
getStringValue(TemplateModelRoot) - Method in class freemarker.template.SimpleNumber
 
getStringValue(TemplateModelRoot) - Method in class freemarker.template.SimpleScalar
 
getStringValue(TemplateModelRoot) - Method in class freemarker.template.compiler.Expression
 
GetSuffix(int) - Method in class freemarker.template.compiler.SimpleCharStream
 
getTemplate(String) - Method in interface freemarker.template.TemplateCache
Retrieves a template from the cache.
getTemplate(String) - Method in class freemarker.template.FileTemplateCache
 
getTemplate(String, Locale) - Method in interface freemarker.template.TemplateCache
Retrieves a template corresponding to the name and locale.
getTemplate(String, Locale) - Method in class freemarker.template.FileTemplateCache
Will attempt to find a an appropriately named file given the name and the locale.
getTemplate(String, Locale, String) - Method in interface freemarker.template.TemplateCache
Retrieves a template corresponding to the name and locale.
getTemplate(String, Locale, String) - Method in class freemarker.template.FileTemplateCache
Will attempt to find a an appropriately named file given the name and the locale.
getTemplate(String, String) - Method in interface freemarker.template.TemplateCache
retrieves a file of the given name with the given encoding.
getTemplate(String, String) - Method in class freemarker.template.FileTemplateCache
 
getTemplatePath() - Method in class freemarker.ext.servlet.FreemarkerServlet
 
getToken(int) - Method in class freemarker.template.compiler.FMParser
 
getType() - Method in class freemarker.ext.beans.BeanModel
Returns the type of this object (which is TYPE_OBJECT)
getType() - Method in class freemarker.ext.beans.MapModel
Returns the type of this object (which is TYPE_MAP)
getType() - Method in class freemarker.ext.beans.IteratorModel
Returns the type of this object (which is TYPE_ITERATOR)
getType() - Method in class freemarker.ext.beans.CollectionModel
Returns the type of this object (which is TYPE_COLLECTION)
getType() - Method in class freemarker.ext.beans.ArrayModel
Returns the type of this object (which is TYPE_ARRAY)
getType() - Method in class freemarker.ext.beans.EnumerationModel
Returns the type of this object (which is TYPE_ENUMERATION)
getType() - Method in class freemarker.ext.beans.ResourceBundleModel
Returns the type of this object (which is TYPE_RESOURCE_BUNDLE)

H

hash - Variable in class freemarker.template.SimpleHash
 
HashLiteral() - Method in class freemarker.template.compiler.FMParser
 
hasNext() - Method in interface freemarker.template.TemplateModelIterator
 
hasNext() - Method in interface freemarker.template.TemplateListModel
Deprecated.  
hasNext() - Method in class freemarker.template.SimpleIterator
 
hasNext() - Method in class freemarker.ext.beans.IteratorModel
Calls Iterator.hasNext().
hasNext() - Method in class freemarker.ext.beans.EnumerationModel
 
HtmlEscape - class freemarker.template.utility.HtmlEscape.
Performs an HTML escape of a given template fragment.
HtmlEscape() - Constructor for class freemarker.template.utility.HtmlEscape
Creates new HtmlEscape
HttpRequestHashModel - class freemarker.ext.servlet.HttpRequestHashModel.
TemplateHashModel wrapper for a HttpServletRequest attributes.
HttpRequestHashModel(HttpServletRequest) - Constructor for class freemarker.ext.servlet.HttpRequestHashModel
 
HttpRequestParametersHashModel - class freemarker.ext.servlet.HttpRequestParametersHashModel.
TemplateHashModel wrapper for a HttpServletRequest parameters.
HttpRequestParametersHashModel(HttpServletRequest) - Constructor for class freemarker.ext.servlet.HttpRequestParametersHashModel
 
HttpSessionHashModel - class freemarker.ext.servlet.HttpSessionHashModel.
TemplateHashModel wrapper for a HttpSession attributes.
HttpSessionHashModel(HttpSession) - Constructor for class freemarker.ext.servlet.HttpSessionHashModel
 

I

ID - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Identifier() - Method in class freemarker.template.compiler.FMParser
 
IdentityHashMap - class freemarker.ext.util.IdentityHashMap.
A variant of 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.
IF - Static variable in interface freemarker.template.compiler.FMParserConstants
 
If() - Method in class freemarker.template.compiler.FMParser
 
IGNORE_TAG - Static variable in interface freemarker.template.compiler.FMParserConstants
 
image - Variable in class freemarker.template.compiler.Token
The string image of the token.
IN_PAREN - Static variable in interface freemarker.template.compiler.FMParserConstants
 
INCLUDE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Include() - Method in class freemarker.template.compiler.FMParser
 
init() - Method in class freemarker.ext.servlet.FreemarkerServlet
 
initializeServletContext(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called when servlet detects in a request processing that application-global (that is, ServletContext-specific) attributes are not yet set.
initializeSession(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called when servlet detects in a request processing that session-global (that is, HttpSession-specific) attributes are not yet set.
insertDefaults(TemplateModelRoot) - Method in class freemarker.ext.ant.FreemarkerXmlTask
 
INSTANCE - Static variable in class freemarker.ext.beans.StaticModels
The single instance of the class.
INTEGER - Static variable in interface freemarker.template.compiler.FMParserConstants
 
INTEGER_DOT_DOT - Static variable in interface freemarker.template.compiler.FMParserConstants
 
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.
isEmpty() - Method in class freemarker.template.SimpleHash
Is the underlying hash empty?
isEmpty() - Method in class freemarker.template.SimpleNumber
 
isEmpty() - Method in class freemarker.template.NumericalRange
 
isEmpty() - Method in interface freemarker.template.TemplateModel
 
isEmpty() - Method in class freemarker.template.SimpleSequence
Is the underlying List empty?
isEmpty() - Method in class freemarker.template.SimpleScalar
 
isEmpty() - Method in class freemarker.template.utility.CompressWhitespace
 
isEmpty() - Method in class freemarker.template.utility.XmlEscape
 
isEmpty() - Method in class freemarker.template.utility.FreeMarkerToHtml
 
isEmpty() - Method in class freemarker.template.utility.HtmlEscape
 
isEmpty() - Method in class freemarker.template.utility.NormalizeNewlines
 
isEmpty() - Method in class freemarker.template.utility.LegacyCompress
 
isEmpty() - Method in class freemarker.template.utility.Execute
 
isEmpty() - Method in class freemarker.template.utility.JavaToHtml
 
isEmpty() - Method in class freemarker.ext.beans.MapModel
Returns true if the underlying map is empty.
isEmpty() - Method in class freemarker.ext.beans.CollectionModel
Returns true if the underlying collection contains no elements.
isEmpty() - Method in class freemarker.ext.beans.StaticModels
 
isEmpty() - Method in class freemarker.ext.beans.BooleanScalar
Returns true if this is the FALSE object.
isEmpty() - Method in class freemarker.ext.beans.StaticModel
Returns true if there is at least one public static field or method in the underlying class.
isEmpty() - Method in class freemarker.ext.beans.RootMapModel
Returns map.isEmpty() where map is the underlying map.
isEmpty() - Method in class freemarker.ext.beans.ArrayModel
Returns true if the wrapped array is null, or its length is 0.
isEmpty() - Method in class freemarker.ext.beans.ResourceBundleModel
Returns true if this bundle contains no objects.
isEmpty() - Method in class freemarker.ext.servlet.HttpSessionHashModel
 
isEmpty() - Method in class freemarker.ext.servlet.HttpRequestHashModel
 
isEmpty() - Method in class freemarker.ext.servlet.ServletContextHashModel
 
isEmpty() - Method in class freemarker.ext.servlet.HttpRequestParametersHashModel
 
isEmpty() - Method in class freemarker.ext.jdom.NodeListModel
Returns true if this model contains no nodes.
isEmpty() - Method in class freemarker.ext.jsp.JspContextModel
 
isEmpty() - Method in class freemarker.ext.util.IdentityHashMap
Returns true if this map contains no key-value mappings.
isNumerical(TemplateModelRoot) - Method in class freemarker.template.SimpleNumber
always returns true.
isNumerical(TemplateModelRoot) - Method in class freemarker.template.SimpleScalar
Always returns false.
isRewound() - Method in interface freemarker.template.TemplateListModel
Deprecated.  
isTrue(TemplateModelRoot) - Method in class freemarker.template.SimpleNumber
 
isTrue(TemplateModelRoot) - Method in class freemarker.template.SimpleScalar
 
isTrue(TemplateModelRoot) - Method in class freemarker.template.compiler.Expression
 
iterator() - Method in interface freemarker.template.TemplateCollectionModel
Retrieves a template model iterator that is used to iterate over the elements in this collection.
iterator() - Method in class freemarker.ext.beans.CollectionModel
 
iterator() - Method in class freemarker.ext.beans.ArrayModel
 
iterator() - Method in class freemarker.ext.jdom.NodeListModel
 
IteratorModel - class freemarker.ext.beans.IteratorModel.
A class that adds TemplateModelIterator functionality to the Iterator interface implementers.
IteratorModel(Iterator) - Constructor for class freemarker.ext.beans.IteratorModel
Creates a new model that wraps the specified iterator object.

J

JavaToHtml - class freemarker.template.utility.JavaToHtml.
A FreeMarker transformer that performs syntax colouring of Java source files, and outputs the results in HTML.
JavaToHtml() - Constructor for class freemarker.template.utility.JavaToHtml
Creates new JavaToHtml
jj_nt - Variable in class freemarker.template.compiler.FMParser
 
jjnewLexState - Static variable in class freemarker.template.compiler.FMParserTokenManager
 
jjstrLiteralImages - Static variable in class freemarker.template.compiler.FMParserTokenManager
 
JspContextModel - class freemarker.ext.jsp.JspContextModel.
 
JspContextModel(PageContext, int) - Constructor for class freemarker.ext.jsp.JspContextModel
 

K

KEEP_GOING - Static variable in interface freemarker.template.compiler.FMParserConstants
 
keys() - Method in class freemarker.template.SimpleHash
 
keys() - Method in interface freemarker.template.TemplateHashModelEx
 
keySet() - Method in class freemarker.ext.util.IdentityHashMap
Returns a set view of the keys contained in this map.
kind - Variable in class freemarker.template.compiler.Token
An integer that describes the kind of this token.

L

LegacyCompress - class freemarker.template.utility.LegacyCompress.
A re-implementation of the <compress> template instruction as a TemplateTransformModel.
LegacyCompress() - Constructor for class freemarker.template.utility.LegacyCompress
Creates new LegacyCompress
LESS_THAN - Static variable in interface freemarker.template.compiler.FMParserConstants
 
LESS_THAN_EQUALS - Static variable in interface freemarker.template.compiler.FMParserConstants
 
lexStateNames - Static variable in class freemarker.template.compiler.FMParserTokenManager
 
list - Variable in class freemarker.template.SimpleSequence
 
LIST - Static variable in interface freemarker.template.compiler.FMParserConstants
 
List() - Method in class freemarker.template.compiler.FMParser
 
ListLiteral() - Method in class freemarker.template.compiler.FMParser
 
LOCALE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Locale() - Method in class freemarker.template.compiler.FMParser
 
LocaleUtil - class freemarker.template.LocaleUtil.
A holder for some locale-related routines.
LocaleUtil() - Constructor for class freemarker.template.LocaleUtil
 
logFileUpdate(String) - Method in class freemarker.template.FileTemplateCache
This method does nothing.
lookingAhead - Variable in class freemarker.template.compiler.FMParser
 

M

main(String[]) - Static method in class freemarker.template.compiler.FMParser
 
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.
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) - Constructor for class freemarker.ext.beans.MapModel
Creates a new model that wraps the specified map object.
MAYBE_END - Static variable in interface freemarker.template.compiler.FMParserConstants
 
MethodArgs(Expression) - Method in class freemarker.template.compiler.FMParser
production for an arglist part of a method invocation.
MINUS - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Models - class freemarker.ext.beans.Models.
Various predefined singleton models.
MultiplicativeExpression() - Method in class freemarker.template.compiler.FMParser
A unary expression followed by zero or more unary expressions with operators in between.

N

NATURAL_GT - Static variable in interface freemarker.template.compiler.FMParserConstants
 
NATURAL_GTE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
newToken(int) - Static method in class freemarker.template.compiler.Token
Returns a new Token object, by default.
next - Variable in class freemarker.template.compiler.Token
A reference to the next regular (non-special) token from the input stream.
next() - Method in interface freemarker.template.TemplateModelIterator
Returns the next model, or null if there are no more models.
next() - Method in interface freemarker.template.TemplateListModel
Deprecated.  
next() - Method in class freemarker.template.SimpleIterator
 
next() - Method in class freemarker.ext.beans.IteratorModel
Calls Iterator.next().
next() - Method in class freemarker.ext.beans.EnumerationModel
Calls Iterator.next().
NO_PARSE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
NodeListModel - class freemarker.ext.jdom.NodeListModel.
Provides a template for wrapping JDOM objects.
NodeListModel(Document) - Constructor for class freemarker.ext.jdom.NodeListModel
Creates a node set template that holds a single Document node.
NodeListModel(Element) - Constructor for class freemarker.ext.jdom.NodeListModel
Creates a node set template that holds a single Element node.
NodeListModel(List) - Constructor for class freemarker.ext.jdom.NodeListModel
Creates a node set template that holds a list of nodes.
NodeListModel(List, boolean) - Constructor for class freemarker.ext.jdom.NodeListModel
Creates a node set template that holds a list of nodes.
NonNumericalException - exception freemarker.template.compiler.NonNumericalException.
A subclass of TemplateException that indicates that the internals expected an expression to evaluate to a numerical value and it didn't.
NonNumericalException() - Constructor for class freemarker.template.compiler.NonNumericalException
 
NonNumericalException(String) - Constructor for class freemarker.template.compiler.NonNumericalException
 
NOPARSE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
NoParse() - Method in class freemarker.template.compiler.FMParser
 
NormalizeNewlines - class freemarker.template.utility.NormalizeNewlines.
Transformer that supports FreeMarker legacy behaviour: all newlines appearing within the transformed area will be transformed into the platform's default newline.
NormalizeNewlines() - Constructor for class freemarker.template.utility.NormalizeNewlines
Creates new NormalizeNewlines
NOT - Static variable in interface freemarker.template.compiler.FMParserConstants
 
NOT_EQUALS - Static variable in interface freemarker.template.compiler.FMParserConstants
 
NumberLiteral() - Method in class freemarker.template.compiler.FMParser
 
NumberModel - class freemarker.ext.beans.NumberModel.
Wraps arbitrary subclass of Number into a reflective model.
NumberModel(Number) - Constructor for class freemarker.ext.beans.NumberModel
Creates a new model that wraps the specified number object.
NUMERICAL_ESCAPE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
NumericalOutput() - Method in class freemarker.template.compiler.FMParser
 
NumericalRange - class freemarker.template.NumericalRange.
A class that represents a Range between two integers.
NumericalRange(int, int) - Constructor for class freemarker.template.NumericalRange
 

O

OPEN_BRACE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
OPEN_BRACKET - Static variable in interface freemarker.template.compiler.FMParserConstants
 
OPEN_PAREN - Static variable in interface freemarker.template.compiler.FMParserConstants
 
OptionalBlock() - Method in class freemarker.template.compiler.FMParser
A production for a block of optional content.
OR - Static variable in interface freemarker.template.compiler.FMParserConstants
 
OrExpression() - Method in class freemarker.template.compiler.FMParser
 
OUTPUT_ESCAPE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
outputRawFile(String, String, Writer) - Method in interface freemarker.template.TemplateCache
Simply outputs the given file from the cache without any template processing.
outputRawFile(String, String, Writer) - Method in class freemarker.template.FileTemplateCache
 

P

PAGE_SCOPE - Static variable in class freemarker.ext.jsp.JspContextModel
 
Parenthesis() - Method in class freemarker.template.compiler.FMParser
 
ParseException - exception freemarker.template.compiler.ParseException.
This exception is thrown when parse errors are encountered.
ParseException() - Constructor for class freemarker.template.compiler.ParseException
The following constructors are for use by you for whatever purpose you can think of.
ParseException(String) - Constructor for class freemarker.template.compiler.ParseException
 
ParseException(Token, int[][], String[]) - Constructor for class freemarker.template.compiler.ParseException
This constructor is used by the method "generateParseException" in the generated parser.
PCDATA - Static variable in interface freemarker.template.compiler.FMParserConstants
 
PCData() - Method in class freemarker.template.compiler.FMParser
Production for a block of raw text i.e.
PERCENT - Static variable in interface freemarker.template.compiler.FMParserConstants
 
PLUS - Static variable in interface freemarker.template.compiler.FMParserConstants
 
postTemplateProcess(HttpServletRequest, HttpServletResponse, Template, TemplateModelRoot) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called after the execution returns from template.process().
preprocessRequest(HttpServletRequest, HttpServletResponse) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called as the first step in request processing, before the templating mechanism is put to work.
preTemplateProcess(HttpServletRequest, HttpServletResponse, Template, TemplateModelRoot) - Method in class freemarker.ext.servlet.FreemarkerServlet
Called before the execution is passed to template.process().
PrimaryExpression() - Method in class freemarker.template.compiler.FMParser
Lowest level expression, a literal, a variable, or a possibly more complex expression bounded by parentheses.
printStackTrace(PrintStream) - Method in class freemarker.template.TemplateException
 
printStackTrace(PrintWriter) - Method in class freemarker.template.TemplateException
 
process(TemplateModelRoot, OutputStream) - Method in class freemarker.template.Template
Processes the template, using data from a template model, and outputs the resulting HTML to an output stream using the encoding for the template.
process(TemplateModelRoot, Writer) - Method in class freemarker.template.Template
Processes the template, using data from a template model, and outputs the resulting HTML to a Writer.
process(TemplateModelRoot, Writer) - Method in class freemarker.template.compiler.TemplateElement
Processes the contents of this TemplateElement and outputs the resulting text to a Writer.
process(TemplateModelRoot, Writer) - Method in class freemarker.template.compiler.Function
 
process(TemplateModelRoot, Writer, Object) - Method in class freemarker.template.Template
Processes the contents of this TemplateElement and outputs the resulting text to a Writer.
process(Writer) - Method in class freemarker.template.Template
Processes the template, using an empty data model, and outputs the resulting HTML to a Writer.
put(Object, Object) - Method in class freemarker.ext.util.IdentityHashMap
Associates the specified value with the specified key in this map.
put(String, boolean) - Method in class freemarker.template.SimpleHash
Puts a boolean in the hash, by first wrapping the boolean in a SimpleScalar.
put(String, Number) - Method in class freemarker.template.SimpleHash
 
put(String, String) - Method in class freemarker.template.SimpleHash
Puts a string in the hash, by first wrapping the string in a SimpleScalar.
put(String, TemplateModel) - Method in class freemarker.template.SimpleHash
Puts a TemplateModel in the hash.
put(String, TemplateModel) - Method in interface freemarker.template.TemplateModelRoot
Sets a value in the hash model.
put(String, TemplateModel) - Method in class freemarker.ext.beans.RootMapModel
Puts the specified template model into the map.
putAll(Map) - Method in class freemarker.ext.util.IdentityHashMap
Copies all of the mappings from the specified map to this one.

R

RangeLiteral() - Method in class freemarker.template.compiler.FMParser
 
readChar() - Method in class freemarker.template.compiler.SimpleCharStream
 
registerNamespace(String, String) - Method in class freemarker.ext.jdom.NodeListModel
Registers an XML namespace with this node list.
ReInit(FMParserTokenManager) - Method in class freemarker.template.compiler.FMParser
 
ReInit(InputStream) - Method in class freemarker.template.compiler.SimpleCharStream
 
ReInit(InputStream) - Method in class freemarker.template.compiler.FMParser
 
ReInit(InputStream, int, int) - Method in class freemarker.template.compiler.SimpleCharStream
 
ReInit(InputStream, int, int, int) - Method in class freemarker.template.compiler.SimpleCharStream
 
ReInit(Reader) - Method in class freemarker.template.compiler.SimpleCharStream
 
ReInit(Reader) - Method in class freemarker.template.compiler.FMParser
 
ReInit(Reader, int, int) - Method in class freemarker.template.compiler.SimpleCharStream
 
ReInit(Reader, int, int, int) - Method in class freemarker.template.compiler.SimpleCharStream
 
ReInit(SimpleCharStream) - Method in class freemarker.template.compiler.FMParserTokenManager
 
ReInit(SimpleCharStream, int) - Method in class freemarker.template.compiler.FMParserTokenManager
 
release() - Method in class freemarker.ext.jsp.FreemarkerTag
 
remove(Object) - Method in class freemarker.ext.util.IdentityHashMap
Removes the mapping for this key from this map if present.
remove(String) - Method in class freemarker.template.SimpleHash
Removes the given key from the underlying hash.
remove(String) - Method in interface freemarker.template.TemplateModelRoot
Removes a key from the hash model.
remove(String) - Method in class freemarker.ext.beans.RootMapModel
Removes the template model with the specified key from the map.
REQUEST_SCOPE - Static variable in class freemarker.ext.jsp.JspContextModel
 
ResourceBundleModel - class freemarker.ext.beans.ResourceBundleModel.
A hash model that wraps a resource bundle.
ResourceBundleModel(ResourceBundle) - Constructor for class freemarker.ext.beans.ResourceBundleModel
 
RETURN - Static variable in interface freemarker.template.compiler.FMParserConstants
 
rewind() - Method in interface freemarker.template.TemplateListModel
Deprecated. Resets the cursor to the beginning of the list.
Root() - Method in class freemarker.template.compiler.FMParser
Root production to be used when parsing an entire file.
rootElement - Variable in class freemarker.template.Template
 
RootMapModel - class freemarker.ext.beans.RootMapModel.
A wrapper for an arbitrary map that will expose it as a TemplateModelRoot.
RootMapModel() - Constructor for class freemarker.ext.beans.RootMapModel
Creates a new model with its own internal map.
RootMapModel(Map) - Constructor for class freemarker.ext.beans.RootMapModel
Creates a new model that adds TemplateModelRoot behavior to the passed map.

S

SEMICOLON - Static variable in interface freemarker.template.compiler.FMParserConstants
 
serialVersionUID - Static variable in class freemarker.ext.servlet.FreemarkerServlet
 
serialVersionUID - Static variable in class freemarker.ext.util.IdentityHashMap
 
ServletContextHashModel - class freemarker.ext.servlet.ServletContextHashModel.
TemplateHashModel wrapper for a ServletContext attributes.
ServletContextHashModel(ServletContext) - Constructor for class freemarker.ext.servlet.ServletContextHashModel
 
SESSION_SCOPE - Static variable in class freemarker.ext.jsp.JspContextModel
 
setBasedir(File) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Set the base directory.
setBodyContent(BodyContent) - Method in class freemarker.ext.jsp.FreemarkerTag
 
setCache(TemplateCache) - Method in class freemarker.template.Template
Sets the cache that this object is stored in.
setCaching(boolean) - Method in class freemarker.ext.jsp.FreemarkerTag
 
setClassicCompatibility(boolean) - Static method in class freemarker.template.Template
Sets a flag to indicate that we should run in "classic compatibility mode".
setDebugMode(boolean) - Static method in class freemarker.template.Template
If the debug mode is set to true (the default currently) all stack traces thrown by the process() method are simply output to the output stream (the web client in the case of a servlet-based app.) If it is false, the exception is simply rethrown and it is up to the application programmer to catch the exception and deal with it gracefully.
setDebugStream(PrintStream) - Method in class freemarker.template.compiler.FMParserTokenManager
 
setDefaultEncoding(String) - Method in class freemarker.template.FileTemplateCache
 
setDelay(int) - Method in class freemarker.template.FileTemplateCache
Sets the delay in seconds between checking for newer versions of a file.
setDestdir(File) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Set the destination directory into which the generated files should be copied to
setEncoding(String) - Method in class freemarker.template.Template
 
setEncoding(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Set encoding for generated files.
setExtension(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Set the output file extension.
setIncremental(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Turn on/off incremental processing.
setLocale(Locale) - Method in class freemarker.template.SimpleHash
 
setLocale(Locale) - Method in interface freemarker.template.TemplateModelRoot
sets the locale to be used for number/date formatting (A hook for later user currently -- revusky)
setLocale(Locale) - Method in class freemarker.template.Template
 
setLocale(Locale) - Method in class freemarker.ext.beans.RootMapModel
 
setName(String) - Method in class freemarker.template.Template
 
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
setTemplate(String) - Method in class freemarker.ext.ant.FreemarkerXmlTask
Set the path to the template file
SimpleCharStream - class freemarker.template.compiler.SimpleCharStream.
An implementation of interface CharStream, where the stream is assumed to contain only ASCII characters (without unicode processing).
SimpleCharStream(InputStream) - Constructor for class freemarker.template.compiler.SimpleCharStream
 
SimpleCharStream(InputStream, int, int) - Constructor for class freemarker.template.compiler.SimpleCharStream
 
SimpleCharStream(InputStream, int, int, int) - Constructor for class freemarker.template.compiler.SimpleCharStream
 
SimpleCharStream(Reader) - Constructor for class freemarker.template.compiler.SimpleCharStream
 
SimpleCharStream(Reader, int, int) - Constructor for class freemarker.template.compiler.SimpleCharStream
 
SimpleCharStream(Reader, int, int, int) - Constructor for class freemarker.template.compiler.SimpleCharStream
 
SimpleHash - class freemarker.template.SimpleHash.
A simple implementation of the TemplateHashModelEx and TemplateModelRoot interfaces, using an underlying HashMap.
SimpleHash() - Constructor for class freemarker.template.SimpleHash
Constructs an empty SimpleHash.
SimpleHash(Map) - Constructor for class freemarker.template.SimpleHash
Constructs a SimpleHash given the backing Map.
SimpleIterator - class freemarker.template.SimpleIterator.
This is a simple adapter that wraps any java.util.Iterator as a freemarker.template.TemplateModelIterator.
SimpleIterator(Iterator) - Constructor for class freemarker.template.SimpleIterator
 
SimpleList - class freemarker.template.SimpleList.
Deprecated. Use SimpleSequence instead.
SimpleList() - Constructor for class freemarker.template.SimpleList
Deprecated.  
SimpleList(List) - Constructor for class freemarker.template.SimpleList
Deprecated.  
SimpleNumber - class freemarker.template.SimpleNumber.
A simple implementation of the TemplateNumberModel interface.
SimpleNumber(int) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(Number) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(Number, Locale) - Constructor for class freemarker.template.SimpleNumber
 
SimpleNumber(Number, NumberFormat) - Constructor for class freemarker.template.SimpleNumber
 
SimpleScalar - class freemarker.template.SimpleScalar.
A simple implementation of the TemplateScalarModel interface, using a String or a boolean.
SimpleScalar(boolean) - Constructor for class freemarker.template.SimpleScalar
Constructs a SimpleScalar containing a boolean value.
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 SimpleSequence with an indefinite shelf life.
SimpleSequence(List) - Constructor for class freemarker.template.SimpleSequence
Constructs a SimpleSequence from the given List It makes a copy for internal use.
SimpleSequence(TemplateCollectionModel) - Constructor for class freemarker.template.SimpleSequence
 
size() - Method in class freemarker.template.SimpleHash
 
size() - Method in interface freemarker.template.TemplateSequenceModel
 
size() - Method in class freemarker.template.NumericalRange
 
size() - Method in class freemarker.template.SimpleSequence
 
size() - Method in interface freemarker.template.TemplateHashModelEx
 
size() - Method in class freemarker.ext.beans.CollectionModel
 
size() - Method in class freemarker.ext.beans.ArrayModel
 
size() - Method in class freemarker.ext.jdom.NodeListModel
 
size() - Method in class freemarker.ext.util.IdentityHashMap
Returns the number of key-value mappings in this map.
specialConstructor - Variable in class freemarker.template.compiler.ParseException
This variable determines which constructor was used to create this object and thereby affects the semantics of the "getMessage" method (see below).
specialToken - Variable in class freemarker.template.compiler.Token
This field is used to access special tokens that occur prior to this token, but after the immediately preceding regular (non-special) token.
START_TAG - Static variable in interface freemarker.template.compiler.FMParserConstants
 
staticFlag - Static variable in class freemarker.template.compiler.SimpleCharStream
 
StaticModel - class freemarker.ext.beans.StaticModel.
Wraps the static fields and methods of a class in a TemplateHashModel.
StaticModels - class freemarker.ext.beans.StaticModels.
Utility class for instantiating StaticModel instances from templates.
STOP - Static variable in interface freemarker.template.compiler.FMParserConstants
 
StopException - exception freemarker.template.compiler.StopException.
This exception is thrown when a <stop> directive is encountered.
StopException() - Constructor for class freemarker.template.compiler.StopException
 
STRING_LITERAL - Static variable in interface freemarker.template.compiler.FMParserConstants
 
StringLiteral() - Method in class freemarker.template.compiler.FMParser
 
StringOutput() - Method in class freemarker.template.compiler.FMParser
A production representing the ${...} that outputs a variable.
SWITCH - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Switch() - Method in class freemarker.template.compiler.FMParser
 
SwitchTo(int) - Method in class freemarker.template.compiler.FMParserTokenManager
 
synchronizedWrapper() - Method in class freemarker.template.SimpleHash
 
synchronizedWrapper() - Method in class freemarker.template.SimpleSequence
 

T

Template - class freemarker.template.Template.
An application or servlet can instantiate a subclass of Template to compile and process an HTML template.
Template() - Constructor for class freemarker.template.Template
Constructs an empty template.
Template(File) - Constructor for class freemarker.template.Template
Deprecated. Expect this to be removed later. You should either pass in a Reader, or an explicit encoding.
Template(InputStream) - Constructor for class freemarker.template.Template
Deprecated. Expect this to be removed later. You should either pass in a Reader, or an explicit encoding.
Template(Reader) - Constructor for class freemarker.template.Template
Constructs a template by compiling it from an Reader.
Template(String) - Constructor for class freemarker.template.Template
Deprecated. Expect this to be removed later. You should either pass in a Reader, or an explicit encoding.
Template(TemplateCache, InputStream) - Constructor for class freemarker.template.Template
 
Template(TemplateCache, InputStream, Locale) - Constructor for class freemarker.template.Template
 
Template(TemplateCache, InputStream, String) - Constructor for class freemarker.template.Template
 
Template(TemplateCache, Reader, Locale) - Constructor for class freemarker.template.Template
 
TemplateCache - interface freemarker.template.TemplateCache.
An interface for caches that store compiled templates.
TemplateCollectionModel - interface freemarker.template.TemplateCollectionModel.
This interface can be implemented to make a variable "foreach-able", i.e.
TemplateElement - class freemarker.template.compiler.TemplateElement.
Objects that represent elements in the compiled tree representation of the template necessarily descend from this abstract class.
TemplateException - exception freemarker.template.TemplateException.
The FreeMarker classes use this exception internally.
TemplateException() - Constructor for class freemarker.template.TemplateException
Constructs a TemplateException with no specified detail message or underlying cause.
TemplateException(Exception) - Constructor for class freemarker.template.TemplateException
Constructs a TemplateException with the given underlying Exception, but no detail message.
TemplateException(String) - Constructor for class freemarker.template.TemplateException
Constructs a TemplateException with the given detail message, but no underlying cause exception.
TemplateException(String, Exception) - Constructor for class freemarker.template.TemplateException
Constructs a TemplateException with both a description of the error that occurred and the underlying Exception that caused this exception to be raised.
TemplateHashModel - interface freemarker.template.TemplateHashModel.
Hashes in a template data model must implement this interface.
TemplateHashModelEx - interface freemarker.template.TemplateHashModelEx.
An extended hash interface with a couple of extra hooks.
TemplateListModel - interface freemarker.template.TemplateListModel.
Deprecated. This interface is deprecated because it has inherent design problems. Use TemplateSequenceModel or TemplateCollectionModel instead.
TemplateMethodModel - interface freemarker.template.TemplateMethodModel.
Method calls 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.
A template's data model must be a tree of objects, each of which implements a subinterface of TemplateModel.
TemplateModelException - exception freemarker.template.TemplateModelException.
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.
TemplateModelRoot - interface freemarker.template.TemplateModelRoot.
The root node of a template data model must implement this interface.
TemplateNumberModel - interface freemarker.template.TemplateNumberModel.
Scalar values in a template data model must implement this interface.
TemplateScalarModel - interface freemarker.template.TemplateScalarModel.
Scalar 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, which essentially has a single interface that returns the i-th element.
TemplateTransformModel - interface freemarker.template.TemplateTransformModel.
Transformations in a template data model must implement this interface.
TIMES - Static variable in interface freemarker.template.compiler.FMParserConstants
 
token - Variable in class freemarker.template.compiler.FMParser
 
Token - class freemarker.template.compiler.Token.
Describes the input token stream.
token_source - Variable in class freemarker.template.compiler.FMParser
 
Token() - Constructor for class freemarker.template.compiler.Token
 
tokenImage - Variable in class freemarker.template.compiler.ParseException
This is a reference to the "tokenImage" array of the generated parser within which the parse error occurred.
tokenImage - Static variable in interface freemarker.template.compiler.FMParserConstants
 
TokenMgrError - error freemarker.template.compiler.TokenMgrError.
 
TokenMgrError() - Constructor for class freemarker.template.compiler.TokenMgrError
 
TokenMgrError(boolean, int, int, int, String, char, int) - Constructor for class freemarker.template.compiler.TokenMgrError
 
TokenMgrError(String, int) - Constructor for class freemarker.template.compiler.TokenMgrError
 
toString() - Method in class freemarker.template.SimpleHash
Convenience method for returning the String value of the underlying hash.
toString() - Method in class freemarker.template.SimpleNumber
 
toString() - Method in class freemarker.template.SimpleScalar
 
toString() - Method in class freemarker.template.compiler.Token
Returns the image.
toString() - Method in class freemarker.template.compiler.Function
 
toString(TemplateModelRoot) - Method in class freemarker.template.Template
 
transcode(String) - Method in class freemarker.ext.servlet.HttpRequestParametersHashModel
 
TRANSFORM - Static variable in interface freemarker.template.compiler.FMParserConstants
 
Transform() - Method in class freemarker.template.compiler.FMParser
 
transform(Reader, Writer) - Method in interface freemarker.template.TemplateTransformModel
Performs a transformation/filter on FreeMarker output.
transform(Reader, Writer) - Method in class freemarker.template.utility.CompressWhitespace
Compresses whitespace within the marked portion of a FreeMarker template.
transform(Reader, Writer) - Method in class freemarker.template.utility.XmlEscape
Transforms an XML-unescaped stream into XML-escaped form.
transform(Reader, Writer) - Method in class freemarker.template.utility.FreeMarkerToHtml
Performs a transformation/filter on FreeMarker output.
transform(Reader, Writer) - Method in class freemarker.template.utility.HtmlEscape
Transforms an HTML-unescaped stream into HTML-escaped form.
transform(Reader, Writer) - Method in class freemarker.template.utility.NormalizeNewlines
Performs newline normalization on FreeMarker output.
transform(Reader, Writer) - Method in class freemarker.template.utility.LegacyCompress
Re-implementation of the <compress> FreeMarker tag.
transform(Reader, Writer) - Method in class freemarker.template.utility.JavaToHtml
Performs a transformation/filter on FreeMarker output.
TRUE - Static variable in class freemarker.template.SimpleScalar
 
TRUE - Static variable in interface freemarker.template.compiler.FMParserConstants
 
TRUE - Static variable in class freemarker.ext.beans.BooleanScalar
TemplateScalarModel for representing boolean true value

U

UnaryExpression() - Method in class freemarker.template.compiler.FMParser
A primary expression preceded by zero or more unary operators.
UnparsedContent() - Method in class freemarker.template.compiler.FMParser
Production for dealing with unparsed content, i.e.
unwrap(Object) - Static method in class freemarker.ext.beans.BeansWrapper
Attempts to unwrap a model into underlying object.

V

values() - Method in class freemarker.template.SimpleHash
 
values() - Method in interface freemarker.template.TemplateHashModelEx
 
values() - Method in class freemarker.ext.util.IdentityHashMap
Returns a collection view of the values contained in this map.
Variable() - Method in class freemarker.template.compiler.FMParser
 
VariableRange(Expression) - Method in class freemarker.template.compiler.FMParser
 

W

wrap(Object) - Static method in class freemarker.ext.beans.BeansWrapper
Wraps the object with a template model that is most specific for the object's class.

X

XmlEscape - class freemarker.template.utility.XmlEscape.
Performs an XML escape of a given template fragment.
XmlEscape() - Constructor for class freemarker.template.utility.XmlEscape
Creates new XmlEscape

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