Skip to content

interface IConfiguration

cangjie
public interface IConfiguration

功能:定义配置读取、写入和分节访问的核心接口。

成员概览

成员功能
func [](String)获取指定键对应的配置值。
func [](String, ?String)设置指定键对应的配置值。
func getSection(String)返回指定键对应的配置节。
func getChildren()返回当前配置下的直接子配置节集合。
func asEnumerable()返回当前配置树中的所有键值对。
func asEnumerable(Bool)返回当前配置树中的所有键值对。
func getValue(TypeInfo, String)按指定类型信息获取配置值。
func getValue(String)按泛型类型获取配置值。
func bind(Object)将当前配置节点自身绑定到对象实例的可变字段。
func bind(String, Object)将指定配置节的值绑定到对象实例的可变字段。

func [](String)

cangjie
operator func [](name: String): ?String

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

参数:

  • name: String - 配置项的键。

返回值:

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

func [](String, ?String)

cangjie
operator func [](name: String, value!: ?String): Unit

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

参数:

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

返回值:

  • Unit

func getSection(String)

cangjie
func getSection(name: String): IConfigurationSection

功能:返回指定键对应的配置节。

参数:

  • name: String - 配置节的键。

返回值:

func getChildren()

cangjie
func getChildren(): Collection<IConfigurationSection>

功能:返回当前配置下的直接子配置节集合。

返回值:

func asEnumerable()

cangjie
func asEnumerable(): Collection<(String, ?String)>

功能:返回当前配置树中的所有键值对。

返回值:

  • Collection<(String, ?String)> - 返回键值对集合。

func asEnumerable(Bool)

cangjie
func asEnumerable(makePathsRelative: Bool): Collection<(String, ?String)>

功能:返回当前配置树中的所有键值对。

参数:

  • makePathsRelative: Bool - 是否将路径裁剪为相对于当前配置节点。

返回值:

  • Collection<(String, ?String)> - 返回键值对集合。

func getValue(TypeInfo, String)

cangjie
func getValue(typeInfo: TypeInfo, name: String): ?Any

功能:按指定类型信息获取配置值。

参数:

  • typeInfo: TypeInfo - 目标值的类型信息。
  • name: String - 配置项的键。

返回值:

  • ?Any - 返回转换后的配置值;如果不存在或无法提供则返回 None。

func getValue(String)

cangjie
func getValue<T>(name: String): ?T

功能:按泛型类型获取配置值。

参数:

  • name: String - 配置项的键。

返回值:

  • ?T - 返回转换后的配置值;如果不存在或类型不匹配则返回 None。

func bind(Object)

cangjie
func bind(instance: Object): Unit

功能:将当前配置节点自身绑定到对象实例的可变字段。

参数:

  • instance: Object - 待绑定的对象实例。

返回值:

  • Unit

func bind(String, Object)

cangjie
func bind(name: String, instance: Object): Unit

功能:将指定配置节的值绑定到对象实例的可变字段。

参数:

  • name: String - 配置节的键。
  • instance: Object - 待绑定的对象实例。

返回值:

  • Unit