Setting (hutool-setting 4.6.5 API)

java.lang.Object
- cn.hutool.core.getter.OptNullBasicTypeGetter<K>
- - cn.hutool.core.getter.OptNullBasicTypeFromStringGetter<String>
  - - cn.hutool.setting.AbsSetting
    - - cn.hutool.setting.Setting

所有已实现的接口:: BasicTypeGetter<String>, OptBasicTypeGetter<String>, Serializable, Map<String,String>

public class Setting
extends AbsSetting
implements Map<String,String>

设置工具类。用于支持设置（配置）文件
BasicSetting用于替换Properties类，提供功能更加强大的配置文件，同时对Properties文件向下兼容

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

作者:: looly
另请参阅:: 序列化表格

嵌套类概要
- 从接口继承的嵌套类/接口 java.util.Map
  Map.Entry<K,V>

字段概要

字段
限定符和类型	字段和说明
`protected Charset`	`charset` 本设置对象的字符集
`static Charset`	`DEFAULT_CHARSET` 默认字符集
`static String`	`EXT_NAME` 默认配置文件扩展名
`protected boolean`	`isUseVariable` 是否使用变量
`protected URL`	`settingUrl` 设定文件的URL

从类继承的字段 cn.hutool.setting.AbsSetting
DEFAULT_DELIMITER, DEFAULT_GROUP

构造器概要

构造器
构造器和说明
`Setting()` 空构造
`Setting(File configFile, Charset charset, boolean isUseVariable)` 构造
`Setting(String path)` 构造
`Setting(String path, boolean isUseVariable)` 构造
`Setting(String path, Charset charset, boolean isUseVariable)` 构造，使用相对于Class文件根目录的相对路径
`Setting(String path, Class<?> clazz, Charset charset, boolean isUseVariable)` 构造，相对于classes读取文件
`Setting(URL url, Charset charset, boolean isUseVariable)` 构造

方法概要

方法
限定符和类型	方法和说明
`void`	`autoLoad(boolean autoReload)` 在配置文件变更时自动加载
`void`	`clear()` 清空默认分组（空分组）中的所有键值对
`Setting`	`clear(String group)` 清除指定分组下的所有键值对
`boolean`	`containsKey(Object key)` 默认分组（空分组）中是否包含指定key对应的值
`boolean`	`containsKey(String group, String key)` 指定分组中是否包含指定key
`boolean`	`containsValue(Object value)` 默认分组（空分组）中是否包含指定值
`boolean`	`containsValue(String group, String value)` 指定分组中是否包含指定值
`Set<Map.Entry<String,String>>`	`entrySet()` 获取默认分组（空分组）中的所有键值对列表
`Set<Map.Entry<String,String>>`	`entrySet(String group)` 指定分组下所有键值对
`boolean`	`equals(Object obj)`
`String`	`get(Object key)` 获取默认分组（空分组）中指定key对应的值
`String`	`get(String group, String key)` 获取分组对应的值，如果分组不存在或者值不存在则返回null
`Object`	`getAndRemove(String... keys)` 获取并删除键值对，当指定键对应值非空时，返回并删除这个值，后边的键对应的值不再查找
`String`	`getAndRemoveStr(String... keys)` 获取并删除键值对，当指定键对应值非空时，返回并删除这个值，后边的键对应的值不再查找
`String`	`getByGroup(String key, String group)` 获得指定分组的键对应值
`GroupedMap`	`getGroupedMap()` 获取GroupedMap
`List<String>`	`getGroups()` 获取所有分组
`Map<String,String>`	`getMap(String group)` 获得指定分组的所有键值对，此方法获取的是原始键值对，获取的键值对可以被修改
`Properties`	`getProperties(String group)` 获取group分组下所有配置键值对，组成新的`Properties`
`Props`	`getProps(String group)` 获取group分组下所有配置键值对，组成新的`Props`
`Setting`	`getSetting(String group)` 获取group分组下所有配置键值对，组成新的`Setting`
`String`	`getSettingPath()`
`int`	`hashCode()`
`boolean`	`init(Resource resource, Charset charset, boolean isUseVariable)` 初始化设定文件
`boolean`	`isEmpty()`
`boolean`	`isEmpty(String group)` 某个分组对应的键值对是否为空
`Set<String>`	`keySet()` 获取默认分组（空分组）中的所有键列表
`Set<String>`	`keySet(String group)` 指定分组所有键的Set
`boolean`	`load()` 重新加载配置文件
`String`	`put(String key, String value)` 将指定键值对加入到默认分组（空分组）中
`String`	`put(String group, String key, String value)` 将键值对加入到对应分组中
`void`	`putAll(Map<? extends String,? extends String> m)` 将键值对Map加入默认分组（空分组）中
`Setting`	`putAll(String group, Map<? extends String,? extends String> m)` 加入多个键值对到某个分组下
`String`	`remove(Object key)` 移除默认分组（空分组）中指定值
`String`	`remove(String group, Object key)` 从指定分组中删除指定值
`Setting`	`set(String key, String value)` 设置值
`Setting`	`set(String group, String key, String value)` 将键值对加入到对应分组中
`Setting`	`setCharset(Charset charset)` 自定义字符编码
`Setting`	`setVarRegex(String regex)` 设置变量的正则正则只能有一个group表示变量本身，剩余为字符例如 \$\{(name)\}表示${name}变量名为name的一个变量表示
`int`	`size()` 键值总数
`void`	`store(String absolutePath)` 持久化当前设置，会覆盖掉之前的设置持久化不会保留之前的分组
`Properties`	`toProperties()` 转换为Properties对象，原分组变为前缀
`String`	`toString()`
`Collection<String>`	`values()` 获取默认分组（空分组）中的所有值列表
`Collection<String>`	`values(String group)` 指定分组下所有值

从类继承的方法 cn.hutool.setting.AbsSetting
getBool, getBool, getByGroupWithLog, getChar, getDouble, getDouble, getInt, getInt, getLong, getLong, getStr, getStr, getStrings, getStrings, getStrings, getStringsWithDefault, getWithLog, toBean, toBean

从类继承的方法 cn.hutool.core.getter.OptNullBasicTypeFromStringGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDate, getDouble, getEnum, getFloat, getInt, getLong, getObj, getShort

从类继承的方法 cn.hutool.core.getter.OptNullBasicTypeGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDate, getDouble, getEnum, getFloat, getInt, getLong, getObj, getShort, getStr

从类继承的方法 java.lang.Object
clone, finalize, getClass, notify, notifyAll, wait, wait, wait

- 字段详细资料
  - DEFAULT_CHARSET
```
public static final Charset DEFAULT_CHARSET
```
    默认字符集
  - EXT_NAME
```
public static final String EXT_NAME
```
    默认配置文件扩展名
    
    另请参阅:
    常量字段值
  - charset
```
protected Charset charset
```
    本设置对象的字符集
  - isUseVariable
```
protected boolean isUseVariable
```
    是否使用变量
  - settingUrl
```
protected URL settingUrl
```
    设定文件的URL
- 构造器详细资料
  - Setting
```
public Setting()
```
    空构造
  - Setting
```
public Setting(String path)
```
    构造
    
    参数:
    path - 相对路径或绝对路径
  - Setting
```
public Setting(String path,
       boolean isUseVariable)
```
    构造
    
    参数:
    path - 相对路径或绝对路径
    isUseVariable - 是否使用变量
  - Setting
```
public Setting(String path,
       Charset charset,
       boolean isUseVariable)
```
    构造，使用相对于Class文件根目录的相对路径
    
    参数:
    path - 相对路径或绝对路径
    charset - 字符集
    isUseVariable - 是否使用变量
  - Setting
```
public Setting(File configFile,
       Charset charset,
       boolean isUseVariable)
```
    构造
    
    参数:
    configFile - 配置文件对象
    charset - 字符集
    isUseVariable - 是否使用变量
  - Setting
```
public Setting(String path,
       Class<?> clazz,
       Charset charset,
       boolean isUseVariable)
```
    构造，相对于classes读取文件
    
    参数:
    path - 相对ClassPath路径或绝对路径
    clazz - 基准类
    charset - 字符集
    isUseVariable - 是否使用变量
  - Setting
```
public Setting(URL url,
       Charset charset,
       boolean isUseVariable)
```
    构造
    
    参数:
    url - 设定文件的URL
    charset - 字符集
    isUseVariable - 是否使用变量
- 方法详细资料
  - init
```
public boolean init(Resource resource,
           Charset charset,
           boolean isUseVariable)
```
    初始化设定文件
    
    参数:
    resource - Resource
    charset - 字符集
    isUseVariable - 是否使用变量
    
    返回:
    成功初始化与否
  - load
```
public boolean load()
```
    重新加载配置文件
    
    返回:
    是否加载成功
  - autoLoad
```
public void autoLoad(boolean autoReload)
```
    在配置文件变更时自动加载
    
    参数:
    autoReload - 是否自动加载
  - getSettingPath
```
public String getSettingPath()
```
    返回:
    获得设定文件的路径
  - size
```
public int size()
```
    键值总数
    
    指定者:
    
    size 在接口中 Map<String,String>
    
    返回:
    键值总数
  - getByGroup
```
public String getByGroup(String key,
                String group)
```
    从类复制的说明: AbsSetting
    
    获得指定分组的键对应值
    
    指定者:
    
    getByGroup 在类中 AbsSetting
    
    参数:
    key - 键
    group - 分组
    
    返回:
    值
  - getAndRemove
```
public Object getAndRemove(String... keys)
```
    获取并删除键值对，当指定键对应值非空时，返回并删除这个值，后边的键对应的值不再查找
    
    参数:
    keys - 键列表，常用于别名
    
    返回:
    值
    从以下版本开始:
    
    3.1.2
  - getAndRemoveStr
```
public String getAndRemoveStr(String... keys)
```
    获取并删除键值对，当指定键对应值非空时，返回并删除这个值，后边的键对应的值不再查找
    
    参数:
    keys - 键列表，常用于别名
    
    返回:
    字符串值
    从以下版本开始:
    
    3.1.2
  - getMap
```
public Map<String,String> getMap(String group)
```
    获得指定分组的所有键值对，此方法获取的是原始键值对，获取的键值对可以被修改
    
    参数:
    group - 分组
    
    返回:
    map
  - getSetting
```
public Setting getSetting(String group)
```
    获取group分组下所有配置键值对，组成新的Setting
    
    参数:
    group - 分组
    
    返回:
    Setting
  - getProperties
```
public Properties getProperties(String group)
```
    获取group分组下所有配置键值对，组成新的Properties
    
    参数:
    group - 分组
    
    返回:
    Properties对象
  - getProps
```
public Props getProps(String group)
```
    获取group分组下所有配置键值对，组成新的Props
    
    参数:
    group - 分组
    
    返回:
    Props对象
    从以下版本开始:
    
    4.1.21
  - store
```
public void store(String absolutePath)
```
    持久化当前设置，会覆盖掉之前的设置
    持久化不会保留之前的分组
    
    参数:
    absolutePath - 设置文件的绝对路径
  - toProperties
```
public Properties toProperties()
```
    转换为Properties对象，原分组变为前缀
    
    返回:
    Properties对象
  - getGroupedMap
```
public GroupedMap getGroupedMap()
```
    获取GroupedMap
    
    返回:
    GroupedMap
    从以下版本开始:
    
    4.0.12
  - getGroups
```
public List<String> getGroups()
```
    获取所有分组
    
    返回:
    获得所有分组名
  - setVarRegex
```
public Setting setVarRegex(String regex)
```
    设置变量的正则
    正则只能有一个group表示变量本身，剩余为字符例如 \$\{(name)\}表示${name}变量名为name的一个变量表示
    
    参数:
    regex - 正则
  - setCharset
```
public Setting setCharset(Charset charset)
```
    自定义字符编码
    
    参数:
    charset - 字符编码
    
    返回:
    this
    从以下版本开始:
    
    4.6.2
  - isEmpty
```
public boolean isEmpty(String group)
```
    某个分组对应的键值对是否为空
    
    参数:
    group - 分组
    
    返回:
    是否为空
  - containsKey
```
public boolean containsKey(String group,
                  String key)
```
    指定分组中是否包含指定key
    
    参数:
    group - 分组
    key - 键
    
    返回:
    是否包含key
  - containsValue
```
public boolean containsValue(String group,
                    String value)
```
    指定分组中是否包含指定值
    
    参数:
    group - 分组
    value - 值
    
    返回:
    是否包含值
  - get
```
public String get(String group,
         String key)
```
    获取分组对应的值，如果分组不存在或者值不存在则返回null
    
    参数:
    group - 分组
    key - 键
    
    返回:
    值，如果分组不存在或者值不存在则返回null
  - put
```
public String put(String group,
         String key,
         String value)
```
    将键值对加入到对应分组中
    
    参数:
    group - 分组
    key - 键
    value - 值
    
    返回:
    此key之前存在的值，如果没有返回null
  - remove
```
public String remove(String group,
            Object key)
```
    从指定分组中删除指定值
    
    参数:
    group - 分组
    key - 键
    
    返回:
    被删除的值，如果值不存在，返回null
  - putAll
```
public Setting putAll(String group,
             Map<? extends String,? extends String> m)
```
    加入多个键值对到某个分组下
    
    参数:
    group - 分组
    m - 键值对
    
    返回:
    this
  - clear
```
public Setting clear(String group)
```
    清除指定分组下的所有键值对
    
    参数:
    group - 分组
    
    返回:
    this
  - keySet
```
public Set<String> keySet(String group)
```
    指定分组所有键的Set
    
    参数:
    group - 分组
    
    返回:
    键Set
  - values
```
public Collection<String> values(String group)
```
    指定分组下所有值
    
    参数:
    group - 分组
    
    返回:
    值
  - entrySet
```
public Set<Map.Entry<String,String>> entrySet(String group)
```
    指定分组下所有键值对
    
    参数:
    group - 分组
    
    返回:
    键值对
  - set
```
public Setting set(String key,
          String value)
```
    设置值
    
    参数:
    key - 键
    value - 值
    
    返回:
    this
    从以下版本开始:
    
    3.3.1
  - set
```
public Setting set(String group,
          String key,
          String value)
```
    将键值对加入到对应分组中
    
    参数:
    group - 分组
    key - 键
    value - 值
    
    返回:
    此key之前存在的值，如果没有返回null
  - isEmpty
```
public boolean isEmpty()
```
    指定者:
    
    isEmpty 在接口中 Map<String,String>
  - containsKey
```
public boolean containsKey(Object key)
```
    默认分组（空分组）中是否包含指定key对应的值
    
    指定者:
    
    containsKey 在接口中 Map<String,String>
    
    参数:
    key - 键
    
    返回:
    默认分组中是否包含指定key对应的值
  - containsValue
```
public boolean containsValue(Object value)
```
    默认分组（空分组）中是否包含指定值
    
    指定者:
    
    containsValue 在接口中 Map<String,String>
    
    参数:
    value - 值
    
    返回:
    默认分组中是否包含指定值
  - get
```
public String get(Object key)
```
    获取默认分组（空分组）中指定key对应的值
    
    指定者:
    
    get 在接口中 Map<String,String>
    
    参数:
    key - 键
    
    返回:
    默认分组（空分组）中指定key对应的值
  - put
```
public String put(String key,
         String value)
```
    将指定键值对加入到默认分组（空分组）中
    
    指定者:
    
    put 在接口中 Map<String,String>
    
    参数:
    key - 键
    value - 值
    
    返回:
    加入的值
  - remove
```
public String remove(Object key)
```
    移除默认分组（空分组）中指定值
    
    指定者:
    
    remove 在接口中 Map<String,String>
    
    参数:
    key - 键
    
    返回:
    移除的值
  - putAll
```
public void putAll(Map<? extends String,? extends String> m)
```
    将键值对Map加入默认分组（空分组）中
    
    指定者:
    
    putAll 在接口中 Map<String,String>
    
    参数:
    m - Map
  - clear
```
public void clear()
```
    清空默认分组（空分组）中的所有键值对
    
    指定者:
    
    clear 在接口中 Map<String,String>
  - keySet
```
public Set<String> keySet()
```
    获取默认分组（空分组）中的所有键列表
    
    指定者:
    
    keySet 在接口中 Map<String,String>
    
    返回:
    默认分组（空分组）中的所有键列表
  - values
```
public Collection<String> values()
```
    获取默认分组（空分组）中的所有值列表
    
    指定者:
    
    values 在接口中 Map<String,String>
    
    返回:
    默认分组（空分组）中的所有值列表
  - entrySet
```
public Set<Map.Entry<String,String>> entrySet()
```
    获取默认分组（空分组）中的所有键值对列表
    
    指定者:
    
    entrySet 在接口中 Map<String,String>
    
    返回:
    默认分组（空分组）中的所有键值对列表
  - hashCode
```
public int hashCode()
```
    指定者:
    
    hashCode 在接口中 Map<String,String>
    
    覆盖:
    
    hashCode 在类中 Object
  - equals
```
public boolean equals(Object obj)
```
    指定者:
    
    equals 在接口中 Map<String,String>
    
    覆盖:
    
    equals 在类中 Object
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 Setting

嵌套类概要

从接口继承的嵌套类/接口 java.util.Map

字段概要

从类继承的字段 cn.hutool.setting.AbsSetting

构造器概要

方法概要

从类继承的方法 cn.hutool.setting.AbsSetting

从类继承的方法 cn.hutool.core.getter.OptNullBasicTypeFromStringGetter

从类继承的方法 cn.hutool.core.getter.OptNullBasicTypeGetter

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

字段详细资料

DEFAULT_CHARSET

EXT_NAME

charset

isUseVariable

settingUrl

构造器详细资料

Setting

Setting

Setting

Setting

Setting

Setting

Setting

方法详细资料

init

load

autoLoad

getSettingPath

size

getByGroup

getAndRemove

getAndRemoveStr

getMap

getSetting

getProperties

getProps

store

toProperties

getGroupedMap

getGroups

setVarRegex

setCharset

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

set

set

isEmpty

containsKey

containsValue

get

put

remove

putAll

clear

keySet

values

entrySet

hashCode

equals

toString