Props (bus-all 5.6.2 API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<Object,Object>
  - - java.util.Properties
    - - org.aoju.bus.setting.dialect.Props

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>, BasicType<String>, OptBasicType<String>
```
public final class Props
extends Properties
implements BasicType<String>, OptBasicType<String>
```
Properties文件读取封装类

Since:

JDK 1.8+

Version:

5.6.2

Author:

Kimi Liu

See Also:

Serialized Form

Field Summary
- Fields inherited from class java.util.Properties
  defaults

Constructor Summary

Constructors
Constructor and Description
`Props()` 构造
`Props(File propertiesFile)` 构造
`Props(File propertiesFile, Charset charset)` 构造
`Props(File propertiesFile, String charsetName)` 构造
`Props(Properties properties)` 构造,使用URL读取
`Props(String path)` 构造,使用相对于Class文件根目录的相对路径
`Props(String path, Charset charset)` 构造,使用相对于Class文件根目录的相对路径
`Props(String path, Class<?> clazz)` 构造,相对于classes读取文件
`Props(String path, Class<?> clazz, Charset charset)` 构造,相对于classes读取文件
`Props(String path, Class<?> clazz, String charsetName)` 构造,相对于classes读取文件
`Props(String path, String charsetName)` 构造,使用相对于Class文件根目录的相对路径
`Props(URL propertiesUrl)` 构造,使用URL读取
`Props(URL propertiesUrl, Charset charset)` 构造,使用URL读取
`Props(URL propertiesUrl, String charsetName)` 构造,使用URL读取

Method Summary

All Methods Static Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`void`	`autoLoad(boolean autoReload)` 在配置文件变更时自动加载
`String`	`getAndRemoveStr(String... keys)` 获取并删除键值对,当指定键对应值非空时,返回并删除这个值,后边的键对应的值不再查找
`BigDecimal`	`getBigDecimal(String key)` 获取BigDecimal型属性值
`BigDecimal`	`getBigDecimal(String key, BigDecimal defaultValue)` 获取BigDecimal型属性值若获得的值为不可见字符,使用默认值
`BigInteger`	`getBigInteger(String key)` 获取BigInteger型属性值
`BigInteger`	`getBigInteger(String key, BigInteger defaultValue)` 获取BigInteger型属性值若获得的值为不可见字符,使用默认值
`Boolean`	`getBool(String key)` 获取boolean型属性值
`Boolean`	`getBool(String key, Boolean defaultValue)` 获取boolean型属性值若获得的值为不可见字符,使用默认值
`Byte`	`getByte(String key)` 获取byte型属性值
`Byte`	`getByte(String key, Byte defaultValue)` 获取byte型属性值若获得的值为不可见字符,使用默认值
`Character`	`getChar(String key)` 获取char型属性值
`Character`	`getChar(String key, Character defaultValue)` 获取char型属性值若获得的值为不可见字符,使用默认值
`Date`	`getDate(String key)` 获取Date类型值
`Date`	`getDate(String key, Date defaultValue)` 获取Date类型值
`Double`	`getDouble(String key)` 获取double型属性值
`Double`	`getDouble(String key, Double defaultValue)` 获取double型属性值若获得的值为不可见字符,使用默认值
`<E extends Enum<E>> E`	`getEnum(Class<E> clazz, String key)` 获得Enum类型的值
`<E extends Enum<E>> E`	`getEnum(Class<E> clazz, String key, E defaultValue)` 获得Enum类型的值
`Float`	`getFloat(String key)` 获取float型属性值
`Float`	`getFloat(String key, Float defaultValue)` 获取float型属性值若获得的值为不可见字符,使用默认值
`Integer`	`getInt(String key)` 获取int型属性值
`Integer`	`getInt(String key, Integer defaultValue)` 获取int型属性值若获得的值为不可见字符,使用默认值
`Long`	`getLong(String key)` 获取long型属性值
`Long`	`getLong(String key, Long defaultValue)` 获取Long型属性值若获得的值为不可见字符,使用默认值
`Object`	`getObj(String key)` 获取Object属性值
`Object`	`getObj(String key, Object defaultValue)` 获取Object属性值
`static Properties`	`getProp(String resource)` 获得Classpath下的Properties文件
`static Properties`	`getProp(String resource, Charset charset)` 获得Classpath下的Properties文件
`static Properties`	`getProp(String resource, String charsetName)` 获得Classpath下的Properties文件
`Short`	`getShort(String key)` 获取short型属性值
`Short`	`getShort(String key, Short defaultValue)` 获取short型属性值若获得的值为不可见字符,使用默认值
`String`	`getStr(String key)` 获取字符串型属性值
`String`	`getStr(String key, String defaultValue)` 获取字符串型属性值若获得的值为不可见字符,使用默认值
`void`	`load()` 重新加载配置文件
`void`	`load(Resource urlResource)` 初始化配置文件
`void`	`setProperty(String key, Object value)` 设置值,无给定键创建之设置后未持久化
`void`	`store(String absolutePath)` 持久化当前设置,会覆盖掉之前的设置
`void`	`store(String path, Class<?> clazz)` 存储当前设置,会覆盖掉以前的设置

Methods inherited from class java.util.Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

Methods inherited from class java.util.Hashtable
clear, clone, compute, computeIfAbsent, computeIfPresent, contains, containsKey, containsValue, elements, entrySet, equals, forEach, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, put, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, size, toString, values

Methods inherited from class java.lang.Object
finalize, getClass, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - Props
```
public Props()
```
    构造
  - Props
```
public Props(String path)
```
    构造,使用相对于Class文件根目录的相对路径
    
    Parameters:
    
    path - 路径
  - Props
```
public Props(String path,
             String charsetName)
```
    构造,使用相对于Class文件根目录的相对路径
    
    Parameters:
    
    path - 相对或绝对路径
    
    charsetName - 字符集
  - Props
```
public Props(String path,
             Charset charset)
```
    构造,使用相对于Class文件根目录的相对路径
    
    Parameters:
    
    path - 相对或绝对路径
    
    charset - 字符集
  - Props
```
public Props(File propertiesFile)
```
    构造
    
    Parameters:
    
    propertiesFile - 配置文件对象
  - Props
```
public Props(File propertiesFile,
             String charsetName)
```
    构造
    
    Parameters:
    
    propertiesFile - 配置文件对象
    
    charsetName - 字符集
  - Props
```
public Props(File propertiesFile,
             Charset charset)
```
    构造
    
    Parameters:
    
    propertiesFile - 配置文件对象
    
    charset - 字符集
  - Props
```
public Props(String path,
             Class<?> clazz)
```
    构造,相对于classes读取文件
    
    Parameters:
    
    path - 相对路径
    
    clazz - 基准类
  - Props
```
public Props(String path,
             Class<?> clazz,
             String charsetName)
```
    构造,相对于classes读取文件
    
    Parameters:
    
    path - 相对路径
    
    clazz - 基准类
    
    charsetName - 字符集
  - Props
```
public Props(String path,
             Class<?> clazz,
             Charset charset)
```
    构造,相对于classes读取文件
    
    Parameters:
    
    path - 相对路径
    
    clazz - 基准类
    
    charset - 字符集
  - Props
```
public Props(URL propertiesUrl)
```
    构造,使用URL读取
    
    Parameters:
    
    propertiesUrl - 属性文件路径
  - Props
```
public Props(URL propertiesUrl,
             String charsetName)
```
    构造,使用URL读取
    
    Parameters:
    
    propertiesUrl - 属性文件路径
    
    charsetName - 字符集
  - Props
```
public Props(URL propertiesUrl,
             Charset charset)
```
    构造,使用URL读取
    
    Parameters:
    
    propertiesUrl - 属性文件路径
    
    charset - 字符集
  - Props
```
public Props(Properties properties)
```
    构造,使用URL读取
    
    Parameters:
    
    properties - 属性文件路径
- Method Detail
  - getProp
```
public static Properties getProp(String resource)
```
    获得Classpath下的Properties文件
    
    Parameters:
    
    resource - 资源（相对Classpath的路径）
    
    Returns:
    
    Properties
  - getProp
```
public static Properties getProp(String resource,
                                 String charsetName)
```
    获得Classpath下的Properties文件
    
    Parameters:
    
    resource - 资源（相对Classpath的路径）
    
    charsetName - 字符集
    
    Returns:
    
    Properties
  - getProp
```
public static Properties getProp(String resource,
                                 Charset charset)
```
    获得Classpath下的Properties文件
    
    Parameters:
    
    resource - 资源（相对Classpath的路径）
    
    charset - 字符集
    
    Returns:
    
    Properties
  - load
```
public void load(Resource urlResource)
```
    初始化配置文件
    
    Parameters:
    
    urlResource - UriResource
  - load
```
public void load()
```
    重新加载配置文件
  - autoLoad
```
public void autoLoad(boolean autoReload)
```
    在配置文件变更时自动加载
    
    Parameters:
    
    autoReload - 是否自动加载
  - getObj
```
public Object getObj(String key,
                     Object defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取Object属性值
    
    Specified by:
    
    getObj in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getObj
```
public Object getObj(String key)
```
    Description copied from interface: BasicType
    
    获取Object属性值
    
    Specified by:
    
    getObj in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getStr
```
public String getStr(String key,
                     String defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取字符串型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getStr in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getStr
```
public String getStr(String key)
```
    Description copied from interface: BasicType
    
    获取字符串型属性值
    
    Specified by:
    
    getStr in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getInt
```
public Integer getInt(String key,
                      Integer defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取int型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getInt in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getInt
```
public Integer getInt(String key)
```
    Description copied from interface: BasicType
    
    获取int型属性值
    
    Specified by:
    
    getInt in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getBool
```
public Boolean getBool(String key,
                       Boolean defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取boolean型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getBool in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getBool
```
public Boolean getBool(String key)
```
    Description copied from interface: BasicType
    
    获取boolean型属性值
    
    Specified by:
    
    getBool in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getLong
```
public Long getLong(String key,
                    Long defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取Long型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getLong in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getLong
```
public Long getLong(String key)
```
    Description copied from interface: BasicType
    
    获取long型属性值
    
    Specified by:
    
    getLong in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getChar
```
public Character getChar(String key,
                         Character defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取char型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getChar in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getChar
```
public Character getChar(String key)
```
    Description copied from interface: BasicType
    
    获取char型属性值
    
    Specified by:
    
    getChar in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getFloat
```
public Float getFloat(String key)
```
    Description copied from interface: BasicType
    
    获取float型属性值
    
    Specified by:
    
    getFloat in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getFloat
```
public Float getFloat(String key,
                      Float defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取float型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getFloat in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getDouble
```
public Double getDouble(String key,
                        Double defaultValue)
                 throws NumberFormatException
```
    Description copied from interface: OptBasicType
    
    获取double型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getDouble in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
    
    Throws:
    
    NumberFormatException
  - getDouble
```
public Double getDouble(String key)
                 throws NumberFormatException
```
    Description copied from interface: BasicType
    
    获取double型属性值
    
    Specified by:
    
    getDouble in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
    
    Throws:
    
    NumberFormatException
  - getShort
```
public Short getShort(String key,
                      Short defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取short型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getShort in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getShort
```
public Short getShort(String key)
```
    Description copied from interface: BasicType
    
    获取short型属性值
    
    Specified by:
    
    getShort in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getByte
```
public Byte getByte(String key,
                    Byte defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取byte型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getByte in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getByte
```
public Byte getByte(String key)
```
    Description copied from interface: BasicType
    
    获取byte型属性值
    
    Specified by:
    
    getByte in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key,
                                BigDecimal defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取BigDecimal型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getBigDecimal in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key)
```
    Description copied from interface: BasicType
    
    获取BigDecimal型属性值
    
    Specified by:
    
    getBigDecimal in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getBigInteger
```
public BigInteger getBigInteger(String key,
                                BigInteger defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取BigInteger型属性值若获得的值为不可见字符,使用默认值
    
    Specified by:
    
    getBigInteger in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    属性值, 无对应值返回defaultValue
  - getBigInteger
```
public BigInteger getBigInteger(String key)
```
    Description copied from interface: BasicType
    
    获取BigInteger型属性值
    
    Specified by:
    
    getBigInteger in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    属性值
  - getEnum
```
public <E extends Enum<E>> E getEnum(Class<E> clazz,
                                     String key,
                                     E defaultValue)
```
    Description copied from interface: OptBasicType
    
    获得Enum类型的值
    
    Specified by:
    
    getEnum in interface OptBasicType<String>
    
    Type Parameters:
    
    E - 枚举类型
    
    Parameters:
    
    clazz - Enum的Class
    
    key - KEY
    
    defaultValue - 默认值
    
    Returns:
    
    Enum类型的值, 无则返回Null
  - getEnum
```
public <E extends Enum<E>> E getEnum(Class<E> clazz,
                                     String key)
```
    Description copied from interface: BasicType
    
    获得Enum类型的值
    
    Specified by:
    
    getEnum in interface BasicType<String>
    
    Type Parameters:
    
    E - 枚举类型
    
    Parameters:
    
    clazz - Enum的Class
    
    key - KEY
    
    Returns:
    
    Enum类型的值, 无则返回Null
  - getDate
```
public Date getDate(String key,
                    Date defaultValue)
```
    Description copied from interface: OptBasicType
    
    获取Date类型值
    
    Specified by:
    
    getDate in interface OptBasicType<String>
    
    Parameters:
    
    key - 属性名
    
    defaultValue - 默认值
    
    Returns:
    
    Date类型属性值
  - getDate
```
public Date getDate(String key)
```
    Description copied from interface: BasicType
    
    获取Date类型值
    
    Specified by:
    
    getDate in interface BasicType<String>
    
    Parameters:
    
    key - 属性名
    
    Returns:
    
    Date类型属性值
  - getAndRemoveStr
```
public String getAndRemoveStr(String... keys)
```
    获取并删除键值对,当指定键对应值非空时,返回并删除这个值,后边的键对应的值不再查找
    
    Parameters:
    
    keys - 键列表,常用于别名
    
    Returns:
    
    字符串值
  - setProperty
```
public void setProperty(String key,
                        Object value)
```
    设置值,无给定键创建之设置后未持久化
    
    Parameters:
    
    key - 属性键
    
    value - 属性值
  - store
```
public void store(String absolutePath)
           throws InstrumentException
```
    持久化当前设置,会覆盖掉之前的设置
    
    Parameters:
    
    absolutePath - 设置文件的绝对路径
    
    Throws:
    
    InstrumentException - IO异常,可能为文件未找到
  - store
```
public void store(String path,
                  Class<?> clazz)
```
    存储当前设置,会覆盖掉以前的设置
    
    Parameters:
    
    path - 相对路径
    
    clazz - 相对的类

Class Props

Field Summary

Fields inherited from class java.util.Properties

Constructor Summary

Method Summary

Methods inherited from class java.util.Properties

Methods inherited from class java.util.Hashtable

Methods inherited from class java.lang.Object

Constructor Detail

Props

Props

Props

Props

Props

Props

Props

Props

Props

Props

Props

Props

Props

Props

Method Detail

getProp

getProp

getProp

load

load

autoLoad

getObj

getObj

getStr

getStr

getInt

getInt

getBool

getBool

getLong

getLong

getChar

getChar

getFloat

getFloat

getDouble

getDouble

getShort

getShort

getByte

getByte

getBigDecimal

getBigDecimal

getBigInteger

getBigInteger

getEnum

getEnum

getDate

getDate

getAndRemoveStr

setProperty

store

store