Index (Annotaml 1.0.3 API)

A

Annotaml<T> - Class in net.william278.annotaml: Annotaml is a library for generating YAML files from Java classes.
Annotaml(T, File) - Constructor for class net.william278.annotaml.Annotaml: Create a new Annotaml instance.
Annotaml.LoaderOptions - Class in net.william278.annotaml: Provides options for serializing and deserializing YamlFile annotated objects.
AnnotamlException - Exception in net.william278.annotaml: Indicates an exception occurred loading or saving a YAML file.
AnnotamlException(String) - Constructor for exception net.william278.annotaml.AnnotamlException

builder() - Static method in class net.william278.annotaml.Annotaml.LoaderOptions: Creates a new LoaderOptions object with the specified settings.

convertToSnakeCase() - Method in annotation type net.william278.annotaml.YamlFile: Whether to convert fields to snake_case
convertToSnakeCase(String) - Static method in class net.william278.annotaml.Annotaml: Converts a string to snake_case
copyDefaults(boolean) - Method in class net.william278.annotaml.Annotaml.LoaderOptions: Sets whether to copy default values from the class to the object

EmbeddedCollection - Annotation Type in net.william278.annotaml: Indicates a key contains embedded Map or List values.
EmbeddedYaml - Annotation Type in net.william278.annotaml: Identifies a type that can be serialized into an object within a YAML file

getVersionNumber(File, Class<T>) - Static method in class net.william278.annotaml.Annotaml: Get the version number of the YAML file.
getVersionNumber(InputStream, Class<T>) - Static method in class net.william278.annotaml.Annotaml: Get the version number of the YAML file.

header() - Method in annotation type net.william278.annotaml.YamlFile: Header to include at the top of the generated file

IgnoredKey - Annotation Type in net.william278.annotaml: Identifies a field to skip during serialization.
isCopyDefaults() - Method in class net.william278.annotaml.Annotaml.LoaderOptions: Gets whether to copy default values from the class to the object

KeyPath - Annotation Type in net.william278.annotaml: Identifies a custom path in the YAML file that should be used for saving a field.

load(File, Class<T>) - Static method in class net.william278.annotaml.Annotaml: Loads a YAML file into an object.
load(InputStream, Class<T>) - Static method in class net.william278.annotaml.Annotaml: Loads a YAML file into an object.

reload(File, InputStream, Class<T>, Annotaml.LoaderOptions) - Static method in class net.william278.annotaml.Annotaml: Reloads a YAML file from a File into a Annotaml typed object, doing a few things: Loads the defaults from the provided resource InputStream Checks if the file exists; if not, writes the file and returns the defaults If the file exists, copy and write defaults over if copyDefaults is true Read the file from disk, parse the YAML into the object and return it
reload(File, T, Annotaml.LoaderOptions) - Static method in class net.william278.annotaml.Annotaml: Reloads a YAML file from a File into a Annotaml typed object, doing a few things: Checks if the file exists; if not, writes the file and returns the defaults If the file exists, copy and write defaults over if copyDefaults is true Read the file from disk, parse the YAML into the object and return it
RootedMap - Annotation Type in net.william278.annotaml: Special annotation for identifying rooted maps; key-value pairs to be saved/read from the yaml file root

save(T, File) - Static method in class net.william278.annotaml.Annotaml: Write a YamlFile annotated object to a YAML file.

value() - Method in annotation type net.william278.annotaml.EmbeddedCollection: The type of the list.
value() - Method in annotation type net.william278.annotaml.KeyPath
versionField() - Method in annotation type net.william278.annotaml.YamlFile: The field to use as a key for the version of the file
versionNumber() - Method in annotation type net.william278.annotaml.YamlFile: The current version number of the file.

writeYaml() - Method in class net.william278.annotaml.Annotaml: Serializes and writes YamlFile annotated object to a YAML file.

YamlFile - Annotation Type in net.william278.annotaml: Identifies a file that can be saved and loaded from a YAML file.