net.lenni0451.optconfig.migrate

Interface ConfigMigrator

All Known Implementing Classes:

MigratorChain

public interface ConfigMigrator

A migrator that can be used to migrate the config values to a new version.

Method Summary

Modifier and Type	Method and Description
default java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>>	getSection(java.util.Map<java.lang.String,java.lang.Object> values, java.lang.String... path) Get a section of the values map by the given path.
void	migrate(int currentVersion, java.util.Map<java.lang.String,java.lang.Object> loadedValues) Migrates the config values to the new version.

Method Detail

migrate

void migrate(int currentVersion,
             java.util.Map<java.lang.String,java.lang.Object> loadedValues)

Migrates the config values to the new version.
The target version is specified when registering the migrator.

Parameters:

currentVersion - The current version of the config

loadedValues - The loaded values of the config

See Also:

Migrator

getSection

default java.util.Optional<java.util.Map<java.lang.String,java.lang.Object>> getSection(java.util.Map<java.lang.String,java.lang.Object> values,
                                                                                        java.lang.String... path)

Get a section of the values map by the given path.

Parameters:

values - The values map

path - The path to the section

Returns:

The section or an empty optional if the section does not exist