Props (hutool 2.16.2 API)

java.lang.Object
- java.util.Dictionary<K,V>
- - java.util.Hashtable<Object,Object>
  - - java.util.Properties
    - - com.xiaoleilu.hutool.setting.dialect.Props

所有已实现的接口:

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

作者:

loolly

另请参阅:
序列化表格

字段概要
- 从类继承的字段 java.util.Properties
  defaults

构造器概要

构造器
构造器和说明
`Props(File propertiesFile)` 构造
`Props(Properties properties)` 构造，使用URL读取
`Props(String pathBaseClassLoader)` 构造，使用相对于Class文件根目录的相对路径
`Props(String path, Class<?> clazz)` 构造，相对于classes读取文件
`Props(URL propertiesUrl)` 构造，使用URL读取

方法概要

方法
限定符和类型	方法和说明
`void`	`autoLoad(boolean autoReload)` 在配置文件变更时自动加载
`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型属性值若获得的值为不可见字符，使用默认值
`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文件
`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(URL propertiesFileUrl)` 初始化配置文件
`void`	`setProperty(String key, Object value)` 设置值，无给定键创建之。
`void`	`store(String absolutePath)` 持久化当前设置，会覆盖掉之前的设置
`void`	`store(String path, Class<?> clazz)` 存储当前设置，会覆盖掉以前的设置

从类继承的方法 java.util.Properties
getProperty, getProperty, list, list, load, load, loadFromXML, propertyNames, save, setProperty, store, store, storeToXML, storeToXML, stringPropertyNames

从类继承的方法 java.util.Hashtable
clear, clone, contains, containsKey, containsValue, elements, entrySet, equals, get, hashCode, isEmpty, keys, keySet, put, putAll, rehash, remove, size, toString, values

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

- 构造器详细资料
  - Props
```
public Props(String pathBaseClassLoader)
```
    构造，使用相对于Class文件根目录的相对路径
    
    参数:
    pathBaseClassLoader - 相对路径（相对于当前项目的classes路径）
  - Props
```
public Props(File propertiesFile)
```
    构造
    
    参数:
    propertiesFile - 配置文件对象
  - Props
```
public Props(String path,
     Class<?> clazz)
```
    构造，相对于classes读取文件
    
    参数:
    path - 相对路径
    clazz - 基准类
  - Props
```
public Props(URL propertiesUrl)
```
    构造，使用URL读取
    
    参数:
    propertiesUrl - 属性文件路径
  - Props
```
public Props(Properties properties)
```
    构造，使用URL读取
    
    参数:
    properties - 属性文件路径
- 方法详细资料
  - getProp
```
public static Properties getProp(String resource)
```
    获得Classpath下的Properties文件
    
    参数:
    resource - 资源（相对Classpath的路径）
    
    返回:
    Properties
  - load
```
public void load(URL propertiesFileUrl)
```
    初始化配置文件
    
    参数:
    propertiesFileUrl - 配置文件URL
  - load
```
public void load()
```
    重新加载配置文件
  - autoLoad
```
public void autoLoad(boolean autoReload)
```
    在配置文件变更时自动加载
    
    参数:
    autoReload - 是否自动加载
  - getObj
```
public Object getObj(String key,
            Object defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取Object属性值
    
    指定者:
    
    getObj 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getObj
```
public Object getObj(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取Object属性值
    
    指定者:
    
    getObj 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getStr
```
public String getStr(String key,
            String defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取字符串型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getStr 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getStr
```
public String getStr(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取字符串型属性值
    
    指定者:
    
    getStr 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getInt
```
public Integer getInt(String key,
             Integer defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取int型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getInt 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getInt
```
public Integer getInt(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取int型属性值
    
    指定者:
    
    getInt 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getBool
```
public Boolean getBool(String key,
              Boolean defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取boolean型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getBool 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getBool
```
public Boolean getBool(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取boolean型属性值
    
    指定者:
    
    getBool 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getLong
```
public Long getLong(String key,
           Long defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取Long型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getLong 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getLong
```
public Long getLong(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取long型属性值
    
    指定者:
    
    getLong 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getChar
```
public Character getChar(String key,
                Character defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取char型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getChar 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getChar
```
public Character getChar(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取char型属性值
    
    指定者:
    
    getChar 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getFloat
```
public Float getFloat(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取float型属性值
    
    指定者:
    
    getFloat 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getFloat
```
public Float getFloat(String key,
             Float defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取float型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getFloat 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getDouble
```
public Double getDouble(String key,
               Double defaultValue)
                 throws NumberFormatException
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取double型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getDouble 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
    
    抛出:
    
    NumberFormatException
  - getDouble
```
public Double getDouble(String key)
                 throws NumberFormatException
```
    从接口复制的说明: BasicTypeGetter
    
    获取double型属性值
    
    指定者:
    
    getDouble 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
    
    抛出:
    
    NumberFormatException
  - getShort
```
public Short getShort(String key,
             Short defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取short型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getShort 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getShort
```
public Short getShort(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取short型属性值
    
    指定者:
    
    getShort 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getByte
```
public Byte getByte(String key,
           Byte defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取byte型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getByte 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getByte
```
public Byte getByte(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取byte型属性值
    
    指定者:
    
    getByte 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key,
                       BigDecimal defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取BigDecimal型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getBigDecimal 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getBigDecimal
```
public BigDecimal getBigDecimal(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取BigDecimal型属性值
    
    指定者:
    
    getBigDecimal 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getBigInteger
```
public BigInteger getBigInteger(String key,
                       BigInteger defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获取BigInteger型属性值
    若获得的值为不可见字符，使用默认值
    
    指定者:
    
    getBigInteger 在接口中 OptBasicTypeGetter<String>
    
    参数:
    key - 属性名
    defaultValue - 默认值
    
    返回:
    属性值，无对应值返回defaultValue
  - getBigInteger
```
public BigInteger getBigInteger(String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获取BigInteger型属性值
    
    指定者:
    
    getBigInteger 在接口中 BasicTypeGetter<String>
    
    参数:
    key - 属性名
    
    返回:
    属性值
  - getEnum
```
public <E extends Enum<E>> E getEnum(Class<E> clazz,
                            String key,
                            E defaultValue)
```
    从接口复制的说明: OptBasicTypeGetter
    
    获得Enum类型的值
    
    指定者:
    
    getEnum 在接口中 OptBasicTypeGetter<String>
    
    参数:
    clazz - Enum的Class
    key - KEY
    defaultValue - 默认值
    
    返回:
    Enum类型的值，无则返回Null
  - getEnum
```
public <E extends Enum<E>> E getEnum(Class<E> clazz,
                            String key)
```
    从接口复制的说明: BasicTypeGetter
    
    获得Enum类型的值
    
    指定者:
    
    getEnum 在接口中 BasicTypeGetter<String>
    
    参数:
    clazz - Enum的Class
    key - KEY
    
    返回:
    Enum类型的值，无则返回Null
  - setProperty
```
public void setProperty(String key,
               Object value)
```
    设置值，无给定键创建之。设置后未持久化
    
    参数:
    key - 属性键
    value - 属性值
  - store
```
public void store(String absolutePath)
```
    持久化当前设置，会覆盖掉之前的设置
    
    参数:
    absolutePath - 设置文件的绝对路径
  - store
```
public void store(String path,
         Class<?> clazz)
```
    存储当前设置，会覆盖掉以前的设置
    
    参数:
    path - 相对路径
    clazz - 相对的类

类 Props

字段概要

从类继承的字段 java.util.Properties

构造器概要

方法概要

从类继承的方法 java.util.Properties

从类继承的方法 java.util.Hashtable

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

构造器详细资料

Props

Props

Props

Props

Props

方法详细资料

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

setProperty

store

store