Index (settings 1.0 API)

A C D E F G H I J K L M N O P R S T U V W Y
All Classes All Packages

A

add(int, SettingsNode) - Method in class com.saicone.settings.node.ListNode
add(Object) - Static method in class com.saicone.settings.update.NodeUpdate: Create a node update that aims to add the provided value.
add(SettingsNode) - Method in class com.saicone.settings.node.ListNode
ADD - com.saicone.settings.update.UpdateAction: Add non-existent node with value.
addAll(int, Collection<? extends SettingsNode>) - Method in class com.saicone.settings.node.ListNode
addAll(Collection<? extends SettingsNode>) - Method in class com.saicone.settings.node.ListNode
addExpression(String, ExpressionParser) - Method in class com.saicone.settings.SettingsParser: Add a expression parser into current instance.
addParser(NodeParser) - Method in class com.saicone.settings.SettingsParser: Add a node parser into current instance.
addSideComment(List<String>) - Method in interface com.saicone.settings.SettingsNode: Add comment lines to the actual side comment.
addSource(String, Class<? extends SettingsSource>) - Static method in class com.saicone.settings.data.DataFormat: Append a settings source instance associated with data format.
This method will ignore any repeated format.
addTopComment(List<String>) - Method in interface com.saicone.settings.SettingsNode: Add comment lines to the actual top comment.
all() - Static method in class com.saicone.settings.parser.Expressions: Constructs a map with all expression parsers in this class.
all() - Static method in class com.saicone.settings.parser.Parsers: Constructs a list with all node parsers in this class.
all() - Static method in class com.saicone.settings.SettingsLoader: Get a settings loader with all the supported transformations using SettingsUpdater.simple() and SettingsParser.all().
all() - Static method in class com.saicone.settings.SettingsParser: Get a settings parser with any expression from Expressions and parser from Parsers.
apply(MapNode) - Method in class com.saicone.settings.update.NodeUpdate: Apply this node update into provided map node parent.
as(TypeParser<E>, E) - Method in class com.saicone.settings.node.NodeValue
as(Class<E>, E) - Method in class com.saicone.settings.node.NodeValue
asBooleanList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of booleans.
asByteList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of bytes.
asCharList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of characters.
asCollection(TypeParser<E>, C) - Method in class com.saicone.settings.node.NodeValue
asDoubleList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of doubles.
asEnum(Class<E>) - Method in class com.saicone.settings.node.NodeValue
asEnum(Class<E>, E[]) - Method in class com.saicone.settings.node.NodeValue
asFloatList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of floats.
asIntList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of integers.
asJson() - Method in class com.saicone.settings.node.MapNode: Get the current map node as Json formatted text.
asJson(Object) - Method in class com.saicone.settings.node.MapNode: Get the provided object as it's json representation.
asList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of objects.
asListNode() - Method in interface com.saicone.settings.SettingsNode: Cast this node into a list node type.
asLiteralObject() - Method in class com.saicone.settings.node.ListNode
asLiteralObject() - Method in class com.saicone.settings.node.MapNode
asLiteralObject() - Method in interface com.saicone.settings.SettingsNode: Get the literal object represented by this node, in other words, if the node is a map of nodes, a map of objects wil be return, if the node is a list of nodes, a list of objects will be return, otherwise the value from ValueType.getValue() will be return.
This is an expensive operation due every child node or list element will be return as it's literal object recursively, so it's not suggested to use this method frequently.
asLongList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of longs.
asMapNode() - Method in interface com.saicone.settings.SettingsNode: Cast this node into a map node type.
asObjectNode() - Method in interface com.saicone.settings.SettingsNode: Cast this node into an object node type.
asOptional(TypeParser<E>) - Method in class com.saicone.settings.node.NodeValue
asShortList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of shorts.
asStringList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of strings.
asUniqueIdList() - Method in interface com.saicone.settings.type.ListValueType: Convert this object into a list of unique IDs.

C

CacheMemory - Class in com.saicone.settings.memory: Class to save settings nodes into cache instance.
Only compatible with Caffeine and Guava cache.
CacheMemory(long, TimeUnit) - Constructor for class com.saicone.settings.memory.CacheMemory: Constructs a cache memory with given parameters.
child() - Method in class com.saicone.settings.node.MapNode: Create an empty child node without any associated key.
child(String) - Method in class com.saicone.settings.node.MapNode: Create a child node with the given key.
This method put the node into current map.
child(String, Object) - Method in class com.saicone.settings.node.MapNode: Create a child node with the given key and value.
This method put the node into current map.
child(String, Object, boolean) - Method in class com.saicone.settings.node.MapNode: Create or append a child node with the given key and value.
This method put the node into current map.
clear() - Method in class com.saicone.settings.memory.MapMemory
clear() - Method in class com.saicone.settings.node.ListNode
clear() - Method in class com.saicone.settings.node.MapNode
clear() - Method in class com.saicone.settings.Settings
clear() - Method in interface com.saicone.settings.SettingsMemory: Clear the current settings memory.
com.saicone.settings - package com.saicone.settings
com.saicone.settings.data - package com.saicone.settings.data
com.saicone.settings.memory - package com.saicone.settings.memory
com.saicone.settings.node - package com.saicone.settings.node
com.saicone.settings.parser - package com.saicone.settings.parser
com.saicone.settings.parser.impl - package com.saicone.settings.parser.impl
com.saicone.settings.source - package com.saicone.settings.source
com.saicone.settings.type - package com.saicone.settings.type
com.saicone.settings.update - package com.saicone.settings.update
com.saicone.settings.util - package com.saicone.settings.util
constructObject(Node) - Method in class com.saicone.settings.source.YamlSettingsSource.PublicConstructor
contains(Object) - Method in class com.saicone.settings.node.ListNode
containsAll(Collection<?>) - Method in class com.saicone.settings.node.ListNode
containsKey(Object) - Method in class com.saicone.settings.node.MapNode
containsValue(Object) - Method in class com.saicone.settings.node.MapNode
copy() - Method in interface com.saicone.settings.SettingsNode: Copy this node into new one and return the clone itself.
copy(boolean) - Method in interface com.saicone.settings.SettingsNode: Copy this node into new one and return the clone itself.
copy(boolean, boolean) - Method in interface com.saicone.settings.SettingsNode: Copy this node into new one and return the clone itself.
createReader() - Method in class com.saicone.settings.SettingsData: Create a reader depending on data type.
createWriter() - Method in class com.saicone.settings.SettingsData: Create a writer depending on data type.
custom(Function<MapNode, Boolean>) - Static method in class com.saicone.settings.update.NodeUpdate: Create a node update that aims to do a custom transformation.
CUSTOM - com.saicone.settings.update.UpdateAction: Custom update action not listed on UpdateAction.

D

DataFormat - Class in com.saicone.settings.data: Utility class to collect supported data formats and register any settings source parser.
DataType - Enum in com.saicone.settings.data: Data types to load from.
deepMerge(Map<?, ?>) - Method in class com.saicone.settings.node.MapNode: Merge any type of map into map node by creating the required settings nodes or overriding the parent node.
This method go inside subsequent maps to merge the subsequent maps inside given map.
deepMerge(Map<?, ?>, boolean) - Method in class com.saicone.settings.node.MapNode: Merge any type of map into map node by creating the required settings nodes or overriding the parent node.
This method go inside subsequent maps to merge the subsequent maps inside given map.
delete() - Method in interface com.saicone.settings.SettingsNode: Delete this node from any parent node.
delete() - Static method in class com.saicone.settings.update.NodeUpdate: Create a node update that aims to delete a node.
delete(boolean) - Method in interface com.saicone.settings.SettingsNode: Delete this node from any parent node.
DELETE - com.saicone.settings.update.UpdateAction: Delete node from path.

E

edit(Consumer<SettingsNode>) - Method in interface com.saicone.settings.SettingsNode: Edit every object inside this node.
This means if this node is a list or map type will be iterated recursively to edit every child or element inside map or list with the provided consumer.
edit(Function<SettingsNode, SettingsNode>) - Method in class com.saicone.settings.node.ListNode
edit(Function<SettingsNode, SettingsNode>) - Method in class com.saicone.settings.node.MapNode
edit(Function<SettingsNode, SettingsNode>) - Method in interface com.saicone.settings.SettingsNode: Edit every object inside this node.
This means if this node is a list or map type will be iterated recursively to edit every child or element inside map or list with the provided function.
Take in count you can return a null value from function to delete map or list value, and also return a new node to replace the provided map or list value.
empty() - Static method in class com.saicone.settings.SettingsLoader: Get an empty settings loader without any transformation.
empty() - Static method in class com.saicone.settings.SettingsParser: Get an empty settings parser that doesn't do anything with given nodes.
entrySet() - Method in class com.saicone.settings.node.MapNode
equals(Object) - Method in class com.saicone.settings.node.NodeValue
ExpressionParser - Interface in com.saicone.settings.parser: Represents a function that parse any type of node and build a value.
Expressions - Class in com.saicone.settings.parser: Utility class to collect node expressions that can be parsed.
EXTENDS - Static variable in class com.saicone.settings.parser.Parsers: Parser that accept a map node that extends a node template.

F

FILE - com.saicone.settings.data.DataType: A regular file data type.
FILE_RESOURCE - com.saicone.settings.data.DataType: A file that can be obtained from class loader resources.
from(String...) - Method in class com.saicone.settings.update.NodeUpdate: Set the node path where it will be got.
from(Function<MapNode, SettingsNode>) - Method in class com.saicone.settings.update.NodeUpdate: Set the current node getter of this update.
fromIgnoreCase(String...) - Method in class com.saicone.settings.update.NodeUpdate: Set the node path where it will be got.
This type of path ignores key case.
fromRegex(String...) - Method in class com.saicone.settings.update.NodeUpdate: Set the node path where it will be got.
This type of path compares any children node key with the provided regex pattern array.

G

get(int) - Method in class com.saicone.settings.node.ListNode
get(String) - Method in class com.saicone.settings.memory.MapMemory
get(String) - Method in class com.saicone.settings.node.MapNode: Get the node associated with the given key.
get(String) - Method in class com.saicone.settings.Settings
get(String) - Method in interface com.saicone.settings.SettingsMemory: Get the previously saved node by given path id.
get(String...) - Method in class com.saicone.settings.node.MapNode: Get the node associated with the given key path.
get(String...) - Method in class com.saicone.settings.Settings
get(Object) - Method in class com.saicone.settings.node.MapNode
getAction() - Method in class com.saicone.settings.update.NodeUpdate: Get the update action.
getAliases() - Method in enum com.saicone.settings.data.DataType: Get data type aliases.
getConstructor() - Method in class com.saicone.settings.source.YamlSettingsSource.PublicYaml: Get the used constructor instance that read yaml objects.
getDataType() - Method in class com.saicone.settings.SettingsData: Get the type this data come from.
getDuration() - Method in class com.saicone.settings.memory.CacheMemory: Get the max duration to save nodes.
getExpressions() - Method in class com.saicone.settings.SettingsParser: Get the current expression parsers.
getExtension(String) - Static method in class com.saicone.settings.data.DataFormat: Get the file extension from provided data format.
getExtensions() - Static method in class com.saicone.settings.data.DataFormat: Get all the registered file extensions as unmodifiable set.
getFaceValue() - Method in class com.saicone.settings.node.NodeValue: Get the facing value inside the node.
getFile() - Method in class com.saicone.settings.SettingsData: Get effective settings file using current path and parent folder.
getFormat() - Method in class com.saicone.settings.SettingsData: Get the current data format.
getFormat() - Method in class com.saicone.settings.source.TomlSettingsSource: Get the current toml format loader instance.
getFormat(String) - Static method in class com.saicone.settings.data.DataFormat: Get data format from provided file extension.
getFormats() - Static method in class com.saicone.settings.data.DataFormat: Get all formats with associated settings source.
getGson() - Method in class com.saicone.settings.source.GsonSettingsSource: Get the current gson instance.
getIf(BiPredicate<String, String>, String...) - Method in class com.saicone.settings.node.MapNode: Get a node by applying a key comparison.
getIf(Function<String, T>, BiPredicate<String, T>, String...) - Method in class com.saicone.settings.node.MapNode: Get a node by applying a custom key conversion comparison.
getIf(Predicate<String>, String) - Method in class com.saicone.settings.node.MapNode: Get a node by applying a key comparison.
getIfType(BiPredicate<String, T>, T) - Method in class com.saicone.settings.node.MapNode: Get a node from the current map by applying a type condition along with node key.
getIgnoreCase(String) - Method in class com.saicone.settings.node.MapNode: Get the node associated with the given key ignoring case considerations.
getIgnoreCase(String) - Method in class com.saicone.settings.Settings
getIgnoreCase(String...) - Method in class com.saicone.settings.node.MapNode: Get the node associated with the given key path ignoring case considerations.
getIgnoreCase(String...) - Method in class com.saicone.settings.Settings
getKey() - Method in class com.saicone.settings.node.NodeKey
getKey() - Method in interface com.saicone.settings.SettingsNode: Get the node key associated with this node.
getLoaded() - Method in class com.saicone.settings.SettingsData: Get loaded settings node instance.
getMemory() - Method in class com.saicone.settings.Settings: Get the instance that save path ids.
getNearestFile(String) - Method in class com.saicone.settings.SettingsData: Get the nearest file using provided data format.
getNode(MapNode) - Method in class com.saicone.settings.update.NodeUpdate: Get a node from the given map node using the current node getter.
getNodeSupplier() - Method in class com.saicone.settings.SettingsData: Get the current node supplier that build loadable settings node type.
getNodeUpdates() - Method in class com.saicone.settings.update.SettingsUpdater: Get every node update from this class.
getOptional() - Method in class com.saicone.settings.SettingsData: Get the current optional settings data.
getOptionalLoaded() - Method in class com.saicone.settings.SettingsData: Get the optional loaded settings node instance.
getParent() - Method in class com.saicone.settings.node.NodeKey
getParent() - Method in interface com.saicone.settings.SettingsNode: Get the parent node that this node is child of.
getParseOptions() - Method in class com.saicone.settings.source.HoconSettingsSource: Get the parse options.
getParser() - Method in class com.saicone.settings.SettingsLoader: Get used settings parser in this instance.
getParsers() - Method in class com.saicone.settings.SettingsParser: Get the current node parsers list.
getPath() - Method in class com.saicone.settings.SettingsData: Get the path this data come from.
getPath() - Method in class com.saicone.settings.update.NodeUpdate: Get the path that this node update will be to.
getRegex(String) - Method in class com.saicone.settings.node.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.
getRegex(String) - Method in class com.saicone.settings.Settings
getRegex(String...) - Method in class com.saicone.settings.node.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.
getRegex(String...) - Method in class com.saicone.settings.Settings
getRenderOptions() - Method in class com.saicone.settings.source.HoconSettingsSource: Get the render options.
getRepresenter() - Method in class com.saicone.settings.source.YamlSettingsSource.PublicYaml: Get the used representer instance that write yaml objects.
getResolveOptions() - Method in class com.saicone.settings.source.HoconSettingsSource: Get the resolve options.
getResourceAsStream() - Method in class com.saicone.settings.SettingsData: Get effective settings stream using current path and parent class loader.
getRoot() - Method in class com.saicone.settings.node.MapNode
getRoot() - Method in interface com.saicone.settings.SettingsNode: Get root value from node tree.
getSideComment() - Method in class com.saicone.settings.node.NodeValue
getSideComment() - Method in interface com.saicone.settings.SettingsNode: Get side comment from the node.
getSource() - Method in class com.saicone.settings.SettingsData: Get the current settings source of load a new one.
getSource(String) - Static method in class com.saicone.settings.data.DataFormat: Get a new settings source instance from any registered source.
getSourceValue() - Method in class com.saicone.settings.node.NodeValue
getSourceValue() - Method in interface com.saicone.settings.SettingsNode: Get the value that will be used to save this node.
getSplit(Object) - Method in class com.saicone.settings.node.MapNode: Get the node associated with the given path.
This method will split by dots the provided path into keys to be used with MapNode.get(String...).
getTopComment() - Method in class com.saicone.settings.node.NodeValue
getTopComment() - Method in interface com.saicone.settings.SettingsNode: Get top comment from the node.
getUnit() - Method in class com.saicone.settings.memory.CacheMemory: Get the duration time unit.
getUpdater() - Method in class com.saicone.settings.SettingsLoader: Get used settings updater in this instance.
getValue() - Method in class com.saicone.settings.node.NodeValue
getValue() - Method in class com.saicone.settings.update.NodeUpdate: Get the value that will be set into node.
getYaml() - Method in class com.saicone.settings.source.YamlSettingsSource: Get the current yaml instance.
GsonSettingsSource - Class in com.saicone.settings.source: A settings source for json-formatted data
This class uses google gson library as the name says to read and write any data.
GsonSettingsSource() - Constructor for class com.saicone.settings.source.GsonSettingsSource: Constructs a gson settings source with default options.
This means the data will be written using pretty printing.
GsonSettingsSource(Gson) - Constructor for class com.saicone.settings.source.GsonSettingsSource: Constructs a gson settings source with provided gson instance.

H

hashCode() - Method in class com.saicone.settings.node.NodeValue
hasSideComment() - Method in class com.saicone.settings.node.NodeValue
hasSideComment() - Method in interface com.saicone.settings.SettingsNode: Check if the current node has any side comment.
hasTopComment() - Method in class com.saicone.settings.node.NodeValue
hasTopComment() - Method in interface com.saicone.settings.SettingsNode: Check if the current node has any top comment.
HoconSettingsSource - Class in com.saicone.settings.source: A settings source for hocon-formatted data
This class uses lightbend config library to read and write any data.
HoconSettingsSource() - Constructor for class com.saicone.settings.source.HoconSettingsSource: Constructs a hocon settings source with default options.
This means any comment will be parsed.
HoconSettingsSource(ConfigParseOptions, ConfigRenderOptions) - Constructor for class com.saicone.settings.source.HoconSettingsSource: Constructs a hocon settings source with provided parameters.
HoconSettingsSource(ConfigParseOptions, ConfigRenderOptions, ConfigResolveOptions) - Constructor for class com.saicone.settings.source.HoconSettingsSource: Constructs a hocon settings source with provided parameters.

I

indexOf(Object) - Method in class com.saicone.settings.node.ListNode
INPUT_STREAM - com.saicone.settings.data.DataType: A input stream that can be obtained from class loader.
isEmpty() - Method in class com.saicone.settings.node.ListNode
isEmpty() - Method in class com.saicone.settings.node.MapNode
isFile() - Method in enum com.saicone.settings.data.DataType: Check if data is a type of file.
isList() - Method in class com.saicone.settings.node.ListNode
isList() - Method in interface com.saicone.settings.SettingsNode: Check if the current node is a list instance.
isMap() - Method in class com.saicone.settings.node.MapNode
isMap() - Method in interface com.saicone.settings.SettingsNode: Check if the current node is a map instance.
isMemorizing() - Method in class com.saicone.settings.Settings: Check if the settings instance is memorizing node path ids.
isObject() - Method in class com.saicone.settings.node.ObjectNode
isObject() - Method in interface com.saicone.settings.SettingsNode: Check if the current node is not a map or list.
isReal() - Method in interface com.saicone.settings.SettingsNode: Check if the current node is a real node.
isRoot() - Method in interface com.saicone.settings.SettingsNode: Check if the current node is the root node.
isWriteable() - Method in enum com.saicone.settings.data.DataType: Check if data type allows to write data into.
iterator() - Method in class com.saicone.settings.node.ListNode
iterator() - Method in class com.saicone.settings.node.MapNode

J

JOIN - Static variable in class com.saicone.settings.parser.Expressions: Expression to join a node values from key path.

K

keySet() - Method in class com.saicone.settings.node.MapNode

L

lastIndexOf(Object) - Method in class com.saicone.settings.node.ListNode
listIterator() - Method in class com.saicone.settings.node.ListNode
listIterator(int) - Method in class com.saicone.settings.node.ListNode
ListNode - Class in com.saicone.settings.node: Class to handle a list of settings nodes.
This object can also be handled as regular Java list.
ListNode() - Constructor for class com.saicone.settings.node.ListNode: Constructs an empty list of nodes.
ListNode(MapNode, String) - Constructor for class com.saicone.settings.node.ListNode: Constructs an list node with the given parameters.
ListNode(MapNode, String, List<SettingsNode>) - Constructor for class com.saicone.settings.node.ListNode: Constructs an list node with the given parameters.
ListNode(List<SettingsNode>) - Constructor for class com.saicone.settings.node.ListNode: Constructs an list node with the given list value.
ListValueType<T> - Interface in com.saicone.settings.type: Represents a value that can be converted into different types of objects.
load() - Method in class com.saicone.settings.SettingsData: Load the current settings data into node.
load(boolean) - Method in class com.saicone.settings.SettingsData: Load the current settings data into node.
load(SettingsData<T>) - Method in class com.saicone.settings.SettingsLoader: Load the provided settings data and return the loaded map node.
load(File) - Method in class com.saicone.settings.SettingsData: Load the current settings data into node.
load(File, boolean) - Method in class com.saicone.settings.SettingsData: Load the current settings data into node.
load(ClassLoader) - Method in class com.saicone.settings.SettingsData: Load the current settings data into node.
load(ClassLoader, boolean) - Method in class com.saicone.settings.SettingsData: Load the current settings data into node.
loaded(T) - Method in class com.saicone.settings.SettingsData: Set the loaded settings node from data.
loadSource(String) - Method in class com.saicone.settings.SettingsData: Create a settings source from provided source type id.

M

MapMemory - Class in com.saicone.settings.memory: Class to save settings nodes into Java map.
MapMemory() - Constructor for class com.saicone.settings.memory.MapMemory: Constructs a map memory to save nodes.
MapMemory(Map<String, SettingsNode>) - Constructor for class com.saicone.settings.memory.MapMemory: Constructs a map memory to save node into provided map.
MapNode - Class in com.saicone.settings.node: Class to handle a map of settings nodes.
This object can also be handled as regular Java map and inherited in enhanced for loop.
MapNode() - Constructor for class com.saicone.settings.node.MapNode: Constructs an empty map of nodes.
MapNode(MapNode, String) - Constructor for class com.saicone.settings.node.MapNode: Constructs a map node with the given parameters.
MapNode(MapNode, String, Map<String, SettingsNode>) - Constructor for class com.saicone.settings.node.MapNode: Constructs a map node with the given parameters.
MapNode(Map<String, SettingsNode>) - Constructor for class com.saicone.settings.node.MapNode: Constructs a map node with the given map value.
MATH - Static variable in class com.saicone.settings.parser.Expressions: Expression to calculate a mathematical operation.
EvalEx library must be in the current classpath.
MathExpression - Class in com.saicone.settings.parser.impl: Class to calculate mathematical operations as node expression parser.
MathExpression() - Constructor for class com.saicone.settings.parser.impl.MathExpression
merge(SettingsNode) - Method in interface com.saicone.settings.SettingsNode: Merge to provided node information into current node.
Only node source value and comments will be merged.
merge(Iterable<?>) - Method in class com.saicone.settings.node.ListNode: Merge provided iterable object into the current list of nodes.
This method also creates a node value for each inherited value.
merge(Map<?, ?>) - Method in class com.saicone.settings.node.MapNode: Merge any type of map into map node by creating the required settings nodes or overriding the parent node.
merge(Map<?, ?>, boolean) - Method in class com.saicone.settings.node.MapNode: Merge any type of map into map node by creating the required settings nodes or overriding the parent node.
merge(Map<?, ?>, boolean, boolean) - Method in class com.saicone.settings.node.MapNode: Merge any type of map into map node by creating the required settings nodes or overriding the parent node.
merge(Map<?, ?>, boolean, boolean, boolean) - Method in class com.saicone.settings.node.MapNode: Merge any type of map into map node by creating the required settings nodes or overriding the parent node.
mergeComment(SettingsNode) - Method in interface com.saicone.settings.SettingsNode: Merge the provided node comments into current node.
move() - Static method in class com.saicone.settings.update.NodeUpdate: Create a node update that aims to move an existent node.
move(String...) - Method in interface com.saicone.settings.SettingsNode: Move this node to other key path.
This operation only will be effective if the current node contains a parent node, otherwise only it's key will be updated with latest path key.
MOVE - com.saicone.settings.update.UpdateAction: Move existent node to path.

N

NODE - Static variable in class com.saicone.settings.parser.Expressions: Expression to get a node with value replaced arguments.
NodeKey<V> - Class in com.saicone.settings.node: Class that represents a node with parent node and key parameter along with value.
NodeKey(MapNode, String, V) - Constructor for class com.saicone.settings.node.NodeKey: Constructs a node key with the given parameters.
NodeKey(MapNode, V) - Constructor for class com.saicone.settings.node.NodeKey: Constructs a node key with the given parameters.
NodeParser - Interface in com.saicone.settings.parser: Represents a function that parse any type of node and return a node.
NodeUpdate - Class in com.saicone.settings.update: Class to handle any node transformation to do a proper update.
NodeUpdate(UpdateAction) - Constructor for class com.saicone.settings.update.NodeUpdate: Construct a node update with the given update action.
NodeValue<V> - Class in com.saicone.settings.node: Abstract class that represents a node multi-layer value along with comments.
Any type transformation will be cached.
NodeValue(V) - Constructor for class com.saicone.settings.node.NodeValue: Constructs a node value with the given object.

O

ObjectNode - Class in com.saicone.settings.node: Class to handle normal object as settings node.
This object can be inherited in enhanced for loop.
ObjectNode() - Constructor for class com.saicone.settings.node.ObjectNode: Constructs an empty object value.
ObjectNode(MapNode, String) - Constructor for class com.saicone.settings.node.ObjectNode: Constructs an empty object node with the given parameters.
ObjectNode(MapNode, String, Object) - Constructor for class com.saicone.settings.node.ObjectNode: Constructs an empty object node with the given parameters.
ObjectNode(Object) - Constructor for class com.saicone.settings.node.ObjectNode: Constructs an object node with the given value.
of(long, TimeUnit) - Static method in class com.saicone.settings.memory.CacheMemory: Create a cache memory with the given parameters.
of(DataType, String) - Static method in class com.saicone.settings.SettingsData: Create a settings data instance that load Settings object from provided path with data type.
of(String) - Static method in enum com.saicone.settings.data.DataType: Get data type from given string by finding any header.
of(String) - Static method in class com.saicone.settings.SettingsData: Create a settings data instance that load Settings object from provided data path.
of(MapNode, String, Object) - Static method in class com.saicone.settings.node.NodeKey: Create a node key with the given parameters.
of(Object) - Static method in class com.saicone.settings.node.NodeValue: Create a node value with the given object.
of(T) - Static method in interface com.saicone.settings.type.ListValueType: Create a wrapped value type from given object type.
optionalSupply(boolean) - Method in class com.saicone.settings.SettingsData: Set the optional supply state in this class.
or(DataType, String) - Method in class com.saicone.settings.SettingsData: Set the optional settings data to provide a node in case this data path doesn't exist.
or(SettingsData<T>) - Method in class com.saicone.settings.SettingsData: Set the optional settings data instance to provide a node in case this data path doesn't exist.

P

parentClassLoader(ClassLoader) - Method in class com.saicone.settings.SettingsData: Set the parent class loader to load this data from.
parentFolder(File) - Method in class com.saicone.settings.SettingsData: Set the parent folder to load this data from.
parse(MapNode, SettingsNode) - Method in interface com.saicone.settings.parser.NodeParser: Parse the given parameters into a settings node.
parse(MapNode, SettingsNode, Object...) - Method in interface com.saicone.settings.parser.ExpressionParser: Parse the given parameters into any type of object.
parse(MapNode, SettingsNode, Object...) - Method in class com.saicone.settings.parser.impl.MathExpression
parse(MapNode, SettingsNode, String) - Method in class com.saicone.settings.SettingsParser: Build a parsed value with provided parameters.
parse(MapNode, SettingsNode) - Method in class com.saicone.settings.SettingsParser: Parse the provided node with used root node.
parse(BiFunction<SettingsNode, String, Object>) - Method in interface com.saicone.settings.SettingsNode: Parse every text value inside this node.
This means if this node is a list or map type will be iterated recursively to parse every string on child or element inside map or list with the provided function.
Take in count only the value from ValueType.getValue() will be used to check if the node is a string or not.
parse(SettingsNode) - Method in class com.saicone.settings.SettingsParser: Parse provided node.
parse(Predicate<String>, BiFunction<SettingsNode, String, Object>) - Method in interface com.saicone.settings.SettingsNode: Parse every text value inside this node with a string condition.
This means if this node is a list or map type will be iterated recursively to parse every string on child or element inside map or list with the provided function.
Take in count only the value from ValueType.getValue() will be used to check if the node is a string or not.
Parsers - Class in com.saicone.settings.parser: Utility class to collect node parsers.
paths() - Method in class com.saicone.settings.node.MapNode: Get a linked set with all the node key paths from map values.
PublicConstructor(LoaderOptions) - Constructor for class com.saicone.settings.source.YamlSettingsSource.PublicConstructor: Constructs a public constructor wrapped instance.
PublicYaml(YamlSettingsSource.PublicConstructor, Representer, DumperOptions, LoaderOptions) - Constructor for class com.saicone.settings.source.YamlSettingsSource.PublicYaml: Constructs a public yaml wrapped instance.
put(String, SettingsNode) - Method in class com.saicone.settings.node.MapNode
put(String, Object) - Method in class com.saicone.settings.node.MapNode: Puts any type of value into current map by wrap it into a settings node.
putAll(Map<? extends String, ? extends SettingsNode>) - Method in class com.saicone.settings.node.MapNode
putSource(String, Class<? extends SettingsSource>) - Static method in class com.saicone.settings.data.DataFormat: Register a settings source instance associated with data format.

R

read(Reader, T) - Method in interface com.saicone.settings.SettingsSource: Use the provided reader to add every node value into parent map node.
read(Reader, T) - Method in class com.saicone.settings.source.GsonSettingsSource
read(Reader, T) - Method in class com.saicone.settings.source.HoconSettingsSource
read(Reader, T) - Method in class com.saicone.settings.source.TomlSettingsSource
read(Reader, T) - Method in class com.saicone.settings.source.YamlSettingsSource
readComment(List<String>) - Method in interface com.saicone.settings.SettingsSource: Read the provided comment lines and convert into a user-friendly one.
readCommentLines(List<CommentLine>) - Method in class com.saicone.settings.source.YamlSettingsSource: Parse yaml comment lines as list of strings.
readConfig(T, Config) - Method in class com.saicone.settings.source.TomlSettingsSource: Read yaml config object values and save into provided parent map node.
readConfig(T, ConfigObject, ConfigObject) - Method in class com.saicone.settings.source.HoconSettingsSource: Read config object values and save into provided parent map node.
readList(ListNode, ConfigList, ConfigList) - Method in class com.saicone.settings.source.HoconSettingsSource: Read config list value and save into provided list node.
readMapNode(T, MappingNode) - Method in class com.saicone.settings.source.YamlSettingsSource: Read yaml mapping node values and save into provided parent map node.
readNode(MapNode, String, Node) - Method in class com.saicone.settings.source.YamlSettingsSource: Read yaml node as settings node with provided parameters.
readValue(MapNode, String, ConfigValue, ConfigValue) - Method in class com.saicone.settings.source.HoconSettingsSource: Read config value as settings node with provided parameters.
readValue(MapNode, String, Object) - Method in class com.saicone.settings.source.TomlSettingsSource: Read any value as settings node with provided parameters.
remove(int) - Method in class com.saicone.settings.node.ListNode
remove(SettingsNode) - Method in class com.saicone.settings.memory.MapMemory
remove(SettingsNode) - Method in class com.saicone.settings.node.MapNode: Executed method when any node is deleted by the value itself.
remove(SettingsNode) - Method in class com.saicone.settings.Settings
remove(SettingsNode) - Method in interface com.saicone.settings.SettingsMemory: Remove a node by value itself.
remove(String) - Method in class com.saicone.settings.memory.MapMemory
remove(String) - Method in interface com.saicone.settings.SettingsMemory: Remove a node by path id.
remove(Object) - Method in class com.saicone.settings.node.ListNode
remove(Object) - Method in class com.saicone.settings.node.MapNode
remove(Object) - Method in class com.saicone.settings.Settings
remove(Object, boolean) - Method in class com.saicone.settings.node.MapNode: Remove node by given key.
removeAll(Collection<?>) - Method in class com.saicone.settings.node.ListNode
removeIf(Predicate<SettingsNode>) - Method in class com.saicone.settings.node.MapNode: Remove node by given condition.
removeIf(Predicate<SettingsNode>, boolean) - Method in class com.saicone.settings.node.MapNode: Remove node by given condition.
replace(Object) - Static method in class com.saicone.settings.update.NodeUpdate: Create a node update that aims to replace a node value with the given value.
REPLACE - com.saicone.settings.update.UpdateAction: Replace node value from path.
replaceArgs(char[], Object...) - Static method in class com.saicone.settings.util.Strings: Replace every argument denoted by its index value ({0}, {1}, {2}...) inside provided characters.
replaceArgs(String, char[], Map<String, Object>) - Static method in class com.saicone.settings.util.Strings: Replace every argument denoted by its key value ({key}, {asd}, {name}...) inside provided characters.
replaceArgs(String, Map<String, Object>) - Static method in class com.saicone.settings.util.Strings: Replace every argument denoted by its key value ({key}, {asd}, {name}...) inside provided string.
replaceArgs(String, Object...) - Static method in class com.saicone.settings.util.Strings: Replace every argument denoted by its index value ({0}, {1}, {2}...) inside provided string.
replaceArgs(Map<String, Object>) - Method in interface com.saicone.settings.SettingsNode: Replace every argument denoted by its key value ({key}, {asd}, {name}...) inside every text value in this node.
This means if this node is a list or map type will be iterated recursively to replace indexed arguments from every string on child or element inside map or list with the provided function.
Take in count only the value from ValueType.getValue() will be used to check if the node is a string or not.
replaceArgs(Object...) - Method in interface com.saicone.settings.SettingsNode: Replace every argument denoted by its index value ({0}, {1}, {2}...) inside every text value in this node.
This means if this node is a list or map type will be iterated recursively to replace indexed arguments from every string on child or element inside map or list with the provided function.
Take in count only the value from ValueType.getValue() will be used to check if the node is a string or not.
retainAll(Collection<?>) - Method in class com.saicone.settings.node.ListNode

S

save() - Method in class com.saicone.settings.SettingsData: Save current loaded data.
save(String, SettingsNode) - Method in class com.saicone.settings.memory.MapMemory
save(String, SettingsNode) - Method in interface com.saicone.settings.SettingsMemory: Save a node with the given id.
save(String, Supplier<SettingsNode>) - Method in class com.saicone.settings.Settings: Save supplier value into memory or get from if it actually exists.
saveInto(SettingsData<?>) - Method in class com.saicone.settings.SettingsData: Save settings data into provider.
set(int, SettingsNode) - Method in class com.saicone.settings.node.ListNode
set(SettingsNode, String...) - Method in class com.saicone.settings.node.MapNode: Sets node into given key path inside root map and subsequent maps.
set(T, Object, String...) - Method in class com.saicone.settings.SettingsParser: Set a parsed value to path inside map node.
setFormat(TomlFormat) - Method in class com.saicone.settings.source.TomlSettingsSource: Replace the current toml format loader instance.
setKey(String) - Method in class com.saicone.settings.node.NodeKey
setKey(String) - Method in interface com.saicone.settings.SettingsNode: Replace the key associated with this node.
setMapMemory() - Method in class com.saicone.settings.Settings: Set a regular map memory on this instance.
setMemory(SettingsMemory) - Method in class com.saicone.settings.Settings: Replace the used settings memory on this instance.
setParent(MapNode) - Method in interface com.saicone.settings.SettingsNode: Replace the parent node that this node come from.
setParent(MapNode) - Method in class com.saicone.settings.node.NodeKey
setSideComment(List<String>) - Method in class com.saicone.settings.node.NodeValue
setSideComment(List<String>) - Method in interface com.saicone.settings.SettingsNode: Replace the node side comment.
setSourceValue(Object) - Method in class com.saicone.settings.node.NodeValue
setSourceValue(Object) - Method in interface com.saicone.settings.SettingsNode: Replace the actual source value.
Settings - Class in com.saicone.settings: Class that represent flexible configuration itself.
Settings() - Constructor for class com.saicone.settings.Settings: Constructs an empty settings object.
By default, key insertion order will be maintained.
Settings(Map<String, SettingsNode>) - Constructor for class com.saicone.settings.Settings: Constructs a settings object with the given map type.
Settings(Map<String, SettingsNode>, SettingsMemory) - Constructor for class com.saicone.settings.Settings: Constructs a settings with the given parameters.
Settings(SettingsMemory) - Constructor for class com.saicone.settings.Settings: Constructs an empty settings object with given memory.
By default, key insertion order will be maintained.
SettingsData<T extends SettingsNode> - Class in com.saicone.settings: Class to load any settings node from data.
SettingsData(DataType, String, Supplier<T>) - Constructor for class com.saicone.settings.SettingsData: Constructs a settings data instance with provided parameters.
SettingsLoader - Class in com.saicone.settings: Class to load settings data objects with any global transformations.
This is a useful way to apply a settings parser and updater together without generating unexpected results.
SettingsLoader() - Constructor for class com.saicone.settings.SettingsLoader: Constructs an empty settings loader without any transformation.
SettingsLoader(SettingsParser) - Constructor for class com.saicone.settings.SettingsLoader: Constructs a settings loader with provider parser.
SettingsLoader(SettingsUpdater) - Constructor for class com.saicone.settings.SettingsLoader: Constructs a settings loader with provided updater.
SettingsLoader(SettingsUpdater, SettingsParser) - Constructor for class com.saicone.settings.SettingsLoader: Constructs a settings loader with provided parameters.
SettingsMemory - Interface in com.saicone.settings: Interface that represents a memory to save settings node values.
SettingsNode - Interface in com.saicone.settings: Interface that represents the global settings memory object.
SettingsParser - Class in com.saicone.settings: Class to handle node parser operations.
SettingsParser() - Constructor for class com.saicone.settings.SettingsParser: Constructs an empty settings parser.
SettingsParser(List<NodeParser>, Map<String, ExpressionParser>) - Constructor for class com.saicone.settings.SettingsParser: Constructs a settings parser with the given parameters.
SettingsSource - Interface in com.saicone.settings: Interface that represent a object that can parse and write a map node using a reader or writer represented with a data source type, such as file formats.
SettingsUpdater - Class in com.saicone.settings.update: Class to handle node updates into provided map nodes.
SettingsUpdater() - Constructor for class com.saicone.settings.update.SettingsUpdater: Constructs an empty settings updater.
SettingsUpdater(List<NodeUpdate>) - Constructor for class com.saicone.settings.update.SettingsUpdater: Constructs a settings updater with provided node updates.
setTopComment(List<String>) - Method in class com.saicone.settings.node.NodeValue
setTopComment(List<String>) - Method in interface com.saicone.settings.SettingsNode: Replace the node top comment.
setValue(Object) - Method in class com.saicone.settings.node.ListNode
setValue(Object) - Method in class com.saicone.settings.node.MapNode
setValue(Object) - Method in class com.saicone.settings.node.NodeValue
setValue(Object) - Method in class com.saicone.settings.node.ObjectNode
setValue(Object) - Method in interface com.saicone.settings.SettingsNode: Set the value that will be return on ValueType.getValue() and change this node instance depending on actual value.
If source value is not set will be replaced.
setYaml(YamlSettingsSource.PublicYaml) - Method in class com.saicone.settings.source.YamlSettingsSource: Replace the current yaml instance with provided YamlSettingsSource.PublicYaml wrapped instance.
simple() - Static method in class com.saicone.settings.SettingsLoader: Get a simple settings loader with SettingsUpdater.simple() and SettingsParser.simple().
simple() - Static method in class com.saicone.settings.SettingsParser: Get a simple settings parser that only parse Expressions.NODE replacements.
simple() - Static method in class com.saicone.settings.update.SettingsUpdater: Get a simple settings updater that only puts any non-existent node from provider map into base map node.
size() - Method in class com.saicone.settings.node.ListNode
size() - Method in class com.saicone.settings.node.MapNode
SIZE - Static variable in class com.saicone.settings.parser.Expressions: Expression that return the current or given node size.
source(SettingsSource) - Method in class com.saicone.settings.SettingsData: Set the settings source that will be used to read or write any settings data.
split(String, char) - Static method in class com.saicone.settings.util.Strings: Splits provided string around of the given character, ignoring any literal char declaration such as \. (dot).
SPLIT - Static variable in class com.saicone.settings.parser.Expressions: Expression to split a node value from path.
Strings - Class in com.saicone.settings.util: Utility class to handle strings with a variety of methods.
subList(int, int) - Method in class com.saicone.settings.node.ListNode

T

to(String...) - Method in class com.saicone.settings.update.NodeUpdate: Set the node path where it will be set.
toArray() - Method in class com.saicone.settings.node.ListNode
toArray(T[]) - Method in class com.saicone.settings.node.ListNode
TomlSettingsSource - Class in com.saicone.settings.source: A settings source for toml-formatted data
This class uses electronwill nightconfig library to read and write any data.
TomlSettingsSource() - Constructor for class com.saicone.settings.source.TomlSettingsSource: Constructs a toml settings source with default options.
This means any comment will be parsed.
TomlSettingsSource(TomlFormat) - Constructor for class com.saicone.settings.source.TomlSettingsSource: Constructs a toml settings source with provided toml format loader.
toString() - Method in class com.saicone.settings.node.ListNode
toString() - Method in class com.saicone.settings.node.NodeValue

U

update(MapNode, MapNode) - Method in class com.saicone.settings.update.SettingsUpdater: Update the given base node along with optional provider map node.
UpdateAction - Enum in com.saicone.settings.update: Node update action types.
URL - com.saicone.settings.data.DataType: A regular url data type.

V

value(Object) - Method in class com.saicone.settings.update.NodeUpdate: Set the node value that will be set to updated node.
valueOf(String) - Static method in enum com.saicone.settings.data.DataType: Returns the enum constant of this type with the specified name.
valueOf(String) - Static method in enum com.saicone.settings.update.UpdateAction: Returns the enum constant of this type with the specified name.
values() - Static method in enum com.saicone.settings.data.DataType: Returns an array containing the constants of this enum type, in the order they are declared.
values() - Method in class com.saicone.settings.node.MapNode
values() - Static method in enum com.saicone.settings.update.UpdateAction: Returns an array containing the constants of this enum type, in the order they are declared.

W

write(Writer, MapNode) - Method in interface com.saicone.settings.SettingsSource: Write the provided map node into writer.
write(Writer, MapNode) - Method in class com.saicone.settings.source.GsonSettingsSource
write(Writer, MapNode) - Method in class com.saicone.settings.source.HoconSettingsSource
write(Writer, MapNode) - Method in class com.saicone.settings.source.TomlSettingsSource
write(Writer, MapNode) - Method in class com.saicone.settings.source.YamlSettingsSource
writeComment(List<String>) - Method in interface com.saicone.settings.SettingsSource: Read the provided user-friendly comment and convert into a writeable one.
writeCommentLines(List<String>, Node, CommentType) - Method in class com.saicone.settings.source.YamlSettingsSource: Write provided list of strings as comment lines into provided node with comment type.
writeConfig(Object) - Method in class com.saicone.settings.source.TomlSettingsSource: Write the provided object into config instance.
writeNode(Object) - Method in class com.saicone.settings.source.YamlSettingsSource: Write any object into yaml node object.
writeValue(Object) - Method in class com.saicone.settings.source.HoconSettingsSource: Write any object into config value.
writeValue(Object) - Method in class com.saicone.settings.source.TomlSettingsSource: Write any object into literal compatible object with nightconfig library.

Y

YamlSettingsSource - Class in com.saicone.settings.source: A settings source for yaml-formatted data
This class uses snakeyaml library to read and write any data.
YamlSettingsSource() - Constructor for class com.saicone.settings.source.YamlSettingsSource: Constructs a yaml settings source with default options.
This means any comment will be parsed and the data will be written using pretty flow.
YamlSettingsSource(YamlSettingsSource.PublicYaml) - Constructor for class com.saicone.settings.source.YamlSettingsSource: Constructs a yaml settings source with provided YamlSettingsSource.PublicYaml wrapped instance.
YamlSettingsSource.PublicConstructor - Class in com.saicone.settings.source: Constructor wrapped instance to read java objects from yaml nodes.
YamlSettingsSource.PublicYaml - Class in com.saicone.settings.source: Yaml wrapped instance with public method to get used constructor and representer instances.

A C D E F G H I J K L M N O P R S T U V W Y
All Classes All Packages