xyz.hellothomas.jedi.client

接口 Config

所有已知实现类:

AbstractConfig, DefaultConfig

public interface Config

版本:

1.0

作者:

Thomas

方法概要

限定符和类型	方法和说明
void	addChangeListener(ConfigChangeListener listener) Add change listener to this config instance, will be notified when any key is changed in this namespace.
void	addChangeListener(ConfigChangeListener listener, Set<String> interestedKeys) Add change listener to this config instance, will only be notified when any of the interested keys is changed in this namespace.
void	addChangeListener(ConfigChangeListener listener, Set<String> interestedKeys, Set<String> interestedKeyPrefixes) Add change listener to this config instance, will only be notified when any of the interested keys is changed in this namespace.
Integer	getIntProperty(String key, Integer defaultValue) Return the integer property value with the given key, or defaultValue if the key doesn't exist.
Long	getLongProperty(String key, Long defaultValue) Return the long property value with the given key, or defaultValue if the key doesn't exist.
<T> T	getProperty(String key, com.google.common.base.Function<String,T> function, T defaultValue) Return the user-defined property value with the given key, or defaultValue if the key doesn't exist.
String	getProperty(String key, String defaultValue) Return the property value with the given key, or defaultValue if the key doesn't exist.
Set<String>	getPropertyNames() Return a set of the property names
Short	getShortProperty(String key, Short defaultValue) Return the short property value with the given key, or defaultValue if the key doesn't exist.
ConfigSourceType	getSourceType() Return the config's source type, i.e. where is the config loaded from
boolean	removeChangeListener(ConfigChangeListener listener) Remove the change listener

方法详细资料

getProperty

String getProperty(String key,
                   String defaultValue)

Return the property value with the given key, or defaultValue if the key doesn't exist.

参数:

key - the property name

defaultValue - the default value when key is not found or any error occurred

返回:

the property value

getIntProperty

Integer getIntProperty(String key,
                       Integer defaultValue)

Return the integer property value with the given key, or defaultValue if the key doesn't exist.

参数:

key - the property name

defaultValue - the default value when key is not found or any error occurred

返回:

the property value as integer

getLongProperty

Long getLongProperty(String key,
                     Long defaultValue)

Return the long property value with the given key, or defaultValue if the key doesn't exist.

参数:

key - the property name

defaultValue - the default value when key is not found or any error occurred

返回:

the property value as long

getShortProperty

Short getShortProperty(String key,
                       Short defaultValue)

Return the short property value with the given key, or defaultValue if the key doesn't exist.

参数:

key - the property name

defaultValue - the default value when key is not found or any error occurred

返回:

the property value as short

addChangeListener

void addChangeListener(ConfigChangeListener listener)

Add change listener to this config instance, will be notified when any key is changed in this namespace.

参数:

listener - the config change listener

addChangeListener

void addChangeListener(ConfigChangeListener listener,
                       Set<String> interestedKeys)

Add change listener to this config instance, will only be notified when any of the interested keys is changed in this namespace.

参数:

listener - the config change listener

interestedKeys - the keys interested by the listener

从以下版本开始:

1.0.0

addChangeListener

void addChangeListener(ConfigChangeListener listener,
                       Set<String> interestedKeys,
                       Set<String> interestedKeyPrefixes)

Add change listener to this config instance, will only be notified when any of the interested keys is changed in this namespace.

参数:

listener - the config change listener

interestedKeys - the keys that the listener is interested in

interestedKeyPrefixes - the key prefixes that the listener is interested in, e.g. "spring." means that listener is interested in keys that starts with "spring.", such as "spring.banner", "spring.jpa", etc. and "application" means that listener is interested in keys that starts with "application", such as "applicationName", "application.port", etc.

从以下版本开始:

1.0.0

removeChangeListener

boolean removeChangeListener(ConfigChangeListener listener)

Remove the change listener

参数:

listener - the specific config change listener to remove

返回:

true if the specific config change listener is found and removed

从以下版本开始:

1.0.0

getPropertyNames

Set<String> getPropertyNames()

Return a set of the property names

返回:

the property names

getProperty

<T> T getProperty(String key,
                  com.google.common.base.Function<String,T> function,
                  T defaultValue)

Return the user-defined property value with the given key, or defaultValue if the key doesn't exist.

类型参数:

T - user-defined type

参数:

key - the property name

function - the transform Function. from String to user-defined type

defaultValue - the default value when key is not found or any error occurred

返回:

the property value

从以下版本开始:

1.0.0

getSourceType

ConfigSourceType getSourceType()

Return the config's source type, i.e. where is the config loaded from

返回:

the config's source type

从以下版本开始:

1.0.0