Skip to content

interface IConfigurationProvider

cangjie
public interface IConfigurationProvider <: ToString

功能:定义配置提供程序的基础接口。

父类型:

  • ToString

成员概览

成员功能
func load()加载或重新加载配置数据。
func get(String)获取指定键对应的配置值。
func set(String, ?String)设置指定键对应的配置值。
func getChildKeys(Collection<String>, ?String)返回指定父路径下的子键集合。
func toString()返回当前配置提供程序的类型描述。

func load()

cangjie
func load(): Unit

功能:加载或重新加载配置数据。

返回值:

  • Unit

func get(String)

cangjie
func get(key: String): ?String

功能:获取指定键对应的配置值。

参数:

  • key: String - 配置项的键。

返回值:

  • ?String - 返回对应的配置值;如果不存在则返回 None。

func set(String, ?String)

cangjie
func set(key: String, value: ?String): Unit

功能:设置指定键对应的配置值。

参数:

  • key: String - 配置项的键。
  • value: ?String - 要写入的配置值。

返回值:

  • Unit

func getChildKeys(Collection<String>, ?String)

cangjie
func getChildKeys(earlierKeys: Collection<String>, parentPath: ?String): Collection<String>

功能:返回指定父路径下的子键集合。

参数:

  • earlierKeys: Collection<String> - 已收集的子键集合。
  • parentPath: ?String - 父配置路径。

返回值:

  • Collection<String> - 返回当前提供程序可见的子键集合。

func toString()

cangjie
func toString(): String

功能:返回当前配置提供程序的类型描述。

返回值:

  • String - 返回提供程序的字符串表示。