Package org.miaixz.bus.extra.template.provider.freemarker

Class FreemarkerProvider

java.lang.Object

org.miaixz.bus.extra.template.provider.freemarker.FreemarkerProvider

All Implemented Interfaces:

org.miaixz.bus.core.lang.Wrapper<Object>, org.miaixz.bus.core.Provider, TemplateProvider

public class FreemarkerProvider
extends Object
implements TemplateProvider

FreeMarker模板引擎封装 见：https://freemarker.apache.org/

Since:

Java 17+

Author:

Kimi Liu

Constructor Summary

Constructors

Constructor	Description
FreemarkerProvider()	默认构造
FreemarkerProvider(freemarker.template.Configuration freemarkerCfg)	构造
FreemarkerProvider(TemplateConfig config)	构造

Method Summary

Modifier and Type	Method	Description
freemarker.template.Configuration	getRaw()	获取原始引擎的钩子方法，用于自定义特殊属性，如插件等
Template	getTemplate(String resource)	获取模板
TemplateProvider	init(TemplateConfig config)	使用指定配置文件初始化模板引擎

Methods inherited from class java.lang.Object

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

Methods inherited from interface org.miaixz.bus.core.lang.Wrapper

type

Constructor Details

FreemarkerProvider

public FreemarkerProvider()

默认构造

FreemarkerProvider

public FreemarkerProvider(TemplateConfig config)

构造

Parameters:

config - 模板配置

FreemarkerProvider

public FreemarkerProvider(freemarker.template.Configuration freemarkerCfg)

构造

Parameters:

freemarkerCfg - Configuration

Method Details

init

public TemplateProvider init(TemplateConfig config)

Description copied from interface: TemplateProvider

使用指定配置文件初始化模板引擎

Specified by:

init in interface TemplateProvider

Parameters:

config - 配置文件

Returns:

this

getTemplate

public Template getTemplate(String resource)

Description copied from interface: TemplateProvider

获取模板

Specified by:

getTemplate in interface TemplateProvider

Parameters:

resource - 资源，根据实现不同，此资源可以是模板本身，也可以是模板的相对路径

Returns:

模板实现

getRaw

public freemarker.template.Configuration getRaw()

获取原始引擎的钩子方法，用于自定义特殊属性，如插件等

Specified by:

getRaw in interface org.miaixz.bus.core.lang.Wrapper<Object>

Returns:

Configuration