com.tencent.polaris.configuration.api.core

Interface ConfigFile

All Superinterfaces:

ConfigFileMetadata

All Known Subinterfaces:

ConfigKVFile

public interface ConfigFile
extends ConfigFileMetadata

Author:

lepdou 2022-03-01

Method Summary

Modifier and Type	Method and Description
void	addChangeListener(ConfigFileChangeListener listener) Adding a config file change listener, will trigger a callback when the config file is published
<T> T	asJson(Class<T> objectType, T defaultValue) Deserialize to json object with given class type by gson.
<T> T	asJson(Type typeOfT, T defaultValue) Deserialize to json object with given class type by gson.
String	getContent() Get the content of the configuration file.
boolean	hasContent() Whether the configuration file contains content.
void	removeChangeListener(ConfigFileChangeListener listener) remove a config file change listener

Methods inherited from interface com.tencent.polaris.configuration.api.core.ConfigFileMetadata

getFileGroup, getFileName, getNamespace

Method Detail

getContent

String getContent()

Get the content of the configuration file. If it has not been published, null will be returned

Returns:

the content of the configuration file

asJson

<T> T asJson(Class<T> objectType,
             T defaultValue)

Deserialize to json object with given class type by gson. Default value will be returned when content is blank or some error occurred.

Type Parameters:

T -

Parameters:

objectType - the type of class

defaultValue - the default value

Returns:

Deserialize result of json object.

asJson

<T> T asJson(Type typeOfT,
             T defaultValue)

Deserialize to json object with given class type by gson. Default value will be returned when content is blank or some error occurred.

Type Parameters:

T -

Parameters:

typeOfT - the type of class

defaultValue - the default value

Returns:

Deserialize result of json object.

hasContent

boolean hasContent()

Whether the configuration file contains content. If it has not been published or content is blank string, false will be returned

Returns:

Whether the configuration file contains content

addChangeListener

void addChangeListener(ConfigFileChangeListener listener)

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

Parameters:

listener - the listener will be added

removeChangeListener

void removeChangeListener(ConfigFileChangeListener listener)

remove a config file change listener

Parameters:

listener - the listener will be removed