Index (config 1.1.15 API)

A B C D E F G H I K L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form

A

Adapter<Type,Output> - Class in org.polyfrost.oneconfig.api.config.v1.serialize.adapter: The Config API is equipped with an automatic deserializer (see ObjectSerializer.serialize(Object, boolean))
It is not perfect and may produce ugly looking results
For this reason the Adapter API exists where you can create your own custom serializer for an object into a map of "simple" objects and string keys
Adapter() - Constructor for class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.Adapter
addCallback(Collection<Predicate<T>>) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
addCallback(Predicate<T>) - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Add a callback to this property which is called when the value changes
addCallback(Predicate<T>...) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
addDisplayCondition(Collection<Supplier<Property.Display>>) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
addDisplayCondition(Supplier<Property.Display>) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
addDisplayCondition(Supplier<Property.Display>...) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
addDisplayCondition(Property<Boolean>, boolean) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
addDisplayListener(Consumer<Property.Display>) - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Add a listener which is called whenever the display state of this property changes
Unlike Property.onDisplayChange(Consumer) any amount of listeners can be registered at once
Remember to remove the listener when it is no longer needed
addMetadata(String, Object) - Method in class org.polyfrost.oneconfig.api.config.v1.Node
addMetadata(Map<String, Object>) - Method in class org.polyfrost.oneconfig.api.config.v1.Node

B

Backend - Class in org.polyfrost.oneconfig.api.config.v1.backend: A backend is a storage system for ConfigTrees
It handles getting and putting ConfigTrees and also serializing and deserializing them
Backend() - Constructor for class org.polyfrost.oneconfig.api.config.v1.backend.Backend
Backend.RegistrationResult - Class in org.polyfrost.oneconfig.api.config.v1.backend
beginFailureCollection() - Static method in class org.polyfrost.oneconfig.api.config.v1.Tree

C

callbacks - Variable in class org.polyfrost.oneconfig.api.config.v1.Property
canDisplay() - Method in class org.polyfrost.oneconfig.api.config.v1.Property: This is used by the frontend to know if this property is able to be displayed which is controlled by Property.conditions
clear() - Method in class org.polyfrost.oneconfig.api.config.v1.Tree: Clear this tree of all its members
This function is used internally to discard trees to prevent illegal usage of 'dead' trees
clearCallbacks() - Method in class org.polyfrost.oneconfig.api.config.v1.Property
clearDisplayConditions() - Method in class org.polyfrost.oneconfig.api.config.v1.Property
clearMetadata() - Method in class org.polyfrost.oneconfig.api.config.v1.Node
collect(Object) - Method in interface org.polyfrost.oneconfig.api.config.v1.collect.PropertyCollector: Attempt to collect the properties of the given object
ColorAdapter - Class in org.polyfrost.oneconfig.api.config.v1.serialize.adapter.impl: The only bundled adapter in the config system which makes colors a lot more readable when serialized
ColorAdapter() - Constructor for class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.impl.ColorAdapter
ComplexAdapter<Type> - Class in org.polyfrost.oneconfig.api.config.v1.serialize.adapter
ComplexAdapter() - Constructor for class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.ComplexAdapter
consumeMetadata(String) - Method in class org.polyfrost.oneconfig.api.config.v1.Node: Consume some metadata attached to this node meaning it will be removed
contentToString() - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
corrupt(String) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Explicitly mark a tree as corrupted
The given tree if present will be untracked by this backend
this method is also automatically called when a tree fails to load (implementation specific operation)
corrupt0(Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend
CUSTOM_SAVE_DIRTY_METADATA - Static variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend
CUSTOM_SAVE_TRACKED_METADATA - Static variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend

D

deepEquals(Object) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree: Check if the tree contents equal another tree
This checks the values and children of the tree
deepEquals(Object) - Method in class org.polyfrost.oneconfig.api.config.v1.Node
deepEquals(Object) - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Deep equals for a property meaning it checks Property.equals(Object) and the value of this property against the given obj
In pretty much every case you should use Property.equals(Object) instead
This is used for testing
Note that primitive arrays are not checked
delete(String) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Untrack and permanently delete the tree with the given ID
delete0(Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend
description - Variable in class org.polyfrost.oneconfig.api.config.v1.Node
deserialize(int[]) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.impl.ColorAdapter
deserialize(Map<String, Object>) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer: Deserialize the given complex object map
The map must contain the class field
deserialize(Output) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.Adapter: Deserialize your object
The form will be identical to what you made in the Adapter.serialize(Object) method
deserialize(T) - Method in interface org.polyfrost.oneconfig.api.config.v1.serialize.Serializer: Return a new tree with the data in it
DISABLED - Enum constant in enum class org.polyfrost.oneconfig.api.config.v1.Property.Display

E

endFailureCollection() - Static method in class org.polyfrost.oneconfig.api.config.v1.Tree
equals(Object) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
equals(Object) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.Adapter
equals(Object) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
evaluatePath(Tree, Node) - Static method in class org.polyfrost.oneconfig.api.config.v1.Tree: Figure out what the path from the given root to the given node is
exists(String) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend

F

FIELD_SKIP_MODIFIERS - Static variable in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer: Modifier.SYNTHETIC | Modifier.TRANSIENT | Modifier.STATIC
fieldStream(Class<?>) - Static method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer

G

get() - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend.RegistrationResult
get() - Method in class org.polyfrost.oneconfig.api.config.v1.Property
get() - Method in class org.polyfrost.oneconfig.api.config.v1.Property.KtProperty: Deprecated.
get(Iterable<String>) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
get(String...) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
get(String) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend
get(String) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
getAdapter(Class<T>) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer
getAllFields(Class<?>) - Static method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer
getAs() - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Get the value of this property cast to the specified type
This method is unsafe and will throw a ClassCastException if the value is not of the correct type
getChild(String) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
getChild(String...) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
getDisplay() - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Return the current display state of this property which is controlled by Property.conditions
getID() - Method in class org.polyfrost.oneconfig.api.config.v1.Node
getMetadata() - Method in class org.polyfrost.oneconfig.api.config.v1.Node
getMetadata(String) - Method in class org.polyfrost.oneconfig.api.config.v1.Node: Return some metadata attached to this node
getOrPutChild(String) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
getOrPutMetadata(String, Supplier<M>) - Method in class org.polyfrost.oneconfig.api.config.v1.Node: Return some metadata attached to this node or put def if it is not present
getOutputClass() - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.Adapter: Due to Java type erasure this method is used to get the type of the adapter
This is used internally to get what type adapter to use
getOutputClass() - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.ComplexAdapter
getOutputClass() - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.impl.ColorAdapter
getProp(String) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
getProp(String...) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
getTargetClass() - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.Adapter: Due to Java type erasure this method is used to get the type of the adapter
This is used internally to get what type adapter to use
getTargetClass() - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.impl.ColorAdapter
getTitle() - Method in class org.polyfrost.oneconfig.api.config.v1.Node
getTrees() - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend

H

hashCode() - Method in class org.polyfrost.oneconfig.api.config.v1.Node
hashCode() - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.Adapter
hasMetadata() - Method in class org.polyfrost.oneconfig.api.config.v1.Node
HIDDEN - Enum constant in enum class org.polyfrost.oneconfig.api.config.v1.Property.Display

I

INSTANCE - Static variable in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer
isArray() - Method in class org.polyfrost.oneconfig.api.config.v1.Property
isImmutable(Class<?>) - Static method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer: true if no instance field of this class can be assigned meaning the class is a value type
Such objects can only be replaced and never mutated in place
isPrimitive() - Method in class org.polyfrost.oneconfig.api.config.v1.Property
isSerializable(Object) - Static method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer

K

KtProperty(String, String, KMutableProperty0<T>, Class<T>) - Constructor for class org.polyfrost.oneconfig.api.config.v1.Property.KtProperty: Deprecated.

L

load(String) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Load a tree with the given ID
load(Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Load the tree with data stored in this backend
load0(String) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Load in a tree with the given ID
Returns null if the tree does not exist
LOADED - Static variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend.RegistrationResult: This tree has been seen before by the backend so data has been loaded into it from the backend storage
LOGGER - Static variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend
LOGGER - Static variable in class org.polyfrost.oneconfig.api.config.v1.Node

M

map - Variable in class org.polyfrost.oneconfig.api.config.v1.Tree
MERGED - Static variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend.RegistrationResult: This tree was already registered to the active system and has been merged with the input tree

N

NEW - Static variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend.RegistrationResult: This tree has never been registered before or could not be found in the backend storage
Node - Class in org.polyfrost.oneconfig.api.config.v1
Node(String, Object, Object) - Constructor for class org.polyfrost.oneconfig.api.config.v1.Node

O

ObjectSerializer - Class in org.polyfrost.oneconfig.api.config.v1.serialize
onAll(BiConsumer<String, Node>) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
onAllProps(BiConsumer<String, Property<?>>) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
onDisplayChange(Consumer<Property.Display>) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
org.polyfrost.oneconfig.api.config.v1 - package org.polyfrost.oneconfig.api.config.v1
org.polyfrost.oneconfig.api.config.v1.backend - package org.polyfrost.oneconfig.api.config.v1.backend
org.polyfrost.oneconfig.api.config.v1.collect - package org.polyfrost.oneconfig.api.config.v1.collect
org.polyfrost.oneconfig.api.config.v1.exceptions - package org.polyfrost.oneconfig.api.config.v1.exceptions
org.polyfrost.oneconfig.api.config.v1.serialize - package org.polyfrost.oneconfig.api.config.v1.serialize
org.polyfrost.oneconfig.api.config.v1.serialize.adapter - package org.polyfrost.oneconfig.api.config.v1.serialize.adapter
org.polyfrost.oneconfig.api.config.v1.serialize.adapter.impl - package org.polyfrost.oneconfig.api.config.v1.serialize.adapter.impl
overwrite(Node, boolean, boolean, Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
overwrite(Node, boolean) - Method in class org.polyfrost.oneconfig.api.config.v1.Node
overwrite(Node, boolean, boolean, Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.Node: Overwrite all data in this node with the data from another node
For a node all metadata will be copied from the input onto this and any duplicate keys will be overwritten For a Property the value and callbacks and display conditions are copied onto this For a Tree all children and properties will be overwritten if they are present and this operation is recursive
overwrite(Node, boolean, boolean, Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
overwrite(Tree, Function<String, String>, boolean, boolean, Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree: Overwrite this tree with the supplied tree using the keyMapper to map between key names from old to new if needed
overwrite(T, T) - Static method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer

P

Property<T> - Class in org.polyfrost.oneconfig.api.config.v1: Class which represents a property in a tree
to actually create a property see the Properties class
Property(String, Object, Object, Class<T>) - Constructor for class org.polyfrost.oneconfig.api.config.v1.Property
Property.Display - Enum Class in org.polyfrost.oneconfig.api.config.v1
Property.KtProperty<T> - Class in org.polyfrost.oneconfig.api.config.v1: Deprecated.
PropertyCollector - Interface in org.polyfrost.oneconfig.api.config.v1.collect: This functional interface represents a 'translator' which will take an object and return a Tree representing the serializable representation of the object
Changes to the tree should be reflected in the object and changes to the object in the tree
put(Node...) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
put(Node) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
putSafe(Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend

R

recast(Property<?>) - Static method in class org.polyfrost.oneconfig.api.config.v1.Property
register(Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Register the given config with the system
This is a hybrid of the load and save methods depending on the state of the given tree
New trees will be saved to the backend
Existing trees will be loaded and have the backend data overwritten onto them
NOTE do NOT use the parameter tree after this method is called because it may have been cleared
Use the returned tree instead
registerTypeAdapter(Adapter<?, ?>) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer
registerTypeAdapter(Adapter<?, ?>...) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer
RegistrationResult(Tree, byte) - Constructor for class org.polyfrost.oneconfig.api.config.v1.backend.Backend.RegistrationResult
removeCallback(Predicate<T>) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
removeDisplayListener(Consumer<Property.Display>) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
removeMetadata(String) - Method in class org.polyfrost.oneconfig.api.config.v1.Node
requestUpdate(String) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Request that the tree with the given ID needs to be updated for example when the file has been edited externally
revaluateDisplay() - Method in class org.polyfrost.oneconfig.api.config.v1.Property

S

save(String) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Save a tree with the given ID
save(Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Save the provided tree to the backend
If it is not registered when this is called it will be registered
save0(Tree) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend
saveAll() - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Save all trees registered to this backend
saveAll(String) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Save all trees under the given path
SerializationException - Exception Class in org.polyfrost.oneconfig.api.config.v1.exceptions
SerializationException(String) - Constructor for exception class org.polyfrost.oneconfig.api.config.v1.exceptions.SerializationException
SerializationException(String, Throwable) - Constructor for exception class org.polyfrost.oneconfig.api.config.v1.exceptions.SerializationException
serialize(Color) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.impl.ColorAdapter
serialize(Object) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer
serialize(Object, boolean) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer
serialize(Object, boolean, boolean) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.ObjectSerializer: Convert the given object into a series of simple values that should be supported by most backend serializers
serialize(Tree) - Method in interface org.polyfrost.oneconfig.api.config.v1.serialize.Serializer: Serialize the given tree into type T
serialize(Type) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.Adapter: Convert the given object into a serializable form
The following types can be returned by this method and nothing more Primitive wrappers (any Number or Character or Boolean) A String literal or any class implementing CharSequence An Enum An array of the above types including primitives such as byte[] and int[] A List of the above types A Map<String, Object> of the above types mapped to Strings which are used as keys
Note that 'class' and 'value' are reserved keys and cannot be used Lists containing lists or maps containing maps (or lists) are also supported
Serializer<T> - Interface in org.polyfrost.oneconfig.api.config.v1.serialize: A serializer is a class that is capable of turning a Tree into a specific type Serializer and back again
Trees are the primary data structure in OneConfig and are used to represent configuration data
Each node is a key-value pair of either a string and a sub-tree or a string and some data
Trees can contain arbitrary potentially complex data types in them so you need to be able to serialize and deserialize this data into a specific type
The easiest way to do this is to use the builtin ObjectSerializer which provides simple methods to convert objects into simple types along with the facility to use defined Adapters
The following types are used by this and so you need to be able to serialize and deserialize them primitive type wrappers (Number and Character and Boolean) CharSequence Lists or Arrays of the above types (at your discretion) Map containing the above types If you do not want to use this facility you can create your own complex object serializer and use that instead
set(String, Node) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
set(T) - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Set the value of this property and call all callbacks
The value is only set and the callbacks only called if the value differs from the previous value using Object.equals(Object)
set0(T) - Method in class org.polyfrost.oneconfig.api.config.v1.Property.KtProperty: Deprecated.
set0(T) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
setAs(V) - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Set the value of this property and call all callbacks
This method is unsafe and will throw a ClassCastException if the value is not of the correct type
setAsReferential(V) - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Set the value of this property and call all callbacks
Unlike Property.setAs(Object) this will always set the value even if it is the same as the previous value
Use this method with caution
setAsSilently(V) - Method in class org.polyfrost.oneconfig.api.config.v1.Property
setID(String) - Method in class org.polyfrost.oneconfig.api.config.v1.Node: Set the ID of this node
The ID is used solely by the backend to identify it and may only contain alphanumeric characters and underscores
note that this operation is permanent and cannot be undone or changed
setReferential(T) - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Set the value of this property and call all callbacks
Unlike Property.set(Object) this will always set the value even if it is the same as the previous value
Use this method with caution
setTitle(Object) - Method in class org.polyfrost.oneconfig.api.config.v1.Node
SHOWN - Enum constant in enum class org.polyfrost.oneconfig.api.config.v1.Property.Display
state - Variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend.RegistrationResult
strv(Object) - Static method in class org.polyfrost.oneconfig.api.config.v1.Node: validate and trim the given string returning null if it is empty

T

toString() - Method in class org.polyfrost.oneconfig.api.config.v1.Property
toString() - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
tree - Variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend.RegistrationResult
tree() - Static method in class org.polyfrost.oneconfig.api.config.v1.Tree
tree(String) - Static method in class org.polyfrost.oneconfig.api.config.v1.Tree
tree(Tree) - Static method in class org.polyfrost.oneconfig.api.config.v1.Tree: Create a new builder from the given tree
This will copy all the data from the tree into the builder
Tree - Class in org.polyfrost.oneconfig.api.config.v1: The Tree class represents a tree structure that contains properties and other trees as children
It provides methods to access and modify and compare the tree and its elements
Tree(String, Object, Object, Map<String, Node>) - Constructor for class org.polyfrost.oneconfig.api.config.v1.Tree
type - Variable in class org.polyfrost.oneconfig.api.config.v1.Property: This is the type of the property and is used for casting
Note that this is not Class<T> because it holds the unwrapped type of the stored value

U

UI_ONLY_METADATA - Static variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Trees marked with this metadata are listed in the UI only such as Mod Menu compat entries
They are tracked in memory but never loaded from or written to backend storage
UI_PLACEHOLDER_METADATA - Static variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend
unpack() - Method in class org.polyfrost.oneconfig.api.config.v1.Tree: Unpack this tree into a map of objects containing either more Maps or the values of the properties of this tree
unregister(String) - Method in class org.polyfrost.oneconfig.api.config.v1.backend.Backend: Stops tracking a tree without deleting its stored data.

V

valueOf(String) - Static method in enum class org.polyfrost.oneconfig.api.config.v1.Property.Display: Returns the enum constant of this class with the specified name.
values() - Static method in enum class org.polyfrost.oneconfig.api.config.v1.Property.Display: Returns an array containing the constants of this enum class, in the order they are declared.

A B C D E F G H I K L M N O P R S T U V
All Classes and Interfaces|All Packages|Constant Field Values|Serialized Form