net.lenni0451.optconfig

Class ConfigLoader<C>

java.lang.Object

net.lenni0451.optconfig.ConfigLoader<C>

Type Parameters:

C - The type of the config instance

public class ConfigLoader<C>
extends java.lang.Object

The config loader providing methods to load instanced and static configs.
A new config loader should be created for each config class.

Constructor Summary

Constructors

Constructor and Description
ConfigLoader(java.lang.Class<C> configClass)
ConfigLoader(java.lang.Class<C> configClass, java.util.function.Consumer<org.yaml.snakeyaml.LoaderOptions> loaderOptionsConsumer, java.util.function.Consumer<org.yaml.snakeyaml.DumperOptions> dumperOptionsConsumer)

Method Summary

Modifier and Type	Method and Description
ConfigOptions	getConfigOptions()
TypeSerializerList<C>	getTypeSerializers()
ConfigContext<C>	load(C config, ConfigProvider configProvider) Load a static config from the given path.
ConfigContext<C>	load(ConfigProvider configProvider) Load an instanced config from the given path.
ConfigContext<C>	loadStatic(ConfigProvider configProvider) Load a static config from the given path.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

ConfigLoader

public ConfigLoader(java.lang.Class<C> configClass)

ConfigLoader

public ConfigLoader(java.lang.Class<C> configClass,
                    java.util.function.Consumer<org.yaml.snakeyaml.LoaderOptions> loaderOptionsConsumer,
                    java.util.function.Consumer<org.yaml.snakeyaml.DumperOptions> dumperOptionsConsumer)

Method Detail

getConfigOptions

public ConfigOptions getConfigOptions()

Returns:

The config options

getTypeSerializers

public TypeSerializerList<C> getTypeSerializers()

Returns:

The list of type serializers

load

public ConfigContext<C> load(ConfigProvider configProvider)
                      throws java.io.IOException

Load an instanced config from the given path.
A new instance of the config class will be created and returned.
The config class must have an empty constructor.

Parameters:

configProvider - The config provider for loading and saving the config

Returns:

The config context

Throws:

java.io.IOException - If an I/O error occurs

load

public ConfigContext<C> load(C config,
                             ConfigProvider configProvider)
                      throws java.io.IOException

Load a static config from the given path.
The given instance will be used to store the values of the config.

Parameters:

config - The instance to store the values

configProvider - The config provider for loading and saving the config

Returns:

The config context

Throws:

java.io.IOException - If an I/O error occurs

loadStatic

public ConfigContext<C> loadStatic(ConfigProvider configProvider)
                            throws java.io.IOException

Load a static config from the given path.

Parameters:

configProvider - The config provider for loading and saving the config

Returns:

The config context

Throws:

java.io.IOException - If an I/O error occurs