cn.sliew.milky.common.settings

类 SettingsBuilder

java.lang.Object

cn.sliew.milky.common.settings.SettingsBuilder

public class SettingsBuilder
extends Object

A builder allowing to put different settings and then build() an immutable settings implementation. Use Settings.builder() in order to construct it.

字段概要

字段

限定符和类型	字段和说明
static Settings	EMPTY_SETTINGS

方法概要

限定符和类型	方法和说明
Settings	build() Builds a Settings (underlying uses Settings) based on everything set on this builder.
SettingsBuilder	copy(String key, Settings source)
SettingsBuilder	copy(String key, String sourceKey, Settings source) copy.
String	get(String key) Returns a setting value based on the setting key.
SettingsBuilder	put(Settings settings) Sets all the provided settings.
SettingsBuilder	put(String setting, boolean value) Sets the setting with the provided setting key and the boolean value.
SettingsBuilder	put(String setting, double value) Sets the setting with the provided setting key and the double value.
SettingsBuilder	put(String setting, float value) Sets the setting with the provided setting key and the float value.
SettingsBuilder	put(String setting, int value) Sets the setting with the provided setting key and the int value.
SettingsBuilder	put(String setting, long value) Sets the setting with the provided setting key and the long value.
SettingsBuilder	put(String key, String value) Sets a setting with the provided setting key and value.
SettingsBuilder	putList(String setting, List<String> values) Sets the setting with the provided setting key and a list of values.
SettingsBuilder	putList(String setting, String... values) Sets the setting with the provided setting key and an array of values.
SettingsBuilder	putNull(String key) Sets a null value for the given setting key.
String	remove(String key) Removes the provided setting from the internal map holding the current list of settings.
SettingsBuilder	replacePropertyPlaceholders() Runs across all the settings set on this builder and replaces ${...} elements in each setting with another setting already set on this builder.

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

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

字段详细资料

EMPTY_SETTINGS

public static final Settings EMPTY_SETTINGS

方法详细资料

remove

public String remove(String key)

Removes the provided setting from the internal map holding the current list of settings.

get

public String get(String key)

Returns a setting value based on the setting key.

putNull

public SettingsBuilder putNull(String key)

Sets a null value for the given setting key.

put

public SettingsBuilder put(String key,
                           String value)

Sets a setting with the provided setting key and value.

参数:

key - The setting key

value - The setting value

返回:

The builder

put

public SettingsBuilder put(String setting,
                           float value)

Sets the setting with the provided setting key and the float value.

参数:

setting - The setting key

value - The float value

返回:

The builder

put

public SettingsBuilder put(String setting,
                           double value)

Sets the setting with the provided setting key and the double value.

参数:

setting - The setting key

value - The double value

返回:

The builder

put

public SettingsBuilder put(String setting,
                           int value)

Sets the setting with the provided setting key and the int value.

参数:

setting - The setting key

value - The int value

返回:

The builder

put

public SettingsBuilder put(String setting,
                           long value)

Sets the setting with the provided setting key and the long value.

参数:

setting - The setting key

value - The long value

返回:

The builder

put

public SettingsBuilder put(String setting,
                           boolean value)

Sets the setting with the provided setting key and the boolean value.

参数:

setting - The setting key

value - The boolean value

返回:

The builder

putList

public SettingsBuilder putList(String setting,
                               String... values)

Sets the setting with the provided setting key and an array of values.

参数:

setting - The setting key

values - The values

返回:

The builder

putList

public SettingsBuilder putList(String setting,
                               List<String> values)

Sets the setting with the provided setting key and a list of values.

参数:

setting - The setting key

values - The values

返回:

The builder

put

public SettingsBuilder put(Settings settings)

Sets all the provided settings.

参数:

settings - the settings to set

copy

public SettingsBuilder copy(String key,
                            Settings source)

copy

public SettingsBuilder copy(String key,
                            String sourceKey,
                            Settings source)

copy.

参数:

key - key

sourceKey - source key

source - source settings

replacePropertyPlaceholders

public SettingsBuilder replacePropertyPlaceholders()

Runs across all the settings set on this builder and replaces ${...} elements in each setting with another setting already set on this builder.

build

public Settings build()

Builds a Settings (underlying uses Settings) based on everything set on this builder.