cn.hutool.setting.dialect

类 Props

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

cn.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() 构造
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读取

方法概要

方法

限定符和类型	方法和说明
void	autoLoad(boolean autoReload) 在配置文件变更时自动加载
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(Resource urlResource) 初始化配置文件
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()

构造

Props

public Props(String path)

构造，使用相对于Class文件根目录的相对路径

参数:

path -

Props

public Props(String path,
     String charsetName)

构造，使用相对于Class文件根目录的相对路径

参数:

path - 相对或绝对路径

charsetName - 字符集

Props

public Props(String path,
     Charset charset)

构造，使用相对于Class文件根目录的相对路径

参数:

path - 相对或绝对路径

charset - 字符集

Props

public Props(File propertiesFile)

构造

参数:

propertiesFile - 配置文件对象

Props

public Props(File propertiesFile,
     String charsetName)

构造

参数:

propertiesFile - 配置文件对象

charsetName - 字符集

Props

public Props(File propertiesFile,
     Charset charset)

构造

参数:

propertiesFile - 配置文件对象

charset - 字符集

Props

public Props(String path,
     Class<?> clazz)

构造，相对于classes读取文件

参数:

path - 相对路径

clazz - 基准类

Props

public Props(String path,
     Class<?> clazz,
     String charsetName)

构造，相对于classes读取文件

参数:

path - 相对路径

clazz - 基准类

charsetName - 字符集

Props

public Props(String path,
     Class<?> clazz,
     Charset charset)

构造，相对于classes读取文件

参数:

path - 相对路径

clazz - 基准类

charset - 字符集

Props

public Props(URL propertiesUrl)

构造，使用URL读取

参数:

propertiesUrl - 属性文件路径

Props

public Props(URL propertiesUrl,
     String charsetName)

构造，使用URL读取

参数:

propertiesUrl - 属性文件路径

charsetName - 字符集

Props

public Props(URL propertiesUrl,
     Charset charset)

构造，使用URL读取

参数:

propertiesUrl - 属性文件路径

charset - 字符集

Props

public Props(Properties properties)

构造，使用URL读取

参数:

properties - 属性文件路径

方法详细资料

getProp

public static Properties getProp(String resource)

获得Classpath下的Properties文件

参数:

resource - 资源（相对Classpath的路径）

返回:

Properties

getProp

public static Properties getProp(String resource,
                 String charsetName)

获得Classpath下的Properties文件

参数:

resource - 资源（相对Classpath的路径）

charsetName - 字符集

返回:

Properties

getProp

public static Properties getProp(String resource,
                 Charset charset)

获得Classpath下的Properties文件

参数:

resource - 资源（相对Classpath的路径）

charset - 字符集

返回:

Properties

load

public void load(Resource urlResource)

初始化配置文件

参数:

urlResource - UrlResource

load

public void load()

重新加载配置文件

autoLoad

public void autoLoad(boolean autoReload)

在配置文件变更时自动加载

参数:

autoReload - 是否自动加载

getObj

public Object getObj(String key,
            Object defaultValue)

指定者:

getObj 在接口中 OptBasicTypeGetter<String>

getObj

public Object getObj(String key)

指定者:

getObj 在接口中 BasicTypeGetter<String>

getStr

public String getStr(String key,
            String defaultValue)

指定者:

getStr 在接口中 OptBasicTypeGetter<String>

getStr

public String getStr(String key)

指定者:

getStr 在接口中 BasicTypeGetter<String>

getInt

public Integer getInt(String key,
             Integer defaultValue)

指定者:

getInt 在接口中 OptBasicTypeGetter<String>

getInt

public Integer getInt(String key)

指定者:

getInt 在接口中 BasicTypeGetter<String>

getBool

public Boolean getBool(String key,
              Boolean defaultValue)

指定者:

getBool 在接口中 OptBasicTypeGetter<String>

getBool

public Boolean getBool(String key)

指定者:

getBool 在接口中 BasicTypeGetter<String>

getLong

public Long getLong(String key,
           Long defaultValue)

指定者:

getLong 在接口中 OptBasicTypeGetter<String>

getLong

public Long getLong(String key)

指定者:

getLong 在接口中 BasicTypeGetter<String>

getChar

public Character getChar(String key,
                Character defaultValue)

指定者:

getChar 在接口中 OptBasicTypeGetter<String>

getChar

public Character getChar(String key)

指定者:

getChar 在接口中 BasicTypeGetter<String>

getFloat

public Float getFloat(String key)

指定者:

getFloat 在接口中 BasicTypeGetter<String>

getFloat

public Float getFloat(String key,
             Float defaultValue)

指定者:

getFloat 在接口中 OptBasicTypeGetter<String>

getDouble

public Double getDouble(String key,
               Double defaultValue)
                 throws NumberFormatException

指定者:

getDouble 在接口中 OptBasicTypeGetter<String>

抛出:

NumberFormatException

getDouble

public Double getDouble(String key)
                 throws NumberFormatException

指定者:

getDouble 在接口中 BasicTypeGetter<String>

抛出:

NumberFormatException

getShort

public Short getShort(String key,
             Short defaultValue)

指定者:

getShort 在接口中 OptBasicTypeGetter<String>

getShort

public Short getShort(String key)

指定者:

getShort 在接口中 BasicTypeGetter<String>

getByte

public Byte getByte(String key,
           Byte defaultValue)

指定者:

getByte 在接口中 OptBasicTypeGetter<String>

getByte

public Byte getByte(String key)

指定者:

getByte 在接口中 BasicTypeGetter<String>

getBigDecimal

public BigDecimal getBigDecimal(String key,
                       BigDecimal defaultValue)

指定者:

getBigDecimal 在接口中 OptBasicTypeGetter<String>

getBigDecimal

public BigDecimal getBigDecimal(String key)

指定者:

getBigDecimal 在接口中 BasicTypeGetter<String>

getBigInteger

public BigInteger getBigInteger(String key,
                       BigInteger defaultValue)

指定者:

getBigInteger 在接口中 OptBasicTypeGetter<String>

getBigInteger

public BigInteger getBigInteger(String key)

指定者:

getBigInteger 在接口中 BasicTypeGetter<String>

getEnum

public <E extends Enum<E>> E getEnum(Class<E> clazz,
                            String key,
                            E defaultValue)

指定者:

getEnum 在接口中 OptBasicTypeGetter<String>

getEnum

public <E extends Enum<E>> E getEnum(Class<E> clazz,
                            String key)

指定者:

getEnum 在接口中 BasicTypeGetter<String>

getDate

public Date getDate(String key,
           Date defaultValue)

指定者:

getDate 在接口中 OptBasicTypeGetter<String>

getDate

public Date getDate(String key)

指定者:

getDate 在接口中 BasicTypeGetter<String>

setProperty

public void setProperty(String key,
               Object value)

设置值，无给定键创建之。设置后未持久化

参数:

key - 属性键

value - 属性值

store

public void store(String absolutePath)
           throws IORuntimeException

持久化当前设置，会覆盖掉之前的设置

参数:

absolutePath - 设置文件的绝对路径

抛出:

IORuntimeException - IO异常，可能为文件未找到

store

public void store(String path,
         Class<?> clazz)

存储当前设置，会覆盖掉以前的设置

参数:

path - 相对路径

clazz - 相对的类