org.tinygroup.template

Interface Macro

All Superinterfaces:

Updatable

All Known Implementing Classes:

AbstractBlockMacro, AbstractMacro, MacroFromContext

public interface Macro
extends Updatable

宏，就可以理解为一个对方法，它有输入参数，但没有输出参数，而是直接针对Writer对象进行内容输出 Created by luoguo on 2014/6/6.

Method Summary

Modifier and Type	Method and Description
String	getMacroPath() 获得宏文件路径
String	getName() 返回宏的名字
List<EvaluateExpression>	getParameterDefaultValues() 返回宏的参数的默认值
String	getParameterName(int index) 返回指定索引的参数名，如果越界，则返回null
List<String>	getParameterNames() 返回宏的参数名称
TemplateEngine	getTemplateEngine() 获得模板引擎
void	render(Template template, TemplateContext pageContext, TemplateContext context, OutputStream outputStream) 进行渲染
void	setMacroPath(String macroPath) 设置宏文件路径
void	setTemplateEngine(TemplateEngine templateEngine) 设置模板引擎

Methods inherited from interface org.tinygroup.template.Updatable

getAbsolutePath, getLastModifiedTime, setAbsolutePath, setLastModifiedTime

Method Detail

getName

String getName()

返回宏的名字

Returns:

getParameterNames

List<String> getParameterNames()

返回宏的参数名称

Returns:

getParameterName

String getParameterName(int index)

返回指定索引的参数名，如果越界，则返回null

Parameters:

index -

Returns:

getParameterDefaultValues

List<EvaluateExpression> getParameterDefaultValues()

返回宏的参数的默认值

Returns:

getTemplateEngine

TemplateEngine getTemplateEngine()

获得模板引擎

Returns:

setTemplateEngine

void setTemplateEngine(TemplateEngine templateEngine)

设置模板引擎

Parameters:

templateEngine -

getMacroPath

String getMacroPath()

获得宏文件路径

Returns:

setMacroPath

void setMacroPath(String macroPath)

设置宏文件路径

Parameters:

macroPath -

render

void render(Template template,
            TemplateContext pageContext,
            TemplateContext context,
            OutputStream outputStream)
     throws TemplateException

进行渲染

Parameters:

context -

outputStream -

Throws:

TemplateException