cn.sliew.milky.common.settings

类 Setting<T>

java.lang.Object

cn.sliew.milky.common.settings.Setting<T>

直接已知子类:

GroupSetting

public class Setting<T>
extends Object

todo remove property

字段概要

字段

限定符和类型	字段和说明
protected Function<Settings,String>	defaultValue

构造器概要

构造器

构造器和说明
Setting(Key key, Function<Settings,String> defaultValue, Setting<T> fallbackSetting, Function<String,T> parser, Validator<T> validator) LineLength.

方法概要

限定符和类型	方法和说明
boolean	exists(Settings settings) Returns true if and only if this setting is present in the given settings instance.
boolean	existsOrFallbackExists(Settings settings) Returns true if and only if this setting including fallback settings is present in the given settings instance.
T	get(Settings settings) Returns the settings value.
T	getDefault(Settings settings) Returns the default value for this setting.
String	getDefaultRaw(Settings settings) Returns the default value string representation for this setting.
String	getKey() Returns the settings key or a prefix if this setting is a group setting.
String	getRaw(Settings settings)
Key	getRawKey() Returns the original representation of a setting key.
boolean	match(String toTest) Returns true iff the given key matches the settings key or if this setting is a group setting if the given key is part of the settings group.
SettingUpdater<T>	newUpdater(Consumer<T> updater, Consumer<T> validator, Logger logger)

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

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

字段详细资料

defaultValue

protected final Function<Settings,String> defaultValue

构造器详细资料

Setting

public Setting(Key key,
               Function<Settings,String> defaultValue,
               Setting<T> fallbackSetting,
               Function<String,T> parser,
               Validator<T> validator)

LineLength.

参数:

key - key

defaultValue - default value

fallbackSetting - fallback setting

parser - value parser

validator - value validator

方法详细资料

getKey

public final String getKey()

Returns the settings key or a prefix if this setting is a group setting. Note: this method should not be used to retrieve a value from a Settings object. Use get(Settings) instead

另请参阅:

isGroupSetting()

getRawKey

public final Key getRawKey()

Returns the original representation of a setting key.

get

public T get(Settings settings)

Returns the settings value. If the setting is not present in the given settings object the default value is returned instead.

getRaw

public final String getRaw(Settings settings)

getDefault

public T getDefault(Settings settings)

Returns the default value for this setting.

参数:

settings - a settings object for settings that has a default value depending on another setting if available

getDefaultRaw

public String getDefaultRaw(Settings settings)

Returns the default value string representation for this setting.

参数:

settings - a settings object for settings that has a default value depending on another setting if available

exists

public boolean exists(Settings settings)

Returns true if and only if this setting is present in the given settings instance. Note that fallback settings are excluded.

参数:

settings - the settings

返回:

true if the setting is present in the given settings instance, otherwise false

existsOrFallbackExists

public boolean existsOrFallbackExists(Settings settings)

Returns true if and only if this setting including fallback settings is present in the given settings instance.

参数:

settings - the settings

返回:

true if the setting including fallback settings is present in the given settings instance, otherwise false

match

public final boolean match(String toTest)

Returns true iff the given key matches the settings key or if this setting is a group setting if the given key is part of the settings group.

另请参阅:

isGroupSetting()

newUpdater

public SettingUpdater<T> newUpdater(Consumer<T> updater,
                                    Consumer<T> validator,
                                    Logger logger)