A C E F G H I L N P R S T U V

A

add(boolean) - Method in class freemarker.template.SimpleList
Adds a boolean to the end of this SimpleList, by first wrapping the boolean in a SimpleScalar.
add(String) - Method in class freemarker.template.SimpleList
Adds a string to the end of this SimpleList, by first wrapping the string in a SimpleScalar.
add(TemplateModel) - Method in class freemarker.template.SimpleList
Adds a TemplateModel to the end of this SimpleList.
addCacheListener(CacheListener) - Method in interface freemarker.template.TemplateCache
Registers a CacheListener for this TemplateCache.
addCacheListener(CacheListener) - Method in class freemarker.template.FileTemplateCache
 
addFunction(FunctionInstruction) - Method in class freemarker.template.Template
Adds a function to the template.
addListener(EventListener) - Method in class freemarker.template.GenericEventMulticaster
 

C

CacheEvent - class freemarker.template.CacheEvent.
An event fired by self-updating caches.
CacheEvent(Object) - Constructor for class freemarker.template.CacheEvent
 
CacheListener - interface freemarker.template.CacheListener.
An interface for classes that listen for CacheEvents.
cacheUnavailable(CacheEvent) - Method in interface freemarker.template.CacheListener
Called when a cache cannot be updated.
clear() - Method in class freemarker.template.SimpleList
Removes all the elements from this SimpleList.
compileFromFile(File) - Method in class freemarker.template.Template
Reads and compiles a template from a file, by getting the file's FileInputStream and using it to call compileFromStream(), using the platform's default character encoding.
compileFromFile(String) - Method in class freemarker.template.Template
Reads and compiles a template from a file, by getting the file's FileInputStream and using it to call compileFromStream(), using the platform's default character encoding.
compileFromStream(InputStream) - Method in class freemarker.template.Template
Compiles the template from an InputStream, using the platform's default character encoding.
compileFromStream(InputStreamReader) - Method in class freemarker.template.Template
Compiles the template from an InputStreamReader.
compileText(String) - Method in class freemarker.template.Template
Compiles the template text using the standard parser and builder classes.
copy(TemplateListModel) - Method in class freemarker.template.SimpleList
Discards the contents of this SimpleList, and copies into it the values from another TemplateListModel.
copyRequest(ServletRequest) - Static method in class freemarker.template.TemplateServletUtils
Copies the parameters from a ServletRequest into an empty data model, in a hash called request.
copyRequest(ServletRequest, TemplateModelRoot) - Static method in class freemarker.template.TemplateServletUtils
Copies the parameters from a ServletRequest into a data model, in a hash called request.

E

elementRemoved(CacheEvent) - Method in interface freemarker.template.CacheListener
Called when an element is removed from the cache.
elementUpdated(CacheEvent) - Method in interface freemarker.template.CacheListener
Called when a cache element updates successfully.
elementUpdateFailed(CacheEvent) - Method in interface freemarker.template.CacheListener
Called when a cache element fails to update.
exec(List) - Method in interface freemarker.template.TemplateMethodModel
Executes a method call.

F

FileTemplateCache - class freemarker.template.FileTemplateCache.
A TemplateCache that loads templates from a filesystem.
FileTemplateCache() - Constructor for class freemarker.template.FileTemplateCache
Constructs an empty FileTemplateCache.
FileTemplateCache(File) - Constructor for class freemarker.template.FileTemplateCache
Constructs a TemplateCache with a directory in which it will look for template files.
FileTemplateCache(File, long) - Constructor for class freemarker.template.FileTemplateCache
Constructs a TemplateCache with a directory in which it will look for template files, and a delay representing the number of seconds between cache updates.
FileTemplateCache(String) - Constructor for class freemarker.template.FileTemplateCache
Constructs a TemplateCache with a directory in which it will look for template files.
FileTemplateCache(String, long) - Constructor for class freemarker.template.FileTemplateCache
Constructs a TemplateCache with a directory in which it will look for template files, and a delay representing the number of seconds between cache updates.
fireEvent(EventObject, EventListener) - Method in interface freemarker.template.ListenerAdapter
 
fireEvent(EventObject, ListenerAdapter) - Method in class freemarker.template.GenericEventMulticaster
Fires an event to all the listeners of this multicaster, using a ListenerAdapter.
formatErrorMessage(String) - Static method in class freemarker.template.Template
Used by FreeMarker classes to format an error message as an HTML comment.
freemarker.template - package freemarker.template
Allows Java servlets and applications to generate HTML pages based on templates, so that graphic design can be kept separate from application logic.

G

GenericEventMulticaster - class freemarker.template.GenericEventMulticaster.
A generic event multicaster class.
GenericEventMulticaster() - Constructor for class freemarker.template.GenericEventMulticaster
 
get(String) - Method in class freemarker.template.SimpleHash
 
get(String) - Method in interface freemarker.template.TemplateHashModel
Gets a TemplateModel from the hash.
getAsString() - Method in class freemarker.template.SimpleScalar
 
getAsString() - Method in interface freemarker.template.TemplateScalarModel
Returns the scalar's value as a String.
getElementName() - Method in class freemarker.template.CacheEvent
 
getException() - Method in class freemarker.template.CacheEvent
 
getFunction(String) - Method in class freemarker.template.Template
Retrieves a function from the template.
getFunctionNames() - Method in class freemarker.template.Template
 
getShelfLife() - Method in class freemarker.template.SimpleList
 
getStackTrace(Exception) - Static method in class freemarker.template.Template
Used by FreeMarker classes to format a stack trace as a string.
getTemplate(String) - Method in interface freemarker.template.TemplateCache
Gets a template from the cache.
getTemplate(String) - Method in class freemarker.template.FileTemplateCache
Gets a template from the cache.
getTemplateCache() - Method in class freemarker.template.Template
Gets the TemplateCache that this template belongs to.

H

hash - Variable in class freemarker.template.SimpleHash
 
hasNext() - Method in interface freemarker.template.TemplateListModel
 
hasNext() - Method in class freemarker.template.SimpleList
 

I

isEmpty() - Method in interface freemarker.template.TemplateModel
 
isEmpty() - Method in class freemarker.template.SimpleScalar
 
isEmpty() - Method in class freemarker.template.SimpleHash
 
isEmpty() - Method in class freemarker.template.SimpleList
 
isPermanent() - Method in class freemarker.template.SimpleList
 
isRewound() - Method in interface freemarker.template.TemplateListModel
 
isRewound() - Method in class freemarker.template.SimpleList
 
isStale() - Method in class freemarker.template.SimpleList
 

L

ListenerAdapter - interface freemarker.template.ListenerAdapter.
An interface for adapters that GenericEventMulticaster can use to fire an event.
LOAD_ON_DEMAND - Static variable in class freemarker.template.FileTemplateCache
Used with setLoadingPolicy() to indicate that templates should be loaded as they are requested.

N

next() - Method in interface freemarker.template.TemplateListModel
 
next() - Method in class freemarker.template.SimpleList
 

P

PRELOAD - Static variable in class freemarker.template.FileTemplateCache
Used with setLoadingPolicy() to indicate that templates should be preloaded.
process(PrintWriter) - Method in class freemarker.template.Template
Processes the template, using an empty data model, and outputs the resulting HTML to a PrintWriter.
process(TemplateModelRoot, PrintWriter) - Method in interface freemarker.template.TemplateProcessor
Processes the contents of this TemplateProcessor and outputs the resulting text to a PrintWriter.
process(TemplateModelRoot, PrintWriter) - Method in class freemarker.template.Template
Processes the template, using data from a template model, and outputs the resulting HTML to a PrintWriter.
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, 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.

R

remove(String) - Method in class freemarker.template.SimpleHash
 
remove(String) - Method in interface freemarker.template.TemplateModelRoot
Removes a key from the hash model.
removeCacheListener(CacheListener) - Method in interface freemarker.template.TemplateCache
Unregisters a CacheListener for this TemplateCache.
removeCacheListener(CacheListener) - Method in class freemarker.template.FileTemplateCache
 
removeListener(EventListener) - Method in class freemarker.template.GenericEventMulticaster
 
rewind() - Method in interface freemarker.template.TemplateListModel
Resets the cursor to the beginning of the list.
rewind() - Method in class freemarker.template.SimpleList
 
run() - Method in class freemarker.template.UpdateTimer
 

S

setDelay(long) - Method in class freemarker.template.FileTemplateCache
 
setDelay(long) - Method in class freemarker.template.UpdateTimer
 
setDirectory(File) - Method in class freemarker.template.FileTemplateCache
 
setElementName(String) - Method in class freemarker.template.CacheEvent
 
setEncoding(String) - Method in class freemarker.template.FileTemplateCache
Sets the character encoding to be used when reading template files.
setException(Exception) - Method in class freemarker.template.CacheEvent
 
setFilenameSuffix(String) - Method in class freemarker.template.FileTemplateCache
 
setLoadingPolicy(int) - Method in class freemarker.template.FileTemplateCache
Sets the loading policy for this FileTemplateCache.
setPath(String) - Method in class freemarker.template.FileTemplateCache
 
setPermanent() - Method in class freemarker.template.SimpleList
Gives this SimpleList an indefinite shelf life.
setShelfLife(int) - Method in class freemarker.template.SimpleList
Sets the amount of time before this SimpleList will become stale.
setTarget(Updatable) - Method in class freemarker.template.UpdateTimer
 
setTemplateCache(TemplateCache) - Method in class freemarker.template.Template
Sets the TemplateCache that this template belongs to.
setValue(boolean) - Method in class freemarker.template.SimpleScalar
Sets the boolean value of this SimpleScalar.
setValue(String) - Method in class freemarker.template.SimpleScalar
Sets the string value of this SimpleScalar.
SimpleHash - class freemarker.template.SimpleHash.
A simple implementation of the TemplateHashModel and TemplateModelRoot interfaces, using a HashMap.
SimpleHash() - Constructor for class freemarker.template.SimpleHash
Constructs an empty SimpleHash.
SimpleList - class freemarker.template.SimpleList.
A simple implementation of the TemplateListModel interface, using a LinkedList.
SimpleList() - Constructor for class freemarker.template.SimpleList
Constructs an empty SimpleList with an indefinite shelf life.
SimpleList(TemplateListModel) - Constructor for class freemarker.template.SimpleList
Constructs a SimpleList, copying into it the values from another TemplateListModel.
SimpleScalar - class freemarker.template.SimpleScalar.
A simple implementation of the TemplateScalarModel interface, using a String.
SimpleScalar() - Constructor for class freemarker.template.SimpleScalar
Constructs an empty SimpleScalar.
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.
startAutoUpdate() - Method in interface freemarker.template.TemplateCache
Begins automatic updates of the cache.
startAutoUpdate() - Method in class freemarker.template.FileTemplateCache
 
startTiming() - Method in class freemarker.template.UpdateTimer
Begins periodic automatic updates of the target.
stopAutoUpdate() - Method in interface freemarker.template.TemplateCache
Stops automatically updating the cache.
stopAutoUpdate() - Method in class freemarker.template.FileTemplateCache
 
stopTiming() - Method in class freemarker.template.UpdateTimer
Stops automatically updating the target.

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
Constructs a template by compiling it from a file.
Template(InputStream) - Constructor for class freemarker.template.Template
Constructs a template by compiling it from an InputStream.
Template(InputStreamReader) - Constructor for class freemarker.template.Template
Constructs a template by compiling it from an InputStreamReader.
Template(String) - Constructor for class freemarker.template.Template
Constructs a template by compiling it from a file.
TemplateCache - interface freemarker.template.TemplateCache.
An interface for self-updating caches of compiled Templates.
TemplateException - exception freemarker.template.TemplateException.
The FreeMarker classes use this exception internally.
TemplateException() - Constructor for class freemarker.template.TemplateException
 
TemplateException(String) - Constructor for class freemarker.template.TemplateException
 
TemplateHashModel - interface freemarker.template.TemplateHashModel.
Hashes in a template data model must implement this interface.
TemplateListModel - interface freemarker.template.TemplateListModel.
List values in a template data model must implement this interface, which is essentially the Iterator interface plus a rewind() method that allows the list to be read again.
TemplateMethodModel - interface freemarker.template.TemplateMethodModel.
Method calls in a template data model must implement this interface.
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 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(String) - Constructor for class freemarker.template.TemplateModelException
Constructs a TemplateModelException with the specified detail message.
TemplateModelRoot - interface freemarker.template.TemplateModelRoot.
The root node of a template data model must implement this interface.
TemplateProcessor - interface freemarker.template.TemplateProcessor.
Objects representing compiled templates must implement this interface.
TemplateScalarModel - interface freemarker.template.TemplateScalarModel.
Scalar values in a template data model must implement this interface.
TemplateServletUtils - class freemarker.template.TemplateServletUtils.
A class containing static utility methods to facilitate using templates with servlets.
TemplateServletUtils() - Constructor for class freemarker.template.TemplateServletUtils
 

U

Updatable - interface freemarker.template.Updatable.
An interface for objects that need to be reminded to update themselves from time to time.
update() - Method in class freemarker.template.FileTemplateCache
Updates the cache.
update() - Method in interface freemarker.template.Updatable
 
UpdateTimer - class freemarker.template.UpdateTimer.
A timer for objects that implement Updatable.
UpdateTimer() - Constructor for class freemarker.template.UpdateTimer
 
UpdateTimer(Updatable, long) - Constructor for class freemarker.template.UpdateTimer
 

V

value - Variable in class freemarker.template.SimpleScalar
 
A C E F G H I L N P R S T U V