org.tinygroup.template.impl

Class AbstractMacro

java.lang.Object

org.tinygroup.template.impl.AbstractMacro

All Implemented Interfaces:

Macro, Updatable

Direct Known Subclasses:

AbstractBlockMacro

public abstract class AbstractMacro
extends Object
implements Macro

抽象宏 Created by luoguo on 2014/6/6.

Constructor Summary

Constructors

Constructor and Description
AbstractMacro(String name)
AbstractMacro(String name, List<String> parameterNames, List<EvaluateExpression> parameterDefaultValues)
AbstractMacro(String name, Macro bodyContentMacro)

Method Summary

Modifier and Type	Method and Description
protected void	addParameter(String parameterName, EvaluateExpression defaultValue)
String	getAbsolutePath()
Macro	getBodyContentMacro()
long	getLastModifiedTime()
protected Macro	getMacro(TemplateContext $context)
String	getMacroPath() 获得宏文件路径
String	getName() 返回宏的名字
List<EvaluateExpression>	getParameterDefaultValues() 返回宏的参数的默认值
String	getParameterName(int index) 返回指定索引的参数名，如果越界，则返回null
List<String>	getParameterNames() 返回宏的参数名称
TemplateEngine	getTemplateEngine() 获得模板引擎
protected void	init(String name)
void	render(Template template, TemplateContext pageContext, TemplateContext context, OutputStream outputStream) 进行渲染
protected abstract void	renderMacro(Template template, TemplateContext pageContext, TemplateContext context, OutputStream outputStream)
void	setAbsolutePath(String path)
void	setLastModifiedTime(long time)
void	setMacroPath(String macroPath) 设置宏文件路径
void	setParameterDefaultValues(List<EvaluateExpression> parameterDefaultValues)
void	setParameterNames(List<String> parameterNames)
void	setTemplateEngine(TemplateEngine templateEngine) 设置模板引擎

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

AbstractMacro

public AbstractMacro(String name)

AbstractMacro

public AbstractMacro(String name,
                     Macro bodyContentMacro)

AbstractMacro

public AbstractMacro(String name,
                     List<String> parameterNames,
                     List<EvaluateExpression> parameterDefaultValues)

Method Detail

getMacro

protected Macro getMacro(TemplateContext $context)

getBodyContentMacro

public Macro getBodyContentMacro()

addParameter

protected void addParameter(String parameterName,
                            EvaluateExpression defaultValue)

getTemplateEngine

public TemplateEngine getTemplateEngine()

Description copied from interface: Macro

获得模板引擎

Specified by:

getTemplateEngine in interface Macro

Returns:

setTemplateEngine

public void setTemplateEngine(TemplateEngine templateEngine)

Description copied from interface: Macro

设置模板引擎

Specified by:

setTemplateEngine in interface Macro

getParameterDefaultValues

public List<EvaluateExpression> getParameterDefaultValues()

Description copied from interface: Macro

返回宏的参数的默认值

Specified by:

getParameterDefaultValues in interface Macro

Returns:

setParameterDefaultValues

public void setParameterDefaultValues(List<EvaluateExpression> parameterDefaultValues)

init

protected void init(String name)

render

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

Description copied from interface: Macro

进行渲染

Specified by:

render in interface Macro

Throws:

TemplateException

renderMacro

protected abstract void renderMacro(Template template,
                                    TemplateContext pageContext,
                                    TemplateContext context,
                                    OutputStream outputStream)
                             throws IOException,
                                    TemplateException

Throws:

IOException

TemplateException

getName

public String getName()

Description copied from interface: Macro

返回宏的名字

Specified by:

getName in interface Macro

Returns:

getParameterNames

public List<String> getParameterNames()

Description copied from interface: Macro

返回宏的参数名称

Specified by:

getParameterNames in interface Macro

Returns:

setParameterNames

public void setParameterNames(List<String> parameterNames)

getParameterName

public String getParameterName(int index)

Description copied from interface: Macro

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

Specified by:

getParameterName in interface Macro

Returns:

getMacroPath

public String getMacroPath()

Description copied from interface: Macro

获得宏文件路径

Specified by:

getMacroPath in interface Macro

Returns:

setMacroPath

public void setMacroPath(String macroPath)

Description copied from interface: Macro

设置宏文件路径

Specified by:

setMacroPath in interface Macro

getLastModifiedTime

public long getLastModifiedTime()

Specified by:

getLastModifiedTime in interface Updatable

setLastModifiedTime

public void setLastModifiedTime(long time)

Specified by:

setLastModifiedTime in interface Updatable

getAbsolutePath

public String getAbsolutePath()

Specified by:

getAbsolutePath in interface Updatable

setAbsolutePath

public void setAbsolutePath(String path)

Specified by:

setAbsolutePath in interface Updatable