Props (bus-setting 3.2.0 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>, org.aoju.bus.core.getter.BasicTypeGetter<String>, org.aoju.bus.core.getter.OptBasicTypeGetter<String>
```
public final class Props
extends Properties
implements org.aoju.bus.core.getter.BasicTypeGetter<String>, org.aoju.bus.core.getter.OptBasicTypeGetter<String>
```
Properties文件读取封装类

Since:

JDK 1.8

Version:

3.2.0

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`	`getBigDecimal(String key, BigDecimal defaultValue)`
`BigInteger`	`getBigInteger(String key)`
`BigInteger`	`getBigInteger(String key, BigInteger defaultValue)`
`Boolean`	`getBool(String key)`
`Boolean`	`getBool(String key, Boolean defaultValue)`
`Byte`	`getByte(String key)`
`Byte`	`getByte(String key, Byte defaultValue)`
`Character`	`getChar(String key)`
`Character`	`getChar(String key, Character defaultValue)`
`Date`	`getDate(String key)`
`Date`	`getDate(String key, Date defaultValue)`
`Double`	`getDouble(String key)`
`Double`	`getDouble(String key, Double defaultValue)`
`<E extends Enum<E>> E`	`getEnum(Class<E> clazz, String key)`
`<E extends Enum<E>> E`	`getEnum(Class<E> clazz, String key, E defaultValue)`
`Float`	`getFloat(String key)`
`Float`	`getFloat(String key, Float defaultValue)`
`Integer`	`getInt(String key)`
`Integer`	`getInt(String key, Integer defaultValue)`
`Long`	`getLong(String key)`
`Long`	`getLong(String key, Long defaultValue)`
`Object`	`getObj(String key)`
`Object`	`getObj(String key, Object defaultValue)`
`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`	`getShort(String key, Short defaultValue)`
`String`	`getStr(String key)`
`String`	`getStr(String key, String defaultValue)`
`void`	`load()` 重新加载配置文件
`void`	`load(org.aoju.bus.core.io.resource.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(org.aoju.bus.core.io.resource.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)
```
    Specified by:
    
    getObj in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getObj
```
public Object getObj(String key)
```
    Specified by:
    
    getObj in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getStr
```
public String getStr(String key,
                     String defaultValue)
```
    Specified by:
    
    getStr in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getStr
```
public String getStr(String key)
```
    Specified by:
    
    getStr in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getInt
```
public Integer getInt(String key,
                      Integer defaultValue)
```
    Specified by:
    
    getInt in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getInt
```
public Integer getInt(String key)
```
    Specified by:
    
    getInt in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getBool
```
public Boolean getBool(String key,
                       Boolean defaultValue)
```
    Specified by:
    
    getBool in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getBool
```
public Boolean getBool(String key)
```
    Specified by:
    
    getBool in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getLong
```
public Long getLong(String key,
                    Long defaultValue)
```
    Specified by:
    
    getLong in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getLong
```
public Long getLong(String key)
```
    Specified by:
    
    getLong in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getChar
```
public Character getChar(String key,
                         Character defaultValue)
```
    Specified by:
    
    getChar in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getChar
```
public Character getChar(String key)
```
    Specified by:
    
    getChar in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getFloat
```
public Float getFloat(String key)
```
    Specified by:
    
    getFloat in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getFloat
```
public Float getFloat(String key,
                      Float defaultValue)
```
    Specified by:
    
    getFloat in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getDouble
```
public Double getDouble(String key,
                        Double defaultValue)
                 throws NumberFormatException
```
    Specified by:
    
    getDouble in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
    
    Throws:
    
    NumberFormatException
  - getDouble
```
public Double getDouble(String key)
                 throws NumberFormatException
```
    Specified by:
    
    getDouble in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
    
    Throws:
    
    NumberFormatException
  - getShort
```
public Short getShort(String key,
                      Short defaultValue)
```
    Specified by:
    
    getShort in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getShort
```
public Short getShort(String key)
```
    Specified by:
    
    getShort in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getByte
```
public Byte getByte(String key,
                    Byte defaultValue)
```
    Specified by:
    
    getByte in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getByte
```
public Byte getByte(String key)
```
    Specified by:
    
    getByte in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key,
                                BigDecimal defaultValue)
```
    Specified by:
    
    getBigDecimal in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key)
```
    Specified by:
    
    getBigDecimal in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getBigInteger
```
public BigInteger getBigInteger(String key,
                                BigInteger defaultValue)
```
    Specified by:
    
    getBigInteger in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getBigInteger
```
public BigInteger getBigInteger(String key)
```
    Specified by:
    
    getBigInteger in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getEnum
```
public <E extends Enum<E>> E getEnum(Class<E> clazz,
                                     String key,
                                     E defaultValue)
```
    Specified by:
    
    getEnum in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getEnum
```
public <E extends Enum<E>> E getEnum(Class<E> clazz,
                                     String key)
```
    Specified by:
    
    getEnum in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getDate
```
public Date getDate(String key,
                    Date defaultValue)
```
    Specified by:
    
    getDate in interface org.aoju.bus.core.getter.OptBasicTypeGetter<String>
  - getDate
```
public Date getDate(String key)
```
    Specified by:
    
    getDate in interface org.aoju.bus.core.getter.BasicTypeGetter<String>
  - getAndRemoveStr
```
public String getAndRemoveStr(String... keys)
```
    获取并删除键值对，当指定键对应值非空时，返回并删除这个值，后边的键对应的值不再查找
    
    Parameters:
    
    keys - 键列表，常用于别名
    
    Returns:
    
    字符串值
    
    Since:
    
    4.1.21
  - setProperty
```
public void setProperty(String key,
                        Object value)
```
    设置值，无给定键创建之。设置后未持久化
    
    Parameters:
    
    key - 属性键
    
    value - 属性值
  - store
```
public void store(String absolutePath)
           throws org.aoju.bus.core.lang.exception.CommonException
```
    持久化当前设置，会覆盖掉之前的设置
    
    Parameters:
    
    absolutePath - 设置文件的绝对路径
    
    Throws:
    
    org.aoju.bus.core.lang.exception.CommonException - 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