BasicSetting (hutool 2.16.2 API)

java.lang.Object
- com.xiaoleilu.hutool.getter.OptNullBasicTypeGetter<K>
- - com.xiaoleilu.hutool.getter.OptNullBasicTypeFromObjectGetter<String>
  - - com.xiaoleilu.hutool.setting.AbsSetting
    - - com.xiaoleilu.hutool.setting.dialect.BasicSetting

所有已实现的接口:

BasicTypeGetter<String>, OptBasicTypeGetter<String>, Map<Object,Object>

直接已知子类:

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

作者:

xiaoleilu

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

字段概要

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

从类继承的字段 com.xiaoleilu.hutool.setting.AbsSetting
DEFAULT_DELIMITER

构造器概要

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

方法概要

方法
限定符和类型	方法和说明
`void`	`autoLoad(boolean autoReload)` 在配置文件变更时自动加载
`void`	`clear()`
`boolean`	`containsKey(Object key)`
`boolean`	`containsValue(Object value)`
`Set<Map.Entry<Object,Object>>`	`entrySet()`
`Object`	`get(Object key)`
`LinkedList<String>`	`getGroups()`
`Map<?,?>`	`getMap(String group)` 获得指定分组的所有键值对
`Object`	`getObj(String key, Object defaultValue)` 获取Object属性值
`Properties`	`getProperties(String group)` 转换为Properties对象，原分组变为前缀
`BasicSetting`	`getSetting(String group)` 获得group对应的子Setting
`String`	`getSettingPath()`
`boolean`	`init(URL settingUrl, Charset charset, boolean isUseVariable)` 初始化设定文件
`boolean`	`isEmpty()`
`Set<Object>`	`keySet()`
`boolean`	`load()` 重新加载配置文件
`Object`	`put(Object key, Object value)`
`void`	`putAll(Map<? extends Object,? extends Object> map)` 加入Map中的键值对
`Object`	`remove(Object key)`
`void`	`setVarRegex(String regex)` 设置变量的正则正则只能有一个group表示变量本身，剩余为字符例如 \$\{(name)\}表示${name}变量名为name的一个变量表示
`int`	`size()`
`void`	`store(String absolutePath)` 持久化当前设置，会覆盖掉之前的设置持久化会不会保留之前的分组
`Properties`	`toProperties()` 转换为Properties对象，原分组变为前缀
`String`	`toString()`
`Collection<Object>`	`values()`

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

从类继承的方法 com.xiaoleilu.hutool.getter.OptNullBasicTypeFromObjectGetter
getBigDecimal, getBigInteger, getBool, getByte, getChar, getDouble, getEnum, getFloat, getInt, getLong, getShort, getStr

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

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

从接口继承的方法 java.util.Map
equals, hashCode

- 字段详细资料
  - DEFAULT_CHARSET
```
public static final Charset DEFAULT_CHARSET
```
    默认字符集
  - charset
```
protected Charset charset
```
    本设置对象的字符集
  - isUseVariable
```
protected boolean isUseVariable
```
    是否使用变量
  - settingUrl
```
protected URL settingUrl
```
    设定文件的URL
- 构造器详细资料
  - BasicSetting
```
public BasicSetting()
```
  - BasicSetting
```
public BasicSetting(String pathBaseClassLoader,
            Charset charset,
            boolean isUseVariable)
```
    构造，使用相对于Class文件根目录的相对路径
    
    参数:
    pathBaseClassLoader - 相对路径（相对于当前项目的classes路径）
    charset - 字符集
    isUseVariable - 是否使用变量
  - BasicSetting
```
public BasicSetting(String pathBaseClassLoader)
```
    构造
    
    参数:
    pathBaseClassLoader - 相对路径（相对于当前项目的classes路径）
  - BasicSetting
```
public BasicSetting(File configFile,
            Charset charset,
            boolean isUseVariable)
```
    构造
    
    参数:
    configFile - 配置文件对象
    charset - 字符集
    isUseVariable - 是否使用变量
  - BasicSetting
```
public BasicSetting(String path,
            Class<?> clazz,
            Charset charset,
            boolean isUseVariable)
```
    构造，相对于classes读取文件
    
    参数:
    path - 相对路径
    clazz - 基准类
    charset - 字符集
    isUseVariable - 是否使用变量
  - BasicSetting
```
public BasicSetting(URL url,
            Charset charset,
            boolean isUseVariable)
```
    构造
    
    参数:
    url - 设定文件的URL
    charset - 字符集
    isUseVariable - 是否使用变量
- 方法详细资料
  - init
```
public boolean init(URL settingUrl,
           Charset charset,
           boolean isUseVariable)
```
    初始化设定文件
    
    参数:
    settingUrl - 设定文件的URL
    charset - 字符集
    isUseVariable - 是否使用变量
    
    返回:
    成功初始化与否
  - load
```
public boolean load()
```
    重新加载配置文件
  - autoLoad
```
public void autoLoad(boolean autoReload)
```
    在配置文件变更时自动加载
    
    参数:
    autoReload - 是否自动加载
  - getSettingPath
```
public String getSettingPath()
```
    返回:
    获得设定文件的路径
  - size
```
public int size()
```
    指定者:
    
    size 在接口中 Map<Object,Object>
  - getObj
```
public Object getObj(String key,
            Object defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取Object属性值
    
    指定者:
    
    getObj 在接口中 OptBasicTypeGetter<String>
    
    指定者:
    
    getObj 在类中 AbsSetting
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getMap
```
public Map<?,?> getMap(String group)
```
    获得指定分组的所有键值对
    
    参数:
    group - 分组
    
    返回:
    map
  - getSetting
```
public BasicSetting getSetting(String group)
```
    获得group对应的子Setting
    
    参数:
    group - 分组
    
    返回:
    Setting
  - getProperties
```
public Properties getProperties(String group)
```
    转换为Properties对象，原分组变为前缀
    
    返回:
    Properties对象
  - store
```
public void store(String absolutePath)
```
    持久化当前设置，会覆盖掉之前的设置
    持久化会不会保留之前的分组
    
    参数:
    absolutePath - 设置文件的绝对路径
  - setVarRegex
```
public void setVarRegex(String regex)
```
    设置变量的正则
    正则只能有一个group表示变量本身，剩余为字符例如 \$\{(name)\}表示${name}变量名为name的一个变量表示
    
    参数:
    regex - 正则
  - toProperties
```
public Properties toProperties()
```
    转换为Properties对象，原分组变为前缀
    
    返回:
    Properties对象
  - getGroups
```
public LinkedList<String> getGroups()
```
    返回:
    获得所有分组名
  - entrySet
```
public Set<Map.Entry<Object,Object>> entrySet()
```
    指定者:
    
    entrySet 在接口中 Map<Object,Object>
    
    返回:
    所有键值对
  - isEmpty
```
public boolean isEmpty()
```
    指定者:
    
    isEmpty 在接口中 Map<Object,Object>
  - containsKey
```
public boolean containsKey(Object key)
```
    指定者:
    
    containsKey 在接口中 Map<Object,Object>
  - containsValue
```
public boolean containsValue(Object value)
```
    指定者:
    
    containsValue 在接口中 Map<Object,Object>
  - get
```
public Object get(Object key)
```
    指定者:
    
    get 在接口中 Map<Object,Object>
  - put
```
public Object put(Object key,
         Object value)
```
    指定者:
    
    put 在接口中 Map<Object,Object>
  - putAll
```
public void putAll(Map<? extends Object,? extends Object> map)
```
    加入Map中的键值对
    
    指定者:
    
    putAll 在接口中 Map<Object,Object>
    
    参数:
    map - Map
  - remove
```
public Object remove(Object key)
```
    指定者:
    
    remove 在接口中 Map<Object,Object>
  - clear
```
public void clear()
```
    指定者:
    
    clear 在接口中 Map<Object,Object>
  - keySet
```
public Set<Object> keySet()
```
    指定者:
    
    keySet 在接口中 Map<Object,Object>
  - values
```
public Collection<Object> values()
```
    指定者:
    
    values 在接口中 Map<Object,Object>
  - toString
```
public String toString()
```
    覆盖:
    
    toString 在类中 Object

类 BasicSetting

嵌套类概要

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

字段概要

从类继承的字段 com.xiaoleilu.hutool.setting.AbsSetting

构造器概要

方法概要

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

从类继承的方法 com.xiaoleilu.hutool.getter.OptNullBasicTypeFromObjectGetter

从类继承的方法 com.xiaoleilu.hutool.getter.OptNullBasicTypeGetter

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

从接口继承的方法 java.util.Map

字段详细资料

DEFAULT_CHARSET

charset

isUseVariable

settingUrl

构造器详细资料

BasicSetting

BasicSetting

BasicSetting

BasicSetting

BasicSetting

BasicSetting

方法详细资料

init

load

autoLoad

getSettingPath

size

getObj

getMap

getSetting

getProperties

store

setVarRegex

toProperties

getGroups

entrySet

isEmpty

containsKey

containsValue

get

put

putAll

remove

clear

keySet

values

toString