org.tinygroup.template

Interface TemplateEngine

All Superinterfaces:

TemplateContextOperator

All Known Implementing Classes:

TemplateEngineDefault

public interface TemplateEngine
extends TemplateContextOperator

模板引擎 Created by luoguo on 2014/6/6.

Field Summary

Fields

Modifier and Type	Field and Description
static String	DEFAULT_BEAN_NAME 默认的bean配置名称

Method Summary

Modifier and Type	Method and Description
void	addMacroCache(String macroName, Macro macro) 往缓存中增加宏
TemplateEngine	addResourceLoader(ResourceLoader resourceLoader) 添加类型加载器
void	addTemplateCache(String path, Template template) 往缓存中增加模板
TemplateEngine	addTemplateFunction(TemplateFunction function) 添加函数
Object	executeFunction(Template template, TemplateContext context, String functionName, Object... parameters) 执行方法
Macro	findMacro(Object macroName, Template template, TemplateContext context) 根据宏名查找要调用的宏
Macro	findMacroCache(String macroName) 从缓存中查找宏
Template	findTemplate(String path) 根据路径查找宏
Template	findTemplateCache(String path) 从缓存中查找模板
Template	findTemplateCache(String path, String absolutePath) 从缓存中查找模板
String	getEncode() 返回编码
I18nVisitor	getI18nVisitor() 返回国际化访问接口实现类
String	getResourceContent(String path) 获取指定路径资源的内容
String	getResourceContent(String path, String encode) 获取资源对应的文本
List<ResourceLoader>	getResourceLoaderList() 返回所有的 Loader
StaticClassOperator	getStaticClassOperator(String name) 获得静态类操作
TemplateFunction	getTemplateFunction(Object object, String methodName) 返回注册的方法
TemplateFunction	getTemplateFunction(String methodName) 返回注册的方法
boolean	isCheckModified()
boolean	isCompactMode() 返回是否是紧凑模式
boolean	isLocaleTemplateEnable() 是否支持国际化模板
boolean	isSafeVariable()
void	registerMacro(Macro macro) 注册单个宏
void	registerMacroLibrary(String path) 注册库文件中所有的宏
void	registerMacroLibrary(Template template) 注册模板文件中所有的宏
void	registerStaticClassOperator(StaticClassOperator operator) 注册静态类操作
void	removeMacroCache(String macroName, String absolutePath) 从缓存中删除宏
void	removeTemplate(String path) 根据路径卸载模板
void	removeTemplateCache(String path, String absolutePath) 从缓存中删除模板
void	renderMacro(Macro macro, Template template, TemplateContext context, OutputStream outputStream) 渲染指定的宏
void	renderMacro(String macroName, Template template, TemplateContext context, OutputStream outputStream) 渲染宏
void	renderTemplate(String path) 采用没有上下文，控制台输出方式进行渲染，如果有布局会同时渲染布局
void	renderTemplate(String path, TemplateContext context, OutputStream outputStream) 根据路径渲染一个模板文件，如果有布局会同时渲染布局
void	renderTemplate(Template template) 采用没有上下文，控制台输出方式进行渲染，主要用于测试
void	renderTemplate(Template template, TemplateContext context, OutputStream outputStream) 直接渲染一个模板，不会应用布局
void	renderTemplateWithOutLayout(String path, TemplateContext context, OutputStream outputStream) 根据路径渲染一个模板文件，但不会渲染布局
void	setCheckModified(boolean checkModified) 是否检查模板是否被修改过
void	setCompactMode(boolean compactMode) 设置是否是紧凑模式
TemplateEngine	setEncode(String encode) 设置编码
TemplateEngine	setI18nVisitor(I18nVisitor i18nVistor) 设置
void	setLocaleTemplateEnable(boolean localeTemplateEnable) 设置是否支持国际化模板
void	setResourceLoaderList(List<ResourceLoader> resourceLoaderList) 设置模板加载器列表
void	setSafeVariable(boolean safeVariable)
void	write(OutputStream outputStream, Object data)

Methods inherited from interface org.tinygroup.template.TemplateContextOperator

getTemplateContext, put

Field Detail

DEFAULT_BEAN_NAME

static final String DEFAULT_BEAN_NAME

默认的bean配置名称

See Also:

Constant Field Values

Method Detail

isSafeVariable

boolean isSafeVariable()

setSafeVariable

void setSafeVariable(boolean safeVariable)

isCheckModified

boolean isCheckModified()

setCheckModified

void setCheckModified(boolean checkModified)

是否检查模板是否被修改过

Parameters:

checkModified -

isCompactMode

boolean isCompactMode()

返回是否是紧凑模式

Returns:

setCompactMode

void setCompactMode(boolean compactMode)

设置是否是紧凑模式

Parameters:

compactMode -

getI18nVisitor

I18nVisitor getI18nVisitor()

返回国际化访问接口实现类

Returns:

setI18nVisitor

TemplateEngine setI18nVisitor(I18nVisitor i18nVistor)

设置

Parameters:

i18nVistor -

addTemplateFunction

TemplateEngine addTemplateFunction(TemplateFunction function)

添加函数

Parameters:

function -

getTemplateFunction

TemplateFunction getTemplateFunction(String methodName)

返回注册的方法

Parameters:

methodName - 注册的方法名

Returns:

getTemplateFunction

TemplateFunction getTemplateFunction(Object object,
                                     String methodName)

返回注册的方法

Parameters:

methodName - 注册的方法名

Returns:

getEncode

String getEncode()

返回编码

Returns:

setEncode

TemplateEngine setEncode(String encode)

设置编码

Parameters:

encode -

Returns:

isLocaleTemplateEnable

boolean isLocaleTemplateEnable()

是否支持国际化模板

Returns:

setLocaleTemplateEnable

void setLocaleTemplateEnable(boolean localeTemplateEnable)

设置是否支持国际化模板

Parameters:

localeTemplateEnable -

addResourceLoader

TemplateEngine addResourceLoader(ResourceLoader resourceLoader)

添加类型加载器

Parameters:

resourceLoader -

getResourceLoaderList

List<ResourceLoader> getResourceLoaderList()

返回所有的 Loader

Returns:

setResourceLoaderList

void setResourceLoaderList(List<ResourceLoader> resourceLoaderList)

设置模板加载器列表

Parameters:

resourceLoaderList -

renderMacro

void renderMacro(String macroName,
                 Template template,
                 TemplateContext context,
                 OutputStream outputStream)
          throws IOException,
                 TemplateException

渲染宏

Parameters:

macroName - 要执行的宏名称

template - 调用宏的模板

context - 上下文

outputStream - 输出器

Throws:

IOException

TemplateException

renderMacro

void renderMacro(Macro macro,
                 Template template,
                 TemplateContext context,
                 OutputStream outputStream)
          throws IOException,
                 TemplateException

渲染指定的宏

Parameters:

macro - 要执行的宏

template - 调用宏的模板

context - 上下文

outputStream - 输出器

Throws:

IOException

TemplateException

renderTemplate

void renderTemplate(String path,
                    TemplateContext context,
                    OutputStream outputStream)
             throws TemplateException

根据路径渲染一个模板文件，如果有布局会同时渲染布局

Parameters:

path - 模板对应的路径

context - 上下文

outputStream - 输出器

Throws:

TemplateException

renderTemplateWithOutLayout

void renderTemplateWithOutLayout(String path,
                                 TemplateContext context,
                                 OutputStream outputStream)
                          throws TemplateException

根据路径渲染一个模板文件，但不会渲染布局

Parameters:

path -

context -

outputStream -

Throws:

TemplateException

renderTemplate

void renderTemplate(String path)
             throws TemplateException

采用没有上下文，控制台输出方式进行渲染，如果有布局会同时渲染布局

Parameters:

path -

Throws:

TemplateException

renderTemplate

void renderTemplate(Template template)
             throws TemplateException

采用没有上下文，控制台输出方式进行渲染，主要用于测试

Parameters:

template -

Throws:

TemplateException

renderTemplate

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

直接渲染一个模板，不会应用布局

Parameters:

template - 要渲染的模板

context - 上下文

outputStream - 输出器

Throws:

TemplateException

findMacro

Macro findMacro(Object macroName,
                Template template,
                TemplateContext context)
         throws TemplateException

根据宏名查找要调用的宏

Parameters:

macroName -

template -

context -

Returns:

Throws:

TemplateException

findTemplate

Template findTemplate(String path)
               throws TemplateException

根据路径查找宏

Parameters:

path -

Returns:

Throws:

TemplateException

removeTemplate

void removeTemplate(String path)
             throws TemplateException

根据路径卸载模板

Parameters:

path -

Throws:

TemplateException

executeFunction

Object executeFunction(Template template,
                       TemplateContext context,
                       String functionName,
                       Object... parameters)
                throws TemplateException

执行方法

Parameters:

functionName -

parameters -

Returns:

Throws:

TemplateException

getResourceContent

String getResourceContent(String path,
                          String encode)
                   throws TemplateException

获取资源对应的文本

Parameters:

path -

Returns:

Throws:

TemplateException

getResourceContent

String getResourceContent(String path)
                   throws TemplateException

获取指定路径资源的内容

Parameters:

path -

Returns:

Throws:

TemplateException

registerMacroLibrary

void registerMacroLibrary(String path)
                   throws TemplateException

注册库文件中所有的宏

Parameters:

path -

Throws:

TemplateException

registerMacro

void registerMacro(Macro macro)
            throws TemplateException

注册单个宏

Parameters:

macro -

Throws:

TemplateException

registerMacroLibrary

void registerMacroLibrary(Template template)
                   throws TemplateException

注册模板文件中所有的宏

Parameters:

template -

Throws:

TemplateException

write

void write(OutputStream outputStream,
           Object data)
    throws TemplateException

Throws:

TemplateException

registerStaticClassOperator

void registerStaticClassOperator(StaticClassOperator operator)
                          throws TemplateException

注册静态类操作

Throws:

TemplateException

getStaticClassOperator

StaticClassOperator getStaticClassOperator(String name)
                                    throws TemplateException

获得静态类操作

Parameters:

name -

Returns:

Throws:

TemplateException

findTemplateCache

Template findTemplateCache(String path)
                    throws TemplateException

从缓存中查找模板

Parameters:

path -

Returns:

Throws:

TemplateException

findTemplateCache

Template findTemplateCache(String path,
                           String absolutePath)
                    throws TemplateException

从缓存中查找模板

Parameters:

path -

Returns:

Throws:

TemplateException

addTemplateCache

void addTemplateCache(String path,
                      Template template)
               throws TemplateException

往缓存中增加模板

Parameters:

path -

template -

Throws:

TemplateException

removeTemplateCache

void removeTemplateCache(String path,
                         String absolutePath)
                  throws TemplateException

从缓存中删除模板

Parameters:

path -

absolutePath -

Throws:

TemplateException

findMacroCache

Macro findMacroCache(String macroName)
              throws TemplateException

从缓存中查找宏

Parameters:

macroName -

Returns:

Throws:

TemplateException

addMacroCache

void addMacroCache(String macroName,
                   Macro macro)
            throws TemplateException

往缓存中增加宏

Parameters:

macroName -

macro -

Throws:

TemplateException

removeMacroCache

void removeMacroCache(String macroName,
                      String absolutePath)
               throws TemplateException

从缓存中删除宏

Parameters:

macroName -

absolutePath -

Throws:

TemplateException