Package com.saicone.settings

Class Settings

java.lang.Object

com.saicone.settings.node.NodeValue<V>

com.saicone.settings.node.NodeKey<Map<String,SettingsNode>>

com.saicone.settings.node.MapNode

com.saicone.settings.Settings

All Implemented Interfaces:

SettingsNode, com.saicone.types.ValueType<Object>, Iterable<Map.Entry<String,SettingsNode>>, Map<String,SettingsNode>

public class Settings
extends MapNode

Class that represent flexible configuration itself.

Nested Class Summary

Nested classes/interfaces inherited from interface java.util.Map

Map.Entry<K extends Object,V extends Object>

Constructor Summary

Constructors

Constructor	Description
Settings()	Constructs an empty settings object. By default, key insertion order will be maintained.
Settings(@NotNull Map<String,SettingsNode> nodes)	Constructs a settings object with the given map type.
Settings(@NotNull Map<String,SettingsNode> nodes, @Nullable SettingsMemory memory)	Constructs a settings with the given parameters.
Settings(@Nullable SettingsMemory memory)	Constructs an empty settings object with given memory. By default, key insertion order will be maintained.

Method Summary

Modifier and Type	Method	Description
void	clear()
@NotNull SettingsNode	get(@NotNull String key)	Get the node associated with the given key.
@NotNull SettingsNode	get(@NotNull String... path)	Get the node associated with the given key path.
@NotNull SettingsNode	getIgnoreCase(@NotNull String key)	Get the node associated with the given key ignoring case considerations.
@NotNull SettingsNode	getIgnoreCase(@NotNull String... path)	Get the node associated with the given key path ignoring case considerations.
@Nullable SettingsMemory	getMemory()	Get the instance that save path ids.
@NotNull SettingsNode	getRegex(@NotNull String regex)	Get the node whose key matches with given regex expression. Instead of MapNode.get(String) or MapNode.getIgnoreCase(String) this method may create a new node without any defined key.
@NotNull SettingsNode	getRegex(@NotNull String... regexPath)	Get the node whose key path matches with given regex expressions. Instead of MapNode.get(String...) or MapNode.getIgnoreCase(String...) this method may create a new node without any defined key.
boolean	isMemorizing()	Check if the settings instance is memorizing node path ids.
protected void	remove(@NotNull SettingsNode node)	Executed method when any node is deleted by the value itself.
SettingsNode	remove(Object key)
protected @NotNull SettingsNode	save(@NotNull String id, @NotNull Supplier<@NotNull SettingsNode> supplier)	Save supplier value into memory or get from if it actually exists.
@NotNull Settings	setMapMemory()	Set a regular map memory on this instance.
@NotNull Settings	setMemory(@Nullable SettingsMemory memory)	Replace the used settings memory on this instance.

Methods inherited from class com.saicone.settings.node.MapNode

asJson, asJson, asLiteralObject, child, child, child, child, containsKey, containsValue, deepMerge, deepMerge, edit, entrySet, get, getIf, getIf, getIf, getIfType, getRoot, getSplit, isEmpty, isMap, iterator, keySet, merge, merge, merge, merge, paths, put, put, putAll, remove, removeIf, removeIf, set, setValue, size, values

Methods inherited from class com.saicone.settings.node.NodeKey

getKey, getParent, of, setKey, setParent

Methods inherited from class com.saicone.settings.node.NodeValue

as, as, asCollection, asEnum, asEnum, asOptional, equals, getFaceValue, getSideComment, getSourceValue, getTopComment, getValue, hashCode, hasSideComment, hasTopComment, of, setSideComment, setSourceValue, setTopComment, toString

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Methods inherited from interface java.util.Map

compute, computeIfAbsent, computeIfPresent, equals, forEach, getOrDefault, hashCode, merge, putIfAbsent, remove, replace, replace, replaceAll

Methods inherited from interface com.saicone.settings.SettingsNode

addSideComment, addTopComment, asListNode, asMapNode, asObjectNode, copy, copy, copy, delete, delete, edit, isList, isObject, isReal, isRoot, merge, mergeComment, move, parse, parse, replaceArgs, replaceArgs

Methods inherited from interface com.saicone.types.ValueType

as, as, asArray, asArray, asArray, asBoolean, asBoolean, asByte, asByte, asChar, asChar, asDouble, asDouble, asFloat, asFloat, asInt, asInt, asList, asLong, asLong, asMap, asNumber, asNumber, asSet, asShort, asShort, asString, asString, asUniqueId, asUniqueId

Constructor Detail

Settings

public Settings()

Constructs an empty settings object.
By default, key insertion order will be maintained.

Settings

public Settings(@NotNull
                @NotNull Map<String,SettingsNode> nodes)

Constructs a settings object with the given map type.

Parameters:

nodes - the map to save nodes into.

Settings

public Settings(@Nullable
                @Nullable SettingsMemory memory)

Constructs an empty settings object with given memory.
By default, key insertion order will be maintained.

Parameters:

memory - the memory to save node path ids.

Settings

public Settings(@NotNull
                @NotNull Map<String,SettingsNode> nodes,
                @Nullable
                @Nullable SettingsMemory memory)

Constructs a settings with the given parameters.

Parameters:

nodes - the map to save nodes into.

memory - the memory to save node path ids.

Method Detail

isMemorizing

public boolean isMemorizing()

Check if the settings instance is memorizing node path ids.

Returns:

true if any memory instance is been used.

getMemory

@Nullable
public @Nullable SettingsMemory getMemory()

Get the instance that save path ids.

Returns:

a settings memory instance.

get

@NotNull
public @NotNull SettingsNode get(@NotNull
                                 @NotNull String key)

Description copied from class: MapNode

Get the node associated with the given key.

Overrides:

get in class MapNode

Parameters:

key - the node key.

Returns:

a node from the map or a newly created instead.

get

@NotNull
public @NotNull SettingsNode get(@NotNull
                                 @NotNull String... path)

Description copied from class: MapNode

Get the node associated with the given key path.

Overrides:

get in class MapNode

Parameters:

path - the node path.

Returns:

a node from any sub map or a newly created instead.

getIgnoreCase

@NotNull
public @NotNull SettingsNode getIgnoreCase(@NotNull
                                           @NotNull String key)

Description copied from class: MapNode

Get the node associated with the given key ignoring case considerations.

Overrides:

getIgnoreCase in class MapNode

Parameters:

key - the node key.

Returns:

a node from the map or a newly created instead.

getIgnoreCase

@NotNull
public @NotNull SettingsNode getIgnoreCase(@NotNull
                                           @NotNull String... path)

Description copied from class: MapNode

Get the node associated with the given key path ignoring case considerations.

Overrides:

getIgnoreCase in class MapNode

Parameters:

path - the node path.

Returns:

a node from any sub map or a newly created instead.

getRegex

@NotNull
public @NotNull SettingsNode getRegex(@NotNull @Language("RegExp")
                                      @NotNull String regex)

Description copied from class: MapNode

Get the node whose key matches with given regex expression.
Instead of MapNode.get(String) or MapNode.getIgnoreCase(String) this method may create a new node without any defined key.

Overrides:

getRegex in class MapNode

Parameters:

regex - the expression to be compiled.

Returns:

a node from the map or a newly created without any defined key.

getRegex

@NotNull
public @NotNull SettingsNode getRegex(@NotNull @Language("RegExp")
                                      @NotNull String... regexPath)

Description copied from class: MapNode

Get the node whose key path matches with given regex expressions.
Instead of MapNode.get(String...) or MapNode.getIgnoreCase(String...) this method may create a new node without any defined key.

Overrides:

getRegex in class MapNode

Parameters:

regexPath - the expressions to be compiled.

Returns:

a node from any sub map or a newly created without any defined key.

save

@NotNull
protected @NotNull SettingsNode save(@NotNull
                                     @NotNull String id,
                                     @NotNull
                                     @NotNull Supplier<@NotNull SettingsNode> supplier)

Save supplier value into memory or get from if it actually exists.

Parameters:

id - the value id.

supplier - the supplier to get value.

Returns:

the value from memory or the newly generated one.

setMemory

@NotNull
@Contract("_ -> this")
public @NotNull Settings setMemory(@Nullable
                                   @Nullable SettingsMemory memory)

Replace the used settings memory on this instance.

Parameters:

memory - the memory to save queried values.

Returns:

the effective settings object in this operation, normally this instance.

setMapMemory

@NotNull
@Contract("-> this")
public @NotNull Settings setMapMemory()

Set a regular map memory on this instance.

Returns:

the effective settings object in this operation, normally this instance.

remove

protected void remove(@NotNull
                      @NotNull SettingsNode node)

Description copied from class: MapNode

Executed method when any node is deleted by the value itself.

Overrides:

remove in class MapNode

Parameters:

node - the deleted node.

remove

public SettingsNode remove(Object key)

Specified by:

remove in interface Map<String,SettingsNode>

Overrides:

remove in class MapNode

clear

public void clear()

Specified by:

clear in interface Map<String,SettingsNode>

Overrides:

clear in class MapNode