Staff Mod/opekope2.avm_staff.api.config/ConfigurationLoader

ConfigurationLoader

public final class ConfigurationLoader<T extends Object>(source)

Configuration loader for a configuration file using codec.

Parameters

configurationFile

The configuration file path

codec

The codec used to serialize and deserialize the configuration

See also

ConfigurationLoader.Companion.configurationRoot

Constructors

ConfigurationLoader

public ConfigurationLoader<T> ConfigurationLoader<T extends Any>(String subDirectory, String fileName, Codec<T> codec)

Configuration loader for a configuration file using codec.

public ConfigurationLoader<T> ConfigurationLoader<T extends Any>(Path configurationFile, Codec<T> codec)

Types

public class Companion

Properties

private final Codec<T> codec

public final static ConfigurationLoader.Companion Companion

configurationFile

private final Path configurationFile

Functions

public final Codec<T> getCodec()

getConfigurationFile

public final Path getConfigurationFile()

loadConfiguration

public final T loadConfiguration()

Reads the configuration from configurationFile. This doesn't handle IO errors (like inaccessible file), malformed JSON, or decoding failures.

loadOrSaveConfiguration

public final T loadOrSaveConfiguration(Function0<T> defaultSupplier)

Reads the configuration from configurationFile if it exists. If it doesn't exist, it returns the supplied default configuration, and writes it to configurationFile. This doesn't handle IO errors (like inaccessible file), malformed JSON, or encoding and decoding failures.

saveConfiguration

public final Unit saveConfiguration(T configuration)

Writes the given configuration to configurationFile. This doesn't handle IO errors (like inaccessible file), or encoding failures.