com.xiaoleilu.hutool.setting.dialect

类 BasicSetting

java.lang.Object

com.xiaoleilu.hutool.setting.AbsSetting

com.xiaoleilu.hutool.setting.dialect.BasicSetting

直接已知子类:

Setting

public class BasicSetting
extends AbsSetting

分组设置工具类。 用于支持设置文件
1、支持变量，默认变量命名为 ${变量名}，变量只能识别读入行的变量，例如第6行的变量在第三行无法读取 2、支持分组，分组为中括号括起来的内容，中括号以下的行都为此分组的内容，无分组相当于空字符分组
若某个key是name，加上分组后的键相当于group.name 3、注释以#开头，但是空行和不带“=”的行也会被跳过，但是建议加# 4、store方法不会保存注释内容，慎重使用

作者:

xiaoleilu

字段概要

字段

限定符和类型	字段和说明
static String	DEFAULT_CHARSET 默认字符集
static String	DEFAULT_DELIMITER 数组类型值默认分隔符

构造器概要

构造器

构造器和说明
BasicSetting(Charset charset, boolean isUseVariable) 基本构造 需自定义初始化配置文件
BasicSetting(File configFile, String charset, boolean isUseVariable) 构造
BasicSetting(String pathBaseClassLoader) 构造
BasicSetting(String path, Class<?> clazz, String charset, boolean isUseVariable) 构造，相对于classes读取文件
BasicSetting(String pathBaseClassLoader, String charset, boolean isUseVariable) 构造，使用相对于Class文件根目录的相对路径
BasicSetting(URL url, String charset, boolean isUseVariable) 构造

方法概要

方法

限定符和类型	方法和说明
Set<Map.Entry<String,String>>	entrySet()
String	getByGroup(String key, String group) 获得指定分组的键对应值
LinkedList<String>	getGroups()
String	getSettingPath()
String	getStr(String key) 获取字符串型属性值
boolean	init(URL settingUrl, String charset, boolean isUseVariable) 初始化设定文件
boolean	load(InputStream settingStream, boolean isUseVariable) 加载设置文件。
boolean	load(URL settingUrl) 加载设置文件
void	reload() 重新加载配置文件
void	setSetting(String key, Object value) 设置值，无给定键创建之。
void	setVarRegex(String regex) 设置变量的正则 正则只能有一个group表示变量本身，剩余为字符 例如 \$\{(name)\}表示${name}变量名为name的一个变量表示
int	size()
void	store(String absolutePath) 持久化当前设置，会覆盖掉之前的设置 持久化会不会保留之前的分组
void	store(String path, Class<?> clazz) 存储当前设置，会覆盖掉以前的设置
void	toObject(Object object) 将setting中的键值关系映射到对象中，原理是调用对象对应的set方法 只支持基本类型的转换
void	toObject(String group, Object object) 将setting中的键值关系映射到对象中，原理是调用对象对应的set方法 只支持基本类型的转换
Properties	toProperties() 转换为Properties对象，原分组变为前缀

从类继承的方法 com.xiaoleilu.hutool.setting.AbsSetting

getBigDecimal, getBigDecimal, getBigInteger, getBigInteger, getBool, getBool, getByte, getByte, getChar, getChar, getDouble, getDouble, getInt, getInt, getLong, getLong, getShort, getShort, getStr, isEmpty

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

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

字段详细资料

DEFAULT_CHARSET

public static final String DEFAULT_CHARSET

默认字符集

另请参阅:

常量字段值

DEFAULT_DELIMITER

public static final String DEFAULT_DELIMITER

数组类型值默认分隔符

另请参阅:

常量字段值

构造器详细资料

BasicSetting

public BasicSetting(Charset charset,
            boolean isUseVariable)

基本构造
需自定义初始化配置文件

参数:

charset - 字符集

isUseVariable - 是否使用变量

BasicSetting

public BasicSetting(String pathBaseClassLoader,
            String charset,
            boolean isUseVariable)

构造，使用相对于Class文件根目录的相对路径

参数:

pathBaseClassLoader - 相对路径（相对于当前项目的classes路径）

charset - 字符集

isUseVariable - 是否使用变量

BasicSetting

public BasicSetting(File configFile,
            String charset,
            boolean isUseVariable)

构造

参数:

configFile - 配置文件对象

charset - 字符集

isUseVariable - 是否使用变量

BasicSetting

public BasicSetting(String path,
            Class<?> clazz,
            String charset,
            boolean isUseVariable)

构造，相对于classes读取文件

参数:

path - 相对路径

clazz - 基准类

charset - 字符集

isUseVariable - 是否使用变量

BasicSetting

public BasicSetting(URL url,
            String charset,
            boolean isUseVariable)

构造

参数:

url - 设定文件的URL

charset - 字符集

isUseVariable - 是否使用变量

BasicSetting

public BasicSetting(String pathBaseClassLoader)

构造

参数:

pathBaseClassLoader - 相对路径（相对于当前项目的classes路径）

方法详细资料

init

public boolean init(URL settingUrl,
           String charset,
           boolean isUseVariable)

初始化设定文件

参数:

settingUrl - 设定文件的URL

charset - 字符集

isUseVariable - 是否使用变量

返回:

成功初始化与否

load

public boolean load(URL settingUrl)

加载设置文件

参数:

settingUrl - 配置文件URL

返回:

加载是否成功

reload

public void reload()

重新加载配置文件

load

public boolean load(InputStream settingStream,
           boolean isUseVariable)
             throws IOException

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

参数:

settingStream - 文件流

isUseVariable - 是否使用变量（替换配置文件值中含有的变量）

返回:

加载成功与否

抛出:

IOException

setVarRegex

public void setVarRegex(String regex)

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

参数:

regex - 正则

getSettingPath

public String getSettingPath()

返回:

获得设定文件的路径

size

public int size()

指定者:

size 在类中 AbsSetting

返回:

配置文件大小（key的个数）

getStr

public String getStr(String key)

获取字符串型属性值

指定者:

getStr 在类中 AbsSetting

参数:

key - 属性名

返回:

属性值

getByGroup

public String getByGroup(String key,
                String group)

获得指定分组的键对应值

参数:

key - 键

group - 分组

返回:

值

setSetting

public void setSetting(String key,
              Object value)

设置值，无给定键创建之。设置后未持久化

参数:

key - 键

value - 值

store

public void store(String absolutePath)

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

参数:

absolutePath - 设置文件的绝对路径

store

public void store(String path,
         Class<?> clazz)

存储当前设置，会覆盖掉以前的设置

参数:

path - 相对路径

clazz - 相对的类

toObject

public void toObject(String group,
            Object object)
              throws SettingException

将setting中的键值关系映射到对象中，原理是调用对象对应的set方法
只支持基本类型的转换

参数:

object - 被调用的对象

抛出:

SettingException

toObject

public void toObject(Object object)
              throws SettingException

将setting中的键值关系映射到对象中，原理是调用对象对应的set方法
只支持基本类型的转换

参数:

object -

抛出:

SettingException

toProperties

public Properties toProperties()

转换为Properties对象，原分组变为前缀

返回:

Properties对象

getGroups

public LinkedList<String> getGroups()

返回:

获得所有分组名

entrySet

public Set<Map.Entry<String,String>> entrySet()