freemarker.template
Interface FunctionTemplateProcessor

All Superinterfaces:
TemplateProcessor
All Known Implementing Classes:
Template

public interface FunctionTemplateProcessor
extends TemplateProcessor

Adds the ability to retrieve Template functions from a TemplateProcessor. Used by IncludeInstruction to retrieve a list of callable Functions.

Version:
$Id: FunctionTemplateProcessor.java,v 1.5 2003/11/03 03:33:31 run2000 Exp $

Method Summary
 void addFunction(FunctionInstruction function)
          Adds a function to the template.
 FunctionInstruction getFunction(java.lang.String name)
          Retrieves a function from the template.
 java.util.Set getFunctionNames()
          Retrieve a Set of function names for this template.
 
Methods inherited from interface freemarker.template.TemplateProcessor
process
 

Method Detail

getFunction

public FunctionInstruction getFunction(java.lang.String name)
Retrieves a function from the template. Called by CallInstructions and IncludeInstructions at run-time.
Parameters:
name - the name of the function to be retrieved

getFunctionNames

public java.util.Set getFunctionNames()
Retrieve a Set of function names for this template.
Returns:
a Set of function names (String objects) that have been defined for this template.

addFunction

public void addFunction(FunctionInstruction function)
Adds a function to the template. Called by the TemplateBuilder at compile-time.
Parameters:
function - the function to be stored by the template