Setting (hutool 2.15.0 API)

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

所有已实现的接口:

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

作者:

xiaoleilu

字段概要
- 从类继承的字段 com.xiaoleilu.hutool.setting.dialect.BasicSetting
  DEFAULT_CHARSET, DEFAULT_DELIMITER

构造器概要

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

方法概要

方法
限定符和类型	方法和说明
`String`	`get(String key, String group)` 获得指定分组的键对应值
`Boolean`	`getBool(String key, String group)` 获取波尔型属性值
`Boolean`	`getBool(String key, String group, Boolean defaultValue)` 获取波尔型型属性值
`Character`	`getChar(String key, String group)` 获取char类型属性值
`Double`	`getDouble(String key, String group)` 获取double类型属性值
`Double`	`getDouble(String key, String group, Double defaultValue)` 获取double类型属性值
`Integer`	`getInt(String key, String group)` 获取数字型型属性值
`Integer`	`getInt(String key, String group, Integer defaultValue)` 获取数字型型属性值
`Long`	`getLong(String key, String group)` 获取long类型属性值
`Long`	`getLong(String key, String group, Long defaultValue)` 获取long类型属性值
`String`	`getString(String key)` 获取字符型型属性值
`String`	`getString(String key, String group)` 获取字符型型属性值
`String[]`	`getStrings(String key)` 获得数组型
`String[]`	`getStrings(String key, String group)` 获得数组型
`String[]`	`getStrings(String key, String group, String delimiter)` 获得数组型
`String[]`	`getStringsWithDefault(String key, String[] defaultValue)` 获得数组型
`String`	`getStringWithDefault(String key, String defaultValue)` 获取字符型型属性值若获得的值为不可见字符，使用默认值
`String`	`getStringWithDefault(String key, String group, String defaultValue)` 获取字符型型属性值若获得的值为不可见字符，使用默认值
`String`	`getWithLog(String key)` 带有日志提示的get，如果没有定义指定的KEY，则打印debug日志
`String`	`getWithLog(String key, String group)` 带有日志提示的get，如果没有定义指定的KEY，则打印debug日志

从类继承的方法 com.xiaoleilu.hutool.setting.dialect.BasicSetting
entrySet, getByGroup, getGroups, getMap, getMap, getSettingPath, getStr, init, load, load, reload, setSetting, setVarRegex, size, store, store, toBean, toBean, toProperties

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

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

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

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

- 构造器详细资料
  - Setting
```
public Setting(Charset charset,
       boolean isUseVariable)
```
    基本构造
    需自定义初始化配置文件
    
    参数:
    charset - 字符集
    isUseVariable - 是否使用变量
  - Setting
```
public Setting(String pathBaseClassLoader,
       String charset,
       boolean isUseVariable)
```
    构造，使用相对于Class文件根目录的相对路径
    
    参数:
    pathBaseClassLoader - 相对路径（相对于当前项目的classes路径）
    charset - 字符集
    isUseVariable - 是否使用变量
  - Setting
```
public Setting(File configFile,
       String charset,
       boolean isUseVariable)
```
    构造
    
    参数:
    configFile - 配置文件对象
    charset - 字符集
    isUseVariable - 是否使用变量
  - Setting
```
public Setting(String path,
       Class<?> clazz,
       String charset,
       boolean isUseVariable)
```
    构造，相对于classes读取文件
    
    参数:
    path - 相对路径
    clazz - 基准类
    charset - 字符集
    isUseVariable - 是否使用变量
  - Setting
```
public Setting(URL url,
       String charset,
       boolean isUseVariable)
```
    构造
    
    参数:
    url - 设定文件的URL
    charset - 字符集
    isUseVariable - 是否使用变量
  - Setting
```
public Setting(String pathBaseClassLoader)
```
    构造
    
    参数:
    pathBaseClassLoader - 相对路径（相对于当前项目的classes路径）
- 方法详细资料
  - getWithLog
```
public String getWithLog(String key)
```
    带有日志提示的get，如果没有定义指定的KEY，则打印debug日志
    
    参数:
    key - 键
    
    返回:
    值
  - getWithLog
```
public String getWithLog(String key,
                String group)
```
    带有日志提示的get，如果没有定义指定的KEY，则打印debug日志
    
    参数:
    key - 键
    
    返回:
    值
  - get
```
public String get(String key,
         String group)
```
    获得指定分组的键对应值
    
    参数:
    key - 键
    group - 分组
    
    返回:
    值
  - getString
```
public String getString(String key)
```
    获取字符型型属性值
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getStringWithDefault
```
public String getStringWithDefault(String key,
                          String defaultValue)
```
    获取字符型型属性值
    若获得的值为不可见字符，使用默认值
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值
  - getString
```
public String getString(String key,
               String group)
```
    获取字符型型属性值
    
    参数:
    key - 属性名
    group - 分组名
    
    返回:
    属性值
  - getStringWithDefault
```
public String getStringWithDefault(String key,
                          String group,
                          String defaultValue)
```
    获取字符型型属性值
    若获得的值为不可见字符，使用默认值
    
    参数:
    key - 属性名
    group - 分组名
    defaultValue - 默认值
    
    返回:
    属性值
  - getStrings
```
public String[] getStrings(String key)
```
    获得数组型
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getStringsWithDefault
```
public String[] getStringsWithDefault(String key,
                             String[] defaultValue)
```
    获得数组型
    
    参数:
    key - 属性名
    defaultValue - 默认的值
    
    返回:
    属性值
  - getStrings
```
public String[] getStrings(String key,
                  String group)
```
    获得数组型
    
    参数:
    key - 属性名
    group - 分组名
    
    返回:
    属性值
  - getStrings
```
public String[] getStrings(String key,
                  String group,
                  String delimiter)
```
    获得数组型
    
    参数:
    key - 属性名
    group - 分组名
    delimiter - 分隔符
    
    返回:
    属性值
  - getInt
```
public Integer getInt(String key,
             String group)
```
    获取数字型型属性值
    
    参数:
    key - 属性名
    group - 分组名
    
    返回:
    属性值
  - getInt
```
public Integer getInt(String key,
             String group,
             Integer defaultValue)
```
    获取数字型型属性值
    
    参数:
    key - 属性名
    group - 分组名
    defaultValue - 默认值
    
    返回:
    属性值
  - getBool
```
public Boolean getBool(String key,
              String group)
```
    获取波尔型属性值
    
    参数:
    key - 属性名
    group - 分组名
    
    返回:
    属性值
  - getBool
```
public Boolean getBool(String key,
              String group,
              Boolean defaultValue)
```
    获取波尔型型属性值
    
    参数:
    key - 属性名
    group - 分组名
    defaultValue - 默认值
    
    返回:
    属性值
  - getLong
```
public Long getLong(String key,
           String group)
```
    获取long类型属性值
    
    参数:
    key - 属性名
    group - 分组名
    
    返回:
    属性值
  - getLong
```
public Long getLong(String key,
           String group,
           Long defaultValue)
```
    获取long类型属性值
    
    参数:
    key - 属性名
    group - 分组名
    defaultValue - 默认值
    
    返回:
    属性值
  - getChar
```
public Character getChar(String key,
                String group)
```
    获取char类型属性值
    
    参数:
    key - 属性名
    group - 分组名
    
    返回:
    属性值
  - getDouble
```
public Double getDouble(String key,
               String group)
```
    获取double类型属性值
    
    参数:
    key - 属性名
    group - 分组名
    
    返回:
    属性值
  - getDouble
```
public Double getDouble(String key,
               String group,
               Double defaultValue)
```
    获取double类型属性值
    
    参数:
    key - 属性名
    group - 分组名
    defaultValue - 默认值
    
    返回:
    属性值

类 Setting

字段概要

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

构造器概要

方法概要

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

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

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

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

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

构造器详细资料

Setting

Setting

Setting

Setting

Setting

Setting

方法详细资料

getWithLog

getWithLog

get

getString

getStringWithDefault

getString

getStringWithDefault

getStrings

getStringsWithDefault

getStrings

getStrings

getInt

getInt

getBool

getBool

getLong

getLong

getChar

getDouble

getDouble