TemplateEngineDefault (tiny-码云(gitee.com))

java.lang.Object
- org.tinygroup.template.impl.TemplateEngineDefault

All Implemented Interfaces:

TemplateContextOperator, TemplateEngine
```
public class TemplateEngineDefault
extends Object
implements TemplateEngine
```
模板引擎实现类 Created by luoguo on 2014/6/6.

Field Summary

Fields
Modifier and Type Field and Description

static TemplateInterpreter interpreter
- Fields inherited from interface org.tinygroup.template.TemplateEngine
  DEFAULT_BEAN_NAME

Fields
Modifier and Type	Field and Description
`static TemplateInterpreter`	`interpreter`

Constructor Summary

Constructors
Constructor and Description

TemplateEngineDefault()

Constructors
Constructor and Description
`TemplateEngineDefault()`

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`addMacroCache(String macroName, Macro macro)` 往缓存中增加宏
`TemplateEngineDefault`	`addResourceLoader(ResourceLoader resourceLoader)` 添加类型加载器
`void`	`addTemplateCache(String path, Template template)` 往缓存中增加模板
`TemplateEngineDefault`	`addTemplateFunction(TemplateFunction function)` 添加函数
`Object`	`executeFunction(Template Template, TemplateContext context, String functionName, Object... parameters)` 执行方法
`Template`	`findLayout(String path)`
`Macro`	`findMacro(Object macroNameObject, 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()` 返回国际化访问接口实现类
`Map<String,Map<String,Macro>>`	`getMacroCache()`
`String`	`getResourceContent(String path)` 获取指定路径资源的内容
`String`	`getResourceContent(String path, String encode)` 获取资源对应的文本
`List<ResourceLoader>`	`getResourceLoaderList()` 返回所有的 Loader
`StaticClassOperator`	`getStaticClassOperator(String name)` 获得静态类操作
`TemplateContext`	`getTemplateContext()` 返回上下文
`TemplateFunction`	`getTemplateFunction(Object object, String methodName)` 返回注册的方法
`TemplateFunction`	`getTemplateFunction(String methodName)` 返回注册的方法
`TemplateInterpreter`	`getTemplateInterpreter()`
`boolean`	`isCheckModified()`
`boolean`	`isCompactMode()` 返回是否是紧凑模式
`boolean`	`isLocaleTemplateEnable()` 是否支持国际化模板
`boolean`	`isSafeVariable()`
`boolean`	`isThrowLexerError()`
`TemplateEngineDefault`	`put(String key, Object value)` 向上下文放置内容
`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)` 设置是否是紧凑模式
`TemplateEngineDefault`	`setEncode(String encode)` 设置编码
`TemplateEngineDefault`	`setI18nVisitor(I18nVisitor i18nVistor)` 设置
`void`	`setLocaleTemplateEnable(boolean localeTemplateEnable)` 设置是否支持国际化模板
`void`	`setResourceLoaderList(List<ResourceLoader> resourceLoaderList)` 设置模板加载器列表
`void`	`setSafeVariable(boolean safeVariable)`
`void`	`setThrowLexerError(boolean throwLexerError)`
`void`	`write(OutputStream outputStream, Object data)`

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

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

Class TemplateEngineDefault

Field Summary

Fields inherited from interface org.tinygroup.template.TemplateEngine

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Field Detail

interpreter

Constructor Detail

TemplateEngineDefault

Method Detail

isLocaleTemplateEnable

setLocaleTemplateEnable

isCheckModified

setCheckModified

isSafeVariable

setSafeVariable

getTemplateInterpreter

isCompactMode

setCompactMode

isThrowLexerError

setThrowLexerError

registerMacroLibrary

registerMacro

registerMacroLibrary

write

getTemplateContext

getI18nVisitor

setI18nVisitor

addTemplateFunction

getTemplateFunction

getTemplateFunction

getEncode

setEncode

addResourceLoader

findTemplate

removeTemplate

findLayout

put

renderMacro

renderMacro

renderTemplate

renderTemplateWithOutLayout

renderTemplate

renderTemplate

renderTemplate

findMacro

executeFunction

getResourceLoaderList

setResourceLoaderList

getResourceContent

getResourceContent

registerStaticClassOperator

getStaticClassOperator

findTemplateCache

findTemplateCache

addTemplateCache

removeTemplateCache

findMacroCache

addMacroCache

removeMacroCache

getMacroCache