Config (qdbp-tools 3.3.2 API)

java.lang.Object
- com.gitee.qdbp.tools.utils.Config

所有已实现的接口:

PropertyContainer, Serializable

直接已知子类:

HostUrlConfig
```
public class Config
extends Object
implements PropertyContainer, Serializable
```
加载配置文件
根据文件扩展名决定加载方式, 支持:txt|xml|properties, 其他都按properties处理
支持引用其他配置项
key.a = {config:key.b}
可以通过<<include>>标签导入其他配置文件
<<include>> = rules.txt
<<include.rules>> = rules.txt
<<include.sql>> = ../sql/sql.txt
有顺序要求的, 可带上序号
<<include.1>> = rules.txt
<<include.2>> = ../sql/sql.txt

版本:

140724

作者:

zhaohuihua

另请参阅:

序列化表格

嵌套类概要
- 从接口继承的嵌套类/接口 com.gitee.qdbp.tools.property.PropertyContainer
  PropertyContainer.Aware

构造器概要

构造器
构造器和说明
`Config()`
`Config(Properties properties)`
`Config(String path)` 构造函数
`Config(String[] paths)` 构造函数
`Config(String[] paths, PropertyTools.Options options)` 构造函数
`Config(String path, PropertyTools.Options options)` 构造函数
`Config(URL url)` 构造函数
`Config(URL[] urls)` 构造函数
`Config(URL[] urls, PropertyTools.Options options)` 构造函数
`Config(URL url, PropertyTools.Options options)` 构造函数

方法概要

所有方法实例方法具体方法
限定符和类型	方法和说明
`List<KeyString>`	`entries()` 返回所有配置项条目
`String[]`	`getArray(String key)` 获取数组类型的配置项值, 以竖杠分隔的字符串拆分为数组如果值不存在, 将输出警告日志
`String[]`	`getArray(String key, boolean warning)` 获取数组类型的配置项值, 以竖杠分隔的字符串拆分为数组每一个子字符串都已经trim()过了
`Boolean`	`getBoolean(String key)` 获取Boolean类型的配置项值如果值不存在, 将输出警告日志
`Boolean`	`getBoolean(String key, boolean warning)` 获取Boolean类型的配置项值
`Boolean`	`getBooleanUseDefValue(String key, Boolean defvalue)` 获取Boolean类型的配置项值如果配置项值为null则返回默认值
`<T,S extends T> S`	`getClassInstance(String key, Class<T> type, boolean warning)` 获取Class类型的配置值并返回实例化对象
`<T,S extends T> S`	`getClassInstance(String key, Class<T> type, Class<S> deftype)` 获取Class类型的配置值并返回实例化对象如果没有找到配置项, 返回默认类型的实例化对象
`Integer`	`getInteger(String key)` 获取Integer类型的配置项值如果值不存在, 将输出警告日志
`Integer`	`getInteger(String key, boolean warning)` 获取Integer类型的配置项值
`Integer`	`getIntegerUseDefValue(String key, Integer defvalue)` 获取Integer类型的配置项值如果配置项值为null则返回默认值
`Long`	`getLong(String key)` 获取Long类型的配置项值如果值不存在, 将输出警告日志
`Long`	`getLong(String key, boolean warning)` 获取Long类型的配置项值
`Long`	`getLongUseDefValue(String key, Long defvalue)` 获取Long类型的配置项值如果配置项值为null则返回默认值
`String`	`getString(String key)` 获取String类型的配置项值(已经trim过了) 如果值不存在, 将输出警告日志
`String`	`getString(String key, boolean warning)` 获取String类型的配置项值(已经trim过了)
`String`	`getStringUseDefKeys(String key, String... keys)` 获取String类型的配置项值, 如果配置项值为null则继续取备用KEY的值
`String`	`getStringUseDefValue(String key, String defvalue)` 获取String类型的配置项值, 如果配置项值为null则返回默认值
`String`	`getStringUseSuffix(String key, String suffixes)` 以key.suffix1.suffix2的方式逐级取值如key = a.b.c, suffixes=x.y.z 取值顺序为: a.b.c.x.y.z - a.b.c.x.y - a.b.c.x - a.b.c
`boolean`	`isEmpty()` 是否为空
`Properties`	`properties()` 返回Properties
`void`	`put(KeyString... items)`
`void`	`put(String key, String value)`

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

- 构造器详细资料
  - Config
```
public Config()
```
  - Config
```
public Config(Properties properties)
```
  - Config
```
public Config(String path)
```
    构造函数
    
    参数:
    
    path - 配置文件路径
  - Config
```
public Config(String path,
              PropertyTools.Options options)
```
    构造函数
    
    参数:
    
    path - 配置文件路径
    
    options - 选项
  - Config
```
public Config(String[] paths)
```
    构造函数
    
    参数:
    
    paths - 配置文件路径列表
  - Config
```
public Config(String[] paths,
              PropertyTools.Options options)
```
    构造函数
    
    参数:
    
    paths - 配置文件路径列表
    
    encoding - 编码格式
  - Config
```
public Config(URL url)
```
    构造函数
    
    参数:
    
    url - 配置文件路径
  - Config
```
public Config(URL url,
              PropertyTools.Options options)
```
    构造函数
    
    参数:
    
    url - 配置文件路径
    
    options - 选项
  - Config
```
public Config(URL[] urls)
```
    构造函数
    
    参数:
    
    urls - 配置文件路径列表
  - Config
```
public Config(URL[] urls,
              PropertyTools.Options options)
```
    构造函数
    
    参数:
    
    urls - 配置文件路径列表
    
    options - 选项
- 方法详细资料
  - put
```
public void put(String key,
                String value)
```
  - put
```
public void put(KeyString... items)
```
  - getString
```
public String getString(String key)
```
    获取String类型的配置项值(已经trim过了)
    如果值不存在, 将输出警告日志
    
    指定者:
    
    getString 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    返回:
    
    VALUE
  - getString
```
public String getString(String key,
                        boolean warning)
```
    获取String类型的配置项值(已经trim过了)
    
    指定者:
    
    getString 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    warning - 值不存在时,是否输出警告日志
    
    返回:
    
    VALUE
  - getStringUseDefValue
```
public String getStringUseDefValue(String key,
                                   String defvalue)
```
    获取String类型的配置项值, 如果配置项值为null则返回默认值
    
    指定者:
    
    getStringUseDefValue 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    defvalue - 默认值
    
    返回:
    
    VALUE
  - getStringUseDefKeys
```
public String getStringUseDefKeys(String key,
                                  String... keys)
```
    获取String类型的配置项值, 如果配置项值为null则继续取备用KEY的值
    
    指定者:
    
    getStringUseDefKeys 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    keys - 备用KEY
    
    返回:
    
    VALUE
  - getStringUseSuffix
```
public String getStringUseSuffix(String key,
                                 String suffixes)
```
    以key.suffix1.suffix2的方式逐级取值
    如key = a.b.c, suffixes=x.y.z
    取值顺序为: a.b.c.x.y.z - a.b.c.x.y - a.b.c.x - a.b.c
    
    指定者:
    
    getStringUseSuffix 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    suffixes - 多级后缀
    
    返回:
    
    VALUE
  - getLong
```
public Long getLong(String key)
```
    获取Long类型的配置项值
    如果值不存在, 将输出警告日志
    
    指定者:
    
    getLong 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    返回:
    
    VALUE
  - getLong
```
public Long getLong(String key,
                    boolean warning)
```
    获取Long类型的配置项值
    
    指定者:
    
    getLong 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    warning - 值不存在时,是否输出警告日志
    
    返回:
    
    VALUE
  - getLongUseDefValue
```
public Long getLongUseDefValue(String key,
                               Long defvalue)
```
    获取Long类型的配置项值
    如果配置项值为null则返回默认值
    
    指定者:
    
    getLongUseDefValue 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    defvalue - 默认值
    
    返回:
    
    VALUE
  - getInteger
```
public Integer getInteger(String key)
```
    获取Integer类型的配置项值
    如果值不存在, 将输出警告日志
    
    指定者:
    
    getInteger 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    返回:
    
    VALUE
  - getInteger
```
public Integer getInteger(String key,
                          boolean warning)
```
    获取Integer类型的配置项值
    
    指定者:
    
    getInteger 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    warning - 值不存在时,是否输出警告日志
    
    返回:
    
    VALUE
  - getIntegerUseDefValue
```
public Integer getIntegerUseDefValue(String key,
                                     Integer defvalue)
```
    获取Integer类型的配置项值
    如果配置项值为null则返回默认值
    
    指定者:
    
    getIntegerUseDefValue 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    defvalue - 默认值
    
    返回:
    
    VALUE
  - getBoolean
```
public Boolean getBoolean(String key)
```
    获取Boolean类型的配置项值
    如果值不存在, 将输出警告日志
    
    指定者:
    
    getBoolean 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    返回:
    
    VALUE
  - getBoolean
```
public Boolean getBoolean(String key,
                          boolean warning)
```
    获取Boolean类型的配置项值
    
    指定者:
    
    getBoolean 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    warning - 值不存在时,是否输出警告日志
    
    返回:
    
    VALUE
  - getBooleanUseDefValue
```
public Boolean getBooleanUseDefValue(String key,
                                     Boolean defvalue)
```
    获取Boolean类型的配置项值
    如果配置项值为null则返回默认值
    
    指定者:
    
    getBooleanUseDefValue 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    defvalue - 默认值
    
    返回:
    
    VALUE
  - getArray
```
public String[] getArray(String key)
```
    获取数组类型的配置项值, 以竖杠分隔的字符串拆分为数组
    如果值不存在, 将输出警告日志
    
    指定者:
    
    getArray 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    返回:
    
    VALUE
  - getArray
```
public String[] getArray(String key,
                         boolean warning)
```
    获取数组类型的配置项值, 以竖杠分隔的字符串拆分为数组
    每一个子字符串都已经trim()过了
    
    指定者:
    
    getArray 在接口中 PropertyContainer
    
    参数:
    
    key - KEY
    
    warning - 值不存在时,是否输出警告日志
    
    返回:
    
    VALUE
  - getClassInstance
```
public <T,S extends T> S getClassInstance(String key,
                                          Class<T> type,
                                          boolean warning)
```
    获取Class类型的配置值并返回实例化对象
    
    类型参数:
    
    T - 类型
    
    S - 子类型
    
    参数:
    
    key - KEY
    
    type - 期望返回的类型
    
    warning - 值不存在时,是否输出警告日志
    
    返回:
    
    配置的实例化对象
  - getClassInstance
```
public <T,S extends T> S getClassInstance(String key,
                                          Class<T> type,
                                          Class<S> deftype)
```
    获取Class类型的配置值并返回实例化对象
    如果没有找到配置项, 返回默认类型的实例化对象
    
    类型参数:
    
    T - 类型
    
    S - 子类型
    
    参数:
    
    key - KEY
    
    type - 期望返回的类型
    
    deftype - 默认类型
    
    返回:
    
    配置的实例化对象
  - properties
```
public Properties properties()
```
    返回Properties
    
    返回:
    
    Properties
  - entries
```
public List<KeyString> entries()
```
    返回所有配置项条目
    
    指定者:
    
    entries 在接口中 PropertyContainer
    
    返回:
    
    所有配置项条目
  - isEmpty
```
public boolean isEmpty()
```
    是否为空
    
    返回:
    
    是否为空

类 Config

嵌套类概要

从接口继承的嵌套类/接口 com.gitee.qdbp.tools.property.PropertyContainer

构造器概要

方法概要

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

构造器详细资料

Config

Config

Config

Config

Config

Config

Config

Config

Config

Config

方法详细资料

put

put

getString

getString

getStringUseDefValue

getStringUseDefKeys

getStringUseSuffix

getLong

getLong

getLongUseDefValue

getInteger

getInteger

getIntegerUseDefValue

getBoolean

getBoolean

getBooleanUseDefValue

getArray

getArray

getClassInstance

getClassInstance

properties

entries

isEmpty