cn.hutool.extra.template.engine.beetl

类 BeetlUtil

java.lang.Object

cn.hutool.extra.template.engine.beetl.BeetlUtil

public final class BeetlUtil
extends Object

Beetl模板引擎工具类
http://git.oschina.net/xiandafu/beetl2.0
文档：http://ibeetl.com/guide/beetl.html

作者:

Looly

嵌套类概要

嵌套类

限定符和类型	类和说明
static class	BeetlUtil.ResourceLoaderBuilder ResourceLoader构建器

构造器概要

构造器

构造器和说明
BeetlUtil()

方法概要

方法

限定符和类型	方法和说明
static org.beetl.core.GroupTemplate	createClassPathGroupTemplate(String path) 创建字符串的模板组 GroupTemplate，配置文件使用全局默认 此时自定义的配置文件可在ClassPath中放入beetl.properties配置
static org.beetl.core.GroupTemplate	createFileGroupTemplate(String dir) 创建文件目录的模板组 GroupTemplate，配置文件使用全局默认，使用UTF-8编码 此时自定义的配置文件可在ClassPath中放入beetl.properties配置
static org.beetl.core.GroupTemplate	createFileGroupTemplate(String dir, Charset charset) 创建文件目录的模板组 GroupTemplate，配置文件使用全局默认 此时自定义的配置文件可在ClassPath中放入beetl.properties配置
static org.beetl.core.GroupTemplate	createGroupTemplate() 创建默认模板组GroupTemplate，默认的模板组从ClassPath中读取
static org.beetl.core.GroupTemplate	createGroupTemplate(org.beetl.core.ResourceLoader loader) 创建自定义的模板组 GroupTemplate，配置文件使用全局默认 此时自定义的配置文件可在ClassPath中放入beetl.properties配置
static org.beetl.core.GroupTemplate	createGroupTemplate(org.beetl.core.ResourceLoader loader, org.beetl.core.Configuration conf) 创建自定义的 GroupTemplate
static org.beetl.core.GroupTemplate	createStrGroupTemplate() 创建字符串的模板组 GroupTemplate，配置文件使用全局默认 此时自定义的配置文件可在ClassPath中放入beetl.properties配置
static org.beetl.core.GroupTemplate	createWebAppGroupTemplate() 创建WebApp的模板组 GroupTemplate，配置文件使用全局默认 此时自定义的配置文件可在ClassPath中放入beetl.properties配置
static org.beetl.core.Template	getClassPathTemplate(String path, String templateFileName) 获得ClassPath模板
static org.beetl.core.Template	getFileTemplate(String dir, String templateFileName) 获得本地文件模板
static org.beetl.core.Template	getStrTemplate(String source) 获得字符串模板
static org.beetl.core.Template	getTemplate(org.beetl.core.GroupTemplate groupTemplate, String source) 获得模板
static String	render(String path, String templateFileName, Map<String,Object> bindingMap) 渲染模板，如果为相对路径，则渲染ClassPath模板，否则渲染本地文件模板
static String	render(org.beetl.core.Template template, Map<String,Object> bindingMap) 渲染模板
static Writer	render(org.beetl.core.Template templateContent, Map<String,Object> bindingMap, Writer writer) 渲染模板
static String	renderFromStr(String templateContent, Map<String,Object> bindingMap) 渲染模板
static Writer	renderFromStr(String templateContent, Map<String,Object> bindingMap, Writer writer) 渲染模板
static BeetlUtil.ResourceLoaderBuilder	resourceLoaderBuilder() 开始构建 BeetlUtil.ResourceLoaderBuilder，调用BeetlUtil.ResourceLoaderBuilder.build()完成构建

从类继承的方法 java.lang.Object

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

构造器详细资料

BeetlUtil

public BeetlUtil()

方法详细资料

createGroupTemplate

public static org.beetl.core.GroupTemplate createGroupTemplate()

创建默认模板组GroupTemplate，默认的模板组从ClassPath中读取

返回:

GroupTemplate

createStrGroupTemplate

public static org.beetl.core.GroupTemplate createStrGroupTemplate()

创建字符串的模板组 GroupTemplate，配置文件使用全局默认
此时自定义的配置文件可在ClassPath中放入beetl.properties配置

返回:

GroupTemplate

从以下版本开始:

3.2.0

createWebAppGroupTemplate

public static org.beetl.core.GroupTemplate createWebAppGroupTemplate()

创建WebApp的模板组 GroupTemplate，配置文件使用全局默认
此时自定义的配置文件可在ClassPath中放入beetl.properties配置

返回:

GroupTemplate

从以下版本开始:

3.2.0

createClassPathGroupTemplate

public static org.beetl.core.GroupTemplate createClassPathGroupTemplate(String path)

创建字符串的模板组 GroupTemplate，配置文件使用全局默认
此时自定义的配置文件可在ClassPath中放入beetl.properties配置

参数:

path - 相对ClassPath的路径

返回:

GroupTemplate

从以下版本开始:

3.2.0

createFileGroupTemplate

public static org.beetl.core.GroupTemplate createFileGroupTemplate(String dir)

创建文件目录的模板组 GroupTemplate，配置文件使用全局默认，使用UTF-8编码
此时自定义的配置文件可在ClassPath中放入beetl.properties配置

参数:

dir - 目录路径（绝对路径）

返回:

GroupTemplate

从以下版本开始:

3.2.0

createFileGroupTemplate

public static org.beetl.core.GroupTemplate createFileGroupTemplate(String dir,
                                                   Charset charset)

创建文件目录的模板组 GroupTemplate，配置文件使用全局默认
此时自定义的配置文件可在ClassPath中放入beetl.properties配置

参数:

dir - 目录路径（绝对路径）

charset - 读取模板文件的编码

返回:

GroupTemplate

从以下版本开始:

3.2.0

createGroupTemplate

public static org.beetl.core.GroupTemplate createGroupTemplate(org.beetl.core.ResourceLoader loader)

创建自定义的模板组 GroupTemplate，配置文件使用全局默认
此时自定义的配置文件可在ClassPath中放入beetl.properties配置

参数:

loader - ResourceLoader，资源加载器

返回:

GroupTemplate

从以下版本开始:

3.2.0

createGroupTemplate

public static org.beetl.core.GroupTemplate createGroupTemplate(org.beetl.core.ResourceLoader loader,
                                               org.beetl.core.Configuration conf)

创建自定义的 GroupTemplate

参数:

loader - ResourceLoader，资源加载器

conf - Configuration 配置文件

返回:

GroupTemplate

getTemplate

public static org.beetl.core.Template getTemplate(org.beetl.core.GroupTemplate groupTemplate,
                                  String source)

获得模板

参数:

groupTemplate - GroupTemplate

source - 模板资源，根据不同的 ResourceLoader 加载不同的模板资源

返回:

Template

getStrTemplate

public static org.beetl.core.Template getStrTemplate(String source)

获得字符串模板

参数:

source - 模板内容

返回:

模板

从以下版本开始:

3.2.0

getClassPathTemplate

public static org.beetl.core.Template getClassPathTemplate(String path,
                                           String templateFileName)

获得ClassPath模板

参数:

path - ClassPath路径

templateFileName - 模板内容

返回:

模板

从以下版本开始:

3.2.0

getFileTemplate

public static org.beetl.core.Template getFileTemplate(String dir,
                                      String templateFileName)

获得本地文件模板

参数:

dir - 目录绝对路径

templateFileName - 模板内容

返回:

模板

从以下版本开始:

3.2.0

render

public static String render(org.beetl.core.Template template,
            Map<String,Object> bindingMap)

渲染模板

参数:

template - Template

bindingMap - 绑定参数

返回:

渲染后的内容

render

public static String render(String path,
            String templateFileName,
            Map<String,Object> bindingMap)

渲染模板，如果为相对路径，则渲染ClassPath模板，否则渲染本地文件模板

参数:

path - 路径

templateFileName - 模板文件名

bindingMap - 绑定参数

返回:

渲染后的内容

从以下版本开始:

3.2.0

renderFromStr

public static String renderFromStr(String templateContent,
                   Map<String,Object> bindingMap)

渲染模板

参数:

templateContent - 模板内容

bindingMap - 绑定参数

返回:

渲染后的内容

从以下版本开始:

3.2.0

render

public static Writer render(org.beetl.core.Template templateContent,
            Map<String,Object> bindingMap,
            Writer writer)

渲染模板

参数:

templateContent - Template

bindingMap - 绑定参数

writer - Writer 渲染后写入的目标Writer

返回:

Writer

renderFromStr

public static Writer renderFromStr(String templateContent,
                   Map<String,Object> bindingMap,
                   Writer writer)

渲染模板

参数:

templateContent - 模板内容

bindingMap - 绑定参数

writer - Writer 渲染后写入的目标Writer

返回:

Writer

resourceLoaderBuilder

public static BeetlUtil.ResourceLoaderBuilder resourceLoaderBuilder()

开始构建 BeetlUtil.ResourceLoaderBuilder，调用BeetlUtil.ResourceLoaderBuilder.build()完成构建

返回:

BeetlUtil.ResourceLoaderBuilder