Index
All Classes and Interfaces|All Packages
A
- apply(C, P) - Method in interface io.github.vitalforge.persistlib.util.control.ContainerDataCollector
-
Applies this function to the given arguments.
B
- BasePersist - Class in io.github.vitalforge.persistlib
-
Base class for persisting objects to and from YAML files.
- BasePersist() - Constructor for class io.github.vitalforge.persistlib.BasePersist
-
Creates a new instance of the BasePersist.
- build() - Method in class io.github.vitalforge.persistlib.dataconversion.PersistData.Builder
-
Builds the PersistData.
- Builder() - Constructor for class io.github.vitalforge.persistlib.dataconversion.PersistData.Builder
-
Creates a new builder.
C
- castToRequiredType(Object, Class<T>) - Static method in class io.github.vitalforge.persistlib.util.ClassUtils
-
Casts an object to the required type.
- ClassUtils - Class in io.github.vitalforge.persistlib.util
-
Utility class for operations on Class objects.
- Constructor - Annotation Interface in io.github.vitalforge.persistlib.persistannotations
-
This annotation is used to mark a constructor that should be used to create an object from the persisted data.
- ContainerDataCollector<C,
P, R> - Interface in io.github.vitalforge.persistlib.util.control -
Functional interface for collecting data from a container.
- convertTypes(Object[], Class<?>[]) - Static method in class io.github.vitalforge.persistlib.util.PersistUtils
-
Converts objects to the specified types.
- create(Map<String, Object>, Class<T>) - Method in class io.github.vitalforge.persistlib.BasePersist
-
Creates an object from persisted data.
- createDump(Object, boolean) - Method in class io.github.vitalforge.persistlib.BasePersist
-
Creates persisted data from an object.
D
- data(D) - Method in class io.github.vitalforge.persistlib.dataconversion.PersistData.Builder
-
Sets the data for the builder.
- DataType - Enum Class in io.github.vitalforge.persistlib.persistannotations
-
The type of data that is being persisted.
E
- extractArgs(Executable, Map<String, Object>) - Static method in class io.github.vitalforge.persistlib.util.PersistUtils
-
Extracts arguments from a map using a given executable.
- extractFromContainer(C, ContainerDataCollector<C, P, Object>, P...) - Static method in class io.github.vitalforge.persistlib.util.Reflection
-
Extracts data from a container using a data collector and a set of targets.
F
- FILE - Enum constant in enum class io.github.vitalforge.persistlib.persistannotations.DataType
-
Name of the file to persist the data to.
- FROM_FILE - Enum constant in enum class io.github.vitalforge.persistlib.dataconversion.PersistDataFlags
-
The data should be persisted to a file.
G
- getData() - Method in class io.github.vitalforge.persistlib.dataconversion.PersistData
-
Retrieves the data from the PersistData.
- getDeepValue(Map<String, Object>, String) - Static method in class io.github.vitalforge.persistlib.util.MapUtils
-
Retrieves a value from a nested map using a string path.
- getDeepValue(Map<K, Object>, K[]) - Static method in class io.github.vitalforge.persistlib.util.MapUtils
-
Retrieves a value from a nested map using an array of keys.
- getDefaultValue() - Method in enum class io.github.vitalforge.persistlib.dataconversion.PersistDataFlags
-
Retrieves the default value of the flag.
- getFlag(PersistDataFlags) - Method in class io.github.vitalforge.persistlib.dataconversion.PersistData
-
Retrieves a flag from the data.
- getFlag(PersistDataFlags, boolean) - Method in class io.github.vitalforge.persistlib.dataconversion.PersistData
-
Retrieves a flag from the data.
- getSelf() - Method in class io.github.vitalforge.persistlib.dataconversion.PersistData
-
Retrieves the self from the PersistData.
I
- INSTANCE - Enum constant in enum class io.github.vitalforge.persistlib.persistannotations.DataType
-
The instance who has been created and persisted.
- io.github.vitalforge.persistlib - package io.github.vitalforge.persistlib
- io.github.vitalforge.persistlib.dataconversion - package io.github.vitalforge.persistlib.dataconversion
- io.github.vitalforge.persistlib.persistannotations - package io.github.vitalforge.persistlib.persistannotations
- io.github.vitalforge.persistlib.util - package io.github.vitalforge.persistlib.util
- io.github.vitalforge.persistlib.util.control - package io.github.vitalforge.persistlib.util.control
- isArgsValid(Executable, Object[]) - Static method in class io.github.vitalforge.persistlib.util.ClassUtils
-
Checks if the arguments are valid for a constructor.
- isCompatible(Class<?>, Class<?>) - Static method in class io.github.vitalforge.persistlib.util.ClassUtils
-
Checks if a parameter type is compatible with an argument type.
- isPrimitiveOrWrapper(Class<?>) - Static method in class io.github.vitalforge.persistlib.util.ClassUtils
-
Checks if a class represents a primitive type or its corresponding wrapper type.
L
- loadFromYaml(String, Class<T>) - Method in class io.github.vitalforge.persistlib.BasePersist
-
Loads an object from a YAML file.
M
- MapUtils - Class in io.github.vitalforge.persistlib.util
-
Utility class for operations on Maps.
P
- Parameter - Annotation Interface in io.github.vitalforge.persistlib.persistannotations
-
This annotation is used to mark a parameter that should be provided by the persisted data.
- PATH - Enum constant in enum class io.github.vitalforge.persistlib.persistannotations.DataType
-
Absolute path to the file to persist the data to.
- PersistData<T,
D> - Class in io.github.vitalforge.persistlib.dataconversion -
Represents data that can be persisted.
- PersistData(T, D) - Constructor for class io.github.vitalforge.persistlib.dataconversion.PersistData
-
Creates a new instance of the PersistData.
- PersistData.Builder<T,
D> - Class in io.github.vitalforge.persistlib.dataconversion -
Creates a new builder.
- PersistDataFlags - Enum Class in io.github.vitalforge.persistlib.dataconversion
-
Flags that can be used to control how data is persisted.
- PersistField - Annotation Interface in io.github.vitalforge.persistlib.persistannotations
-
This annotation is used to mark a field that should be persisted.
- PersistUtils - Class in io.github.vitalforge.persistlib.util
-
Utility class for operations on persisted data.
- ProvideResult - Annotation Interface in io.github.vitalforge.persistlib.persistannotations
-
This annotation is used to mark a method that returns a result that should be persisted.
- putDeepValue(Map<String, Object>, Object, String) - Static method in class io.github.vitalforge.persistlib.util.MapUtils
-
Inserts a value into a map at a specified string path, creating nested maps as necessary.
- putDeepValue(Map<K, Object>, Object, K[]) - Static method in class io.github.vitalforge.persistlib.util.MapUtils
-
Inserts a value into a map at a specified path, creating nested maps as necessary.
R
- Reflection - Class in io.github.vitalforge.persistlib.util
-
Utility class for reflection operations.
- required() - Element in annotation interface io.github.vitalforge.persistlib.persistannotations.Parameter
-
Whether the parameter is required to be present in the persisted data.
- RequirePersisted - Annotation Interface in io.github.vitalforge.persistlib.persistannotations
-
This annotation is used to mark a method that requires the persisted data to be present before it is called and be provided as arguments.
S
- saveToYaml(Object, String) - Method in class io.github.vitalforge.persistlib.BasePersist
-
Saves an object to a YAML file.
- saveToYaml(Object, String, boolean) - Method in class io.github.vitalforge.persistlib.BasePersist
-
Saves an object to a YAML file.
- self(T) - Method in class io.github.vitalforge.persistlib.dataconversion.PersistData.Builder
-
Sets the self for the builder.
- SELF - Enum constant in enum class io.github.vitalforge.persistlib.persistannotations.DataType
-
The data who have been loaded as Map.
- setFlag(PersistDataFlags, boolean) - Method in class io.github.vitalforge.persistlib.dataconversion.PersistData
-
Sets a flag on the data.
U
- update(T, PersistData<T, Map<String, Object>>) - Method in class io.github.vitalforge.persistlib.BasePersist
-
Updates an object with persisted data.
V
- value() - Element in annotation interface io.github.vitalforge.persistlib.persistannotations.Parameter
-
The key to use for the parameter in the persisted data.
- value() - Element in annotation interface io.github.vitalforge.persistlib.persistannotations.PersistField
-
The key to use for the stored field if the value is not set, the field name will be used as the key.
- value() - Element in annotation interface io.github.vitalforge.persistlib.persistannotations.ProvideResult
-
The key to use for the stored result if the value is not set, the method name will be used as the key.
- valueOf(String) - Static method in enum class io.github.vitalforge.persistlib.dataconversion.PersistDataFlags
-
Returns the enum constant of this class with the specified name.
- valueOf(String) - Static method in enum class io.github.vitalforge.persistlib.persistannotations.DataType
-
Returns the enum constant of this class with the specified name.
- values() - Static method in enum class io.github.vitalforge.persistlib.dataconversion.PersistDataFlags
-
Returns an array containing the constants of this enum class, in the order they are declared.
- values() - Static method in enum class io.github.vitalforge.persistlib.persistannotations.DataType
-
Returns an array containing the constants of this enum class, in the order they are declared.
All Classes and Interfaces|All Packages