com.tencent.polaris.configuration.api.core

接口 ConfigKVFile

所有超级接口:

ConfigFile, ConfigFileMetadata

public interface ConfigKVFile
extends ConfigFile

The config file can be converted as key value set. Such as properties、yaml files.

作者:

lepdou 2022-03-01

方法概要

限定符和类型	方法和说明
void	addChangeListener(ConfigKVFileChangeListener listener) Adding a config file property change listener, will trigger a callback when the config file is published
String[]	getArrayProperty(String key, String delimiter, String[] defaultValue) Auto parse string to array by given delimiter, or defaultValue if the key doesn't exist \n For example, the source value is v1,v2,v3.
Boolean	getBooleanProperty(String key, Boolean defaultValue) Get the value of given key as boolean type in the configuration file, or defaultValue if the key doesn't exist
Byte	getByteProperty(String key, Byte defaultValue) Get the value of given key as byte type in the configuration file, or defaultValue if the key doesn't exist
Double	getDoubleProperty(String key, Double defaultValue) Get the value of given key as double type in the configuration file, or defaultValue if the key doesn't exist
<T extends Enum<T>> T	getEnumProperty(String key, Class<T> enumType, T defaultValue) Auto parse string to enum. default value will be returned when parsed failed.
Float	getFloatProperty(String key, Float defaultValue) Get the value of given key as float type in the configuration file, or defaultValue if the key doesn't exist
Integer	getIntProperty(String key, Integer defaultValue) Get the value of given key as integer type in the configuration file, or defaultValue if the key doesn't exist
<T> T	getJsonProperty(String key, Class<T> clazz, T defaultValue) Auto parse string to json object. default value will be returned when parsed failed.
<T> T	getJsonProperty(String key, Type typeOfT, T defaultValue) Auto parse string to json object. default value will be returned when parsed failed.
Long	getLongProperty(String key, Long defaultValue) Get the value of given key as long type in the configuration file, or defaultValue if the key doesn't exist
String	getProperty(String key, String defaultValue) Get the value of given key in the configuration file, or defaultValue if the key doesn't exist
Set<String>	getPropertyNames() Get properties for all keys
Short	getShortProperty(String key, Short defaultValue) Get the value of given key as short type in the configuration file, or defaultValue if the key doesn't exist
void	removeChangeListener(ConfigKVFileChangeListener listener) Remove a config file property change listener

从接口继承的方法 com.tencent.polaris.configuration.api.core.ConfigFile

addChangeListener, asJson, asJson, getContent, hasContent, removeChangeListener

从接口继承的方法 com.tencent.polaris.configuration.api.core.ConfigFileMetadata

getFileGroup, getFileName, getNamespace

方法详细资料

getProperty

String getProperty(String key,
                   String defaultValue)

Get the value of given key in the configuration file, or defaultValue if the key doesn't exist

参数:

key - the properties key

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

返回:

the properties value

getIntProperty

Integer getIntProperty(String key,
                       Integer defaultValue)

Get the value of given key as integer type in the configuration file, or defaultValue if the key doesn't exist

参数:

key - the properties key

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

返回:

the properties value

getLongProperty

Long getLongProperty(String key,
                     Long defaultValue)

Get the value of given key as long type in the configuration file, or defaultValue if the key doesn't exist

参数:

key - the properties key

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

返回:

the properties value

getShortProperty

Short getShortProperty(String key,
                       Short defaultValue)

Get the value of given key as short type in the configuration file, or defaultValue if the key doesn't exist

参数:

key - the properties key

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

返回:

the properties value

getFloatProperty

Float getFloatProperty(String key,
                       Float defaultValue)

Get the value of given key as float type in the configuration file, or defaultValue if the key doesn't exist

参数:

key - the properties key

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

返回:

the properties value

getDoubleProperty

Double getDoubleProperty(String key,
                         Double defaultValue)

Get the value of given key as double type in the configuration file, or defaultValue if the key doesn't exist

参数:

key - the properties key

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

返回:

the properties value

getByteProperty

Byte getByteProperty(String key,
                     Byte defaultValue)

Get the value of given key as byte type in the configuration file, or defaultValue if the key doesn't exist

参数:

key - the properties key

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

返回:

the properties value

getBooleanProperty

Boolean getBooleanProperty(String key,
                           Boolean defaultValue)

Get the value of given key as boolean type in the configuration file, or defaultValue if the key doesn't exist

参数:

key - the properties key

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

返回:

the properties value

getArrayProperty

String[] getArrayProperty(String key,
                          String delimiter,
                          String[] defaultValue)

Auto parse string to array by given delimiter, or defaultValue if the key doesn't exist \n For example, the source value is v1,v2,v3. An array ["v1","v2","v3"] will be returned when called with "," delimiter.

参数:

key - the properties key

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

返回:

parsed array

getEnumProperty

<T extends Enum<T>> T getEnumProperty(String key,
                                      Class<T> enumType,
                                      T defaultValue)

Auto parse string to enum. default value will be returned when parsed failed.

类型参数:

T -

参数:

key - the properties key

enumType - the type of enum

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

返回:

parsed enum

getJsonProperty

<T> T getJsonProperty(String key,
                      Class<T> clazz,
                      T defaultValue)

Auto parse string to json object. default value will be returned when parsed failed.

类型参数:

T -

参数:

key - the properties key

clazz - the type of object

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

返回:

parsed object

getJsonProperty

<T> T getJsonProperty(String key,
                      Type typeOfT,
                      T defaultValue)

Auto parse string to json object. default value will be returned when parsed failed.

类型参数:

T -

参数:

key - the properties key

typeOfT - the type of object

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

返回:

parsed object

getPropertyNames

Set<String> getPropertyNames()

Get properties for all keys

返回:

the keys in properties

addChangeListener

void addChangeListener(ConfigKVFileChangeListener listener)

Adding a config file property change listener, will trigger a callback when the config file is published

参数:

listener - the listener will be added

removeChangeListener

void removeChangeListener(ConfigKVFileChangeListener listener)

Remove a config file property change listener

参数:

listener - the listener will be removed