org.noear.solon.core

Class Props

java.lang.Object

java.util.Dictionary<K,V>

java.util.Hashtable<Object,Object>

java.util.Properties

org.noear.solon.core.Props

All Implemented Interfaces:

Serializable, Cloneable, Map<Object,Object>

Direct Known Subclasses:

SolonProps

public class Props
extends Properties

通用属性集合（为 SolonProps 的基类） 在 Properties 基础上，添加了些方法

Since:

1.0

Author:

noear

See Also:

SolonProps, Serialized Form

Field Summary

Fields inherited from class java.util.Properties

defaults

Constructor Summary

Constructors

Constructor and Description
Props()
Props(ClassLoader classLoader)
Props(Iterable<KeyValues<String>> data) Deprecated. 3.0 addAll(Iterable<?>)
Props(Map<String,String> data) Deprecated. 3.0 addAll(Map)}
Props(Properties defaults)

Method Summary

Modifier and Type	Method and Description
Props	addAll(Iterable<KeyValues<String>> data) 添加所有属性数据
Props	addAll(Map<String,String> data) 添加所有属性数据
Props	addAll(Properties data) 添加所有属性数据
<T> T	bindTo(Class<T> clz) 绑定到一个类上
<T> T	bindTo(T obj) 绑定到一个类实例上
void	complete() 完成
protected void	doFind(String keyStarts, BiConsumer<String,String> setFun)
void	forEach(BiConsumer<? super Object,? super Object> action) 重写 forEach，增加 defaults 的遍历
static Props	from(Properties props) 加载或转换属性
String	get(String key) 获取属性
String	get(String key, String def) 获取某项配置（如果没有，输出默认值）
<T> T	getBean(Class<T> clz) Deprecated. 2.9 toBean(Class<?>)
<T> T	getBean(String keyStarts, Class<T> clz) Deprecated. 2.9 toBean(String,Class<?>)
boolean	getBool(String key, boolean def) 获取某项配置，并转为布尔型（如果没有，输出默认值）
String	getByExpr(String expr)
protected String	getByExpr(String expr, Properties props, String refKey)
String	getByKeys(String... keys) 获取第一个非空的属性（尝试用多个key）
String	getByTmpl(String tmpl)
protected String	getByTmpl(String tmpl, Properties props, String refKey)
protected String	getByTmpl(String tml, Properties props, String refKey, boolean useDef)
Double	getDouble(String key, double def) 获取某项配置，并转为又精度型（如果没有，输出默认值）
Map<String,Props>	getGroupedProp(String keyStarts) 查找 keyStarts 开头的所有配置；并生成一个新的分组的配置集
int	getInt(String key, int def) 获取某项配置，并转为整型（如果没有，输出默认值）
List<String>	getList(String keyStarts) 查找 keyStarts 开头的所有配置；并生成一个新的 List
Collection<Props>	getListedProp(String keyStarts) 查找 keyStarts 开头的所有配置；并生成一个新的列表的配置集
long	getLong(String key, long def) 获取某项配置，并转为长整型（如果没有，输出默认值）
Map<String,String>	getMap(String keyStarts) 查找 keyStarts 开头的所有配置；并生成一个新的 Map
<T> T	getOrDefault(String key, T def, Function<String,T> convert) 获取某项配置，并转为目标类型（如果没有，输出默认值）
Props	getProp(String keyStarts) 查找 keyStarts 开头的所有配置；并生成一个新的 配置集
Props	getPropByExpr(String expr)
void	loadAdd(Import anno)
void	loadAdd(Properties props) 加载配置（用于扩展加载）
void	loadAdd(String uri) 加载配置（用于扩展加载）
void	loadAdd(URL url) 加载配置（用于扩展加载）
protected void	loadAddDo(Properties props, boolean toSystem, boolean addIfAbsent)
protected void	loadAddDo(Properties props, boolean toSystem, boolean addIfAbsent, boolean isEnd) 加载配置（用于扩展加载）
void	loadAddIfAbsent(Properties props) 加载配置（用于扩展加载）
void	loadAddIfAbsent(String uri) 加载配置（用于扩展加载）
void	loadAddIfAbsent(URL url) 加载配置（用于扩展加载）
void	onChange(BiConsumer<String,String> event) 添加变更事件
Object	put(Object key, Object value) 设置应用属性
void	putIfNotNull(Object key, Object value)
protected void	reviseDo(boolean isEnd) 校正（多文件加载后）
int	size()
<T> T	toBean(Class<T> clz) 转为换一个类实例
<T> T	toBean(String keyStarts, Class<T> clz) 查找 keyStarts 开头的所有配置；并转为换一个类实例

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, get, getOrDefault, hashCode, isEmpty, keys, keySet, merge, putAll, putIfAbsent, rehash, remove, remove, replace, replace, replaceAll, toString, values

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Constructor Detail

Props

public Props()

Props

public Props(ClassLoader classLoader)

Props

public Props(Properties defaults)

Props

@Deprecated
public Props(Map<String,String> data)

Deprecated. 3.0 addAll(Map)}

See Also:

Props:addAll

Props

@Deprecated
public Props(Iterable<KeyValues<String>> data)

Deprecated. 3.0 addAll(Iterable<?>)

See Also:

Props:addAll

Method Detail

from

public static Props from(Properties props)

加载或转换属性

size

public int size()

Specified by:

size in interface Map<Object,Object>

Overrides:

size in class Hashtable<Object,Object>

get

public String get(String key)

获取属性

getByKeys

public String getByKeys(String... keys)

获取第一个非空的属性（尝试用多个key）

getByExpr

public String getByExpr(String expr)

Parameters:

expr - 兼容 ${key} or key or ${key:def} or key:def

getByExpr

protected String getByExpr(String expr,
                           Properties props,
                           String refKey)

Parameters:

expr - 兼容 ${key} or key or ${key:def} or key:def

getByTmpl

public String getByTmpl(String tmpl)

Parameters:

tmpl - 模板： ${key} 或 aaa${key}bbb 或 ${key:def}/ccc

getByTmpl

protected String getByTmpl(String tmpl,
                           Properties props,
                           String refKey)

Parameters:

tmpl - 模板： ${key} 或 aaa${key}bbb 或 ${key:def}/ccc

getByTmpl

protected String getByTmpl(String tml,
                           Properties props,
                           String refKey,
                           boolean useDef)

Parameters:

tml - 模板： ${key} 或 aaa${key}bbb 或 ${key:def}/ccc

useDef - 是否使用默认值

get

public String get(String key,
                  String def)

获取某项配置（如果没有，输出默认值）

Parameters:

def - 默认值

getBool

public boolean getBool(String key,
                       boolean def)

获取某项配置，并转为布尔型（如果没有，输出默认值）

Parameters:

def - 默认值

getInt

public int getInt(String key,
                  int def)

获取某项配置，并转为整型（如果没有，输出默认值）

Parameters:

def - 默认值

getLong

public long getLong(String key,
                    long def)

获取某项配置，并转为长整型（如果没有，输出默认值）

Parameters:

def - 默认值

getDouble

public Double getDouble(String key,
                        double def)

获取某项配置，并转为又精度型（如果没有，输出默认值）

Parameters:

def - 默认值

getOrDefault

public <T> T getOrDefault(String key,
                          T def,
                          Function<String,T> convert)

获取某项配置，并转为目标类型（如果没有，输出默认值）

getBean

@Deprecated
public <T> T getBean(String keyStarts,
                                 Class<T> clz)

Deprecated. 2.9 toBean(String,Class<?>)

查找 keyStarts 开头的所有配置；转为换一个类实例

Parameters:

keyStarts - key 的开始字符

getBean

@Deprecated
public <T> T getBean(Class<T> clz)

Deprecated. 2.9 toBean(Class<?>)

转为换一个类实例

toBean

public <T> T toBean(String keyStarts,
                    Class<T> clz)

查找 keyStarts 开头的所有配置；并转为换一个类实例

Parameters:

keyStarts - key 的开始字符

Since:

2.9

toBean

public <T> T toBean(Class<T> clz)

转为换一个类实例

Since:

2.9

bindTo

public <T> T bindTo(T obj)

绑定到一个类实例上

bindTo

public <T> T bindTo(Class<T> clz)

绑定到一个类上

getProp

public Props getProp(String keyStarts)

查找 keyStarts 开头的所有配置；并生成一个新的 配置集

Parameters:

keyStarts - key 的开始字符

getGroupedProp

public Map<String,Props> getGroupedProp(String keyStarts)

查找 keyStarts 开头的所有配置；并生成一个新的分组的配置集

Parameters:

keyStarts - key 的开始字符

getListedProp

public Collection<Props> getListedProp(String keyStarts)

查找 keyStarts 开头的所有配置；并生成一个新的列表的配置集

Parameters:

keyStarts - key 的开始字符

getPropByExpr

public Props getPropByExpr(String expr)

Parameters:

expr - 兼容 ${key} or key

getMap

public Map<String,String> getMap(String keyStarts)

查找 keyStarts 开头的所有配置；并生成一个新的 Map

Parameters:

keyStarts - key 的开始字符

getList

public List<String> getList(String keyStarts)

查找 keyStarts 开头的所有配置；并生成一个新的 List

Parameters:

keyStarts - key 的开始字符

doFind

protected void doFind(String keyStarts,
                      BiConsumer<String,String> setFun)

forEach

public void forEach(BiConsumer<? super Object,? super Object> action)

重写 forEach，增加 defaults 的遍历

Specified by:

forEach in interface Map<Object,Object>

Overrides:

forEach in class Hashtable<Object,Object>

onChange

public void onChange(BiConsumer<String,String> event)

添加变更事件

put

public Object put(Object key,
                  Object value)

设置应用属性

Specified by:

put in interface Map<Object,Object>

Overrides:

put in class Hashtable<Object,Object>

putIfNotNull

public void putIfNotNull(Object key,
                         Object value)

addAll

public Props addAll(Properties data)

添加所有属性数据

Since:

3.0

addAll

public Props addAll(Map<String,String> data)

添加所有属性数据

Since:

3.0

addAll

public Props addAll(Iterable<KeyValues<String>> data)

添加所有属性数据

Since:

3.0

loadAdd

public void loadAdd(String uri)

加载配置（用于扩展加载）

Parameters:

uri - 资源地址（"classpath:demo.xxx" or "file:./demo.xxx" or "./demo.xxx"）

loadAdd

public void loadAdd(Import anno)

loadAdd

public void loadAdd(URL url)

加载配置（用于扩展加载）

Parameters:

url - 配置地址

loadAdd

public void loadAdd(Properties props)

加载配置（用于扩展加载）

loadAddIfAbsent

public void loadAddIfAbsent(String uri)

加载配置（用于扩展加载）

Parameters:

uri - 资源名

loadAddIfAbsent

public void loadAddIfAbsent(URL url)

加载配置（用于扩展加载）

Parameters:

url - 配置地址

loadAddIfAbsent

public void loadAddIfAbsent(Properties props)

加载配置（用于扩展加载）

loadAddDo

protected void loadAddDo(Properties props,
                         boolean toSystem,
                         boolean addIfAbsent)

loadAddDo

protected void loadAddDo(Properties props,
                         boolean toSystem,
                         boolean addIfAbsent,
                         boolean isEnd)

加载配置（用于扩展加载）

Parameters:

props - 配置地址

complete

public void complete()

完成

reviseDo

protected void reviseDo(boolean isEnd)

校正（多文件加载后）