Index (config 1.0.0-beta.3 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: While the Config API is equipped with an automatic deserializer (see ObjectSerializer.serialize(Object, boolean)) It is not perfect, and may produce ugly looking results.
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: Add a display condition to this 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
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.
Backend() - Constructor for class org.polyfrost.oneconfig.api.config.v1.backend.Backend
Backend.RegistrationResult - Class in org.polyfrost.oneconfig.api.config.v1.backend

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.
clearCallbacks() - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Remove all callbacks.
clearDisplayConditions() - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Remove all display conditions from this 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.
corrupt0(Tree) - Method 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's contents equals another tree's.
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 will check Property.equals(Object) and the value of this property with the given obj.
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.
deserialize(Output) - Method in class org.polyfrost.oneconfig.api.config.v1.serialize.adapter.Adapter: Deserialize your object.
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

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 the value of this 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.
getChild(String) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
getChild(String...) - Method in class org.polyfrost.oneconfig.api.config.v1.Tree
getID() - Method in class org.polyfrost.oneconfig.api.config.v1.Node: The ID of this 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 it is isn't 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.
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.
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
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.
LOADED - Static variable in class org.polyfrost.oneconfig.api.config.v1.backend.Backend.RegistrationResult: This tree has been seen before by the backend, and 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.
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.
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.
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.
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
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, 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.
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.
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 vice versa.
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.
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.
setAsReferential(V) - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Set the value of this property.
setID(String) - Method in class org.polyfrost.oneconfig.api.config.v1.Node: Set the ID of this node.
setReferential(T) - Method in class org.polyfrost.oneconfig.api.config.v1.Property: Set the value of this property.
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.
Tree - Class in org.polyfrost.oneconfig.api.config.v1: The Tree class represents a tree structure that contains properties and other trees as children.
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.

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 (e.g.
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.

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