程序包 moe.kawayi.org.utopia.core.config.hocon

类 HoconConfig

java.lang.Object

moe.kawayi.org.utopia.core.config.hocon.HoconConfig

所有已实现的接口:

Config

public class HoconConfig
extends Object
implements Config

HOCON的config实现 getter参数不支持null参数，将会抛出NullPointerException异常。 支持null的getter仅在getArray(Config.NavigationPath)的返回对象HoconValue中实现。 并且在调用Config.getObject(Config.NavigationPath)之后再次失去该能力。

嵌套类概要

嵌套类

修饰符和类型	类	说明
static final record	HoconConfig.NavigationPath	导航路径

构造器概要

构造器

构造器	说明
HoconConfig(com.typesafe.config.Config config)	构造一个HoconConfig

方法概要

修饰符和类型	方法	说明
HoconConfig.NavigationPath	createPath(String... paths)	创建新导航路径
Optional<List<Config>>	getArray(Config.NavigationPath path)	获取对象
Optional<Boolean>	getBoolean(Config.NavigationPath path)	获取对象
Optional<Byte>	getByte(Config.NavigationPath path)	获取对象
Optional<Double>	getDouble(Config.NavigationPath path)	获取对象
Optional<Float>	getFloat(Config.NavigationPath path)	获取对象
Optional<Integer>	getInt(Config.NavigationPath path)	获取对象
Optional<Long>	getLong(Config.NavigationPath path)	获取对象
Optional<Config>	getObject(Config.NavigationPath path)	获取对象
Optional<Short>	getShort(Config.NavigationPath path)	获取对象
Optional<String>	getString(Config.NavigationPath path)	获取对象
Optional<UUID>	getUUID(Config.NavigationPath path)	获取对象
String	renderToString()	渲染此配置文件到字符串

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

构造器详细资料

HoconConfig

public HoconConfig(@NotNull
 com.typesafe.config.Config config)

构造一个HoconConfig

参数:

config - Hocon的Config，非空

方法详细资料

createPath

@NotNull
public HoconConfig.NavigationPath createPath(@NotNull
 String... paths)

从接口复制的说明: Config

创建新导航路径

指定者:

createPath 在接口中 Config

参数:

paths - 导航路径的字符串

返回:

导航路径

getByte

@NotNull
public Optional<Byte> getByte(@NotNull
 Config.NavigationPath path)
                       throws Exception

从接口复制的说明: Config

获取对象

指定者:

getByte 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

getShort

@NotNull
public Optional<Short> getShort(@NotNull
 Config.NavigationPath path)
                         throws Exception

从接口复制的说明: Config

获取对象

指定者:

getShort 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

getInt

@NotNull
public Optional<Integer> getInt(@NotNull
 Config.NavigationPath path)
                         throws Exception

从接口复制的说明: Config

获取对象

指定者:

getInt 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

getLong

@NotNull
public Optional<Long> getLong(@NotNull
 Config.NavigationPath path)
                       throws Exception

从接口复制的说明: Config

获取对象

指定者:

getLong 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

getBoolean

@NotNull
public Optional<Boolean> getBoolean(@NotNull
 Config.NavigationPath path)
                             throws Exception

从接口复制的说明: Config

获取对象

指定者:

getBoolean 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

getFloat

@NotNull
public Optional<Float> getFloat(@NotNull
 Config.NavigationPath path)
                         throws Exception

从接口复制的说明: Config

获取对象

指定者:

getFloat 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

getDouble

@NotNull
public Optional<Double> getDouble(@NotNull
 Config.NavigationPath path)
                           throws Exception

从接口复制的说明: Config

获取对象

指定者:

getDouble 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

getString

@NotNull
public Optional<String> getString(@NotNull
 Config.NavigationPath path)
                           throws Exception

从接口复制的说明: Config

获取对象

指定者:

getString 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

getUUID

@NotNull
public Optional<UUID> getUUID(@NotNull
 Config.NavigationPath path)
                       throws Exception

从接口复制的说明: Config

获取对象

指定者:

getUUID 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

getArray

@NotNull
public Optional<List<Config>> getArray(@NotNull
 Config.NavigationPath path)
                                throws Exception

从接口复制的说明: Config

获取对象

指定者:

getArray 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

getObject

@NotNull
public Optional<Config> getObject(@NotNull
 Config.NavigationPath path)
                           throws Exception

从接口复制的说明: Config

获取对象

指定者:

getObject 在接口中 Config

参数:

path - 导航路径。如果为null，则将this视为要获取的对象

返回:

如果路径不存在，或者类型不正确，返回empty

抛出:

Exception - 一些实现可能会在路径不存在或者类型不正确时直接抛出异常而非返回empty

renderToString

@NotNull
public String renderToString()

从接口复制的说明: Config

渲染此配置文件到字符串

指定者:

renderToString 在接口中 Config

返回:

字符串。非空。