cn.hutool.extra.template

Class TemplateConfig

java.lang.Object

cn.hutool.extra.template.TemplateConfig

All Implemented Interfaces:

Serializable

public class TemplateConfig
extends Object
implements Serializable

模板配置

Since:

4.1.0

Author:

looly

See Also:

Serialized Form

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	TemplateConfig.ResourceMode 资源加载方式枚举

Field Summary

Fields

Modifier and Type	Field and Description
static TemplateConfig	DEFAULT

Constructor Summary

Constructors

Constructor and Description
TemplateConfig() 默认构造，使用UTF8编码，默认从ClassPath获取模板
TemplateConfig(Charset charset, String path, TemplateConfig.ResourceMode resourceMode) 构造
TemplateConfig(String path) 构造，默认UTF-8编码
TemplateConfig(String path, TemplateConfig.ResourceMode resourceMode) 构造，默认UTF-8编码

Method Summary

Modifier and Type	Method and Description
boolean	equals(Object o)
Charset	getCharset() 获取编码
String	getCharsetStr() 获取编码
Class<? extends TemplateEngine>	getCustomEngine() 获取自定义引擎，null表示系统自动判断
String	getPath() 获取模板路径，如果ClassPath或者WebRoot模式，则表示相对路径
TemplateConfig.ResourceMode	getResourceMode() 获取模板资源加载方式
int	hashCode()
void	setCharset(Charset charset) 设置编码
TemplateConfig	setCustomEngine(Class<? extends TemplateEngine> customEngine) 设置自定义引擎，null表示系统自动判断
void	setPath(String path) 设置模板路径，如果ClassPath或者WebRoot模式，则表示相对路径
void	setResourceMode(TemplateConfig.ResourceMode resourceMode) 设置模板资源加载方式

Methods inherited from class java.lang.Object

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

Field Detail

DEFAULT

public static final TemplateConfig DEFAULT

Constructor Detail

TemplateConfig

public TemplateConfig()

默认构造，使用UTF8编码，默认从ClassPath获取模板

TemplateConfig

public TemplateConfig(String path)

构造，默认UTF-8编码

Parameters:

path - 模板路径，如果ClassPath或者WebRoot模式，则表示相对路径

TemplateConfig

public TemplateConfig(String path,
                      TemplateConfig.ResourceMode resourceMode)

构造，默认UTF-8编码

Parameters:

path - 模板路径，如果ClassPath或者WebRoot模式，则表示相对路径

resourceMode - 模板资源加载方式

TemplateConfig

public TemplateConfig(Charset charset,
                      String path,
                      TemplateConfig.ResourceMode resourceMode)

构造

Parameters:

charset - 编码

path - 模板路径，如果ClassPath或者WebRoot模式，则表示相对路径

resourceMode - 模板资源加载方式

Method Detail

getCharset

public Charset getCharset()

获取编码

Returns:

编码

getCharsetStr

public String getCharsetStr()

获取编码

Returns:

编码

Since:

4.1.11

setCharset

public void setCharset(Charset charset)

设置编码

Parameters:

charset - 编码

getPath

public String getPath()

获取模板路径，如果ClassPath或者WebRoot模式，则表示相对路径

Returns:

模板路径

setPath

public void setPath(String path)

设置模板路径，如果ClassPath或者WebRoot模式，则表示相对路径

Parameters:

path - 模板路径

getResourceMode

public TemplateConfig.ResourceMode getResourceMode()

获取模板资源加载方式

Returns:

模板资源加载方式

setResourceMode

public void setResourceMode(TemplateConfig.ResourceMode resourceMode)

设置模板资源加载方式

Parameters:

resourceMode - 模板资源加载方式

getCustomEngine

public Class<? extends TemplateEngine> getCustomEngine()

获取自定义引擎，null表示系统自动判断

Returns:

自定义引擎，null表示系统自动判断

Since:

5.2.1

setCustomEngine

public TemplateConfig setCustomEngine(Class<? extends TemplateEngine> customEngine)

设置自定义引擎，null表示系统自动判断

Parameters:

customEngine - 自定义引擎，null表示系统自动判断

Returns:

this

Since:

5.2.1

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object