org.dromara.hutool.setting

Class SettingLoader

java.lang.Object

org.dromara.hutool.setting.SettingLoader

public class SettingLoader
extends Object

Setting文件加载器

Author:

Looly

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static interface	SettingLoader.ValueEditor 值编辑器，用于在加载配置文件时对值进行编辑，例如解密等 此接口用于在加载配置文件时，编辑值，例如解密等，从而加载出明文的配置值

Constructor Summary

Constructors

Constructor and Description
SettingLoader(Charset charset, boolean isUseVariable) 构造

Method Summary

Modifier and Type	Method and Description
GroupedMap	load(InputStream settingStream) 加载设置文件。
GroupedMap	load(Resource resource) 加载设置文件
SettingLoader	setAssignFlag(char assignFlag) 赋值分隔符（用于分隔键值对）
SettingLoader	setValueEditor(SettingLoader.ValueEditor valueEditor) 设置值编辑器，用于在获取值后编辑返回值，例如解密等 编辑器函数接受一个参数，此参数为待编辑的值，函数返回编辑后的值 注意：此函数调用在变量替换前
SettingLoader	setVarRegex(String regex) 设置变量的正则 正则只能有一个group表示变量本身，剩余为字符 例如 \$\{(name)\}表示${name}变量名为name的一个变量表示
void	store(GroupedMap groupedMap, File file) 持久化当前设置，会覆盖掉之前的设置 持久化会不会保留之前的分组
void	store(GroupedMap groupedMap, String absolutePath) 持久化当前设置，会覆盖掉之前的设置 持久化会不会保留之前的分组

Methods inherited from class java.lang.Object

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

Constructor Detail

SettingLoader

public SettingLoader(Charset charset,
                     boolean isUseVariable)

构造

Parameters:

charset - 编码

isUseVariable - 是否使用变量

Method Detail

setVarRegex

public SettingLoader setVarRegex(String regex)

设置变量的正则
正则只能有一个group表示变量本身，剩余为字符 例如 \$\{(name)\}表示${name}变量名为name的一个变量表示

Parameters:

regex - 正则

Returns:

this

setAssignFlag

public SettingLoader setAssignFlag(char assignFlag)

赋值分隔符（用于分隔键值对）

Parameters:

assignFlag - 正则

Returns:

this

Since:

4.6.5

setValueEditor

public SettingLoader setValueEditor(SettingLoader.ValueEditor valueEditor)

设置值编辑器，用于在获取值后编辑返回值，例如解密等
编辑器函数接受一个参数，此参数为待编辑的值，函数返回编辑后的值
注意：此函数调用在变量替换前

Parameters:

valueEditor - 编辑器函数

Returns:

this

Since:

6.0.0

load

public GroupedMap load(Resource resource)

加载设置文件

Parameters:

resource - 配置文件URL

Returns:

加载是否成功

load

public GroupedMap load(InputStream settingStream)
                throws IOException

加载设置文件。 此方法不会关闭流对象

Parameters:

settingStream - 文件流

Returns:

GroupedMap

Throws:

IOException - IO异常

store

public void store(GroupedMap groupedMap,
                  String absolutePath)

持久化当前设置，会覆盖掉之前的设置
持久化会不会保留之前的分组

Parameters:

groupedMap - 分组map

absolutePath - 设置文件的绝对路径

store

public void store(GroupedMap groupedMap,
                  File file)

持久化当前设置，会覆盖掉之前的设置
持久化会不会保留之前的分组

Parameters:

groupedMap - 分组map

file - 设置文件