Package cc.carm.lib.configuration.yaml.value

Class ConfiguredSerializable<T extends org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable>

java.lang.Object

cc.carm.lib.configuration.core.value.ValueManifest<T>

cc.carm.lib.configuration.core.value.ConfigValue<T>

cc.carm.lib.configuration.core.value.impl.CachedConfigValue<T>

cc.carm.lib.configuration.yaml.YAMLValue<T>

cc.carm.lib.configuration.yaml.value.ConfiguredSerializable<T>

public class ConfiguredSerializable<T extends org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable>
extends YAMLValue<T>

Field Summary

Fields

Modifier and Type	Field	Description
protected @NotNull java.lang.Class<T>	valueClass

Fields inherited from class cc.carm.lib.configuration.core.value.impl.CachedConfigValue

cachedValue, parsedTime

Fields inherited from class cc.carm.lib.configuration.core.value.ValueManifest

configPath, defaultValue, headerComments, inlineComment, provider

Constructor Summary

Constructors

Constructor	Description
ConfiguredSerializable(@NotNull ValueManifest<T> manifest, @NotNull java.lang.Class<T> valueClass)

Method Summary

Modifier and Type	Method	Description
T	get()	得到该配置的设定值(即读取到的值)。
static <V extends org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable> ConfiguredSerializable<V>	of(@NotNull java.lang.Class<V> valueClass)
static <V extends org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable> ConfiguredSerializable<V>	of(@NotNull java.lang.Class<V> valueClass, V defaultValue)
void	set(T value)	设定该配置的值。

Methods inherited from class cc.carm.lib.configuration.yaml.YAMLValue

builder, getYAMLConfig, getYAMLProvider

Methods inherited from class cc.carm.lib.configuration.core.value.impl.CachedConfigValue

getCachedOrDefault, getCachedOrDefault, getCachedValue, getDefaultFirst, isExpired, updateCache

Methods inherited from class cc.carm.lib.configuration.core.value.ConfigValue

getNotNull, getOptional, getOrDefault, initialize, isDefault, setDefault, setDefault

Methods inherited from class cc.carm.lib.configuration.core.value.ValueManifest

getConfigPath, getConfiguration, getDefaultValue, getHeaderComments, getInlineComment, getProvider, getValue, initialize, of, of, setDefaultValue, setValue

Methods inherited from class java.lang.Object

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

Field Detail

valueClass

@NotNull
protected final @NotNull java.lang.Class<T extends org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable> valueClass

Constructor Detail

ConfiguredSerializable

public ConfiguredSerializable(@NotNull
                              @NotNull ValueManifest<T> manifest,
                              @NotNull
                              @NotNull java.lang.Class<T> valueClass)

Method Detail

of

public static <V extends org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable> ConfiguredSerializable<V> of(@NotNull
                                                                                                                                 @NotNull java.lang.Class<V> valueClass)

of

public static <V extends org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable> ConfiguredSerializable<V> of(@NotNull
                                                                                                                                 @NotNull java.lang.Class<V> valueClass,
                                                                                                                                 @Nullable
                                                                                                                                 V defaultValue)

get

@Nullable
public T get()

Description copied from class: ConfigValue

得到该配置的设定值(即读取到的值)。
若初始化时未写入默认值，则可以通过 ConfigValue.getOrDefault() 方法在该设定值为空时获取默认值。

Specified by:

get in class ConfigValue<T extends org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable>

Returns:

设定值

set

public void set(@Nullable
                T value)

Description copied from class: ConfigValue

设定该配置的值。
设定后，不会自动保存配置文件；若需要保存，请调用 ConfigurationProvider.save() 方法。

Specified by:

set in class ConfigValue<T extends org.bspfsystems.yamlconfiguration.serialization.ConfigurationSerializable>

Parameters:

value - 配置的值