net.lenni0451.optconfig.migrate

Class MigratorChain

java.lang.Object

net.lenni0451.optconfig.migrate.MigratorChain

All Implemented Interfaces:

ConfigMigrator

@ApiStatus.Internal
public class MigratorChain
extends java.lang.Object
implements ConfigMigrator

A list of migrators that are executed in the order they are added.
Used when a direct migrator is not available.
If the target version has no migrator, the default migrator is appended to the end of the list. The default migrator adds missing values and removes deprecated values (if enabled in the ConfigOptions).

Constructor Summary

Constructors

Constructor and Description
MigratorChain(java.util.List<ConfigIndex.Migrator> migrators)

Method Summary

Modifier and Type	Method and Description
void	migrate(int currentVersion, java.util.Map<java.lang.String,java.lang.Object> loadedValues) Migrates the config values to the new version.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lenni0451.optconfig.migrate.ConfigMigrator

getSection

Constructor Detail

MigratorChain

public MigratorChain(java.util.List<ConfigIndex.Migrator> migrators)

Method Detail

migrate

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

Description copied from interface: ConfigMigrator

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

Specified by:

migrate in interface ConfigMigrator

Parameters:

currentVersion - The current version of the config

loadedValues - The loaded values of the config

See Also:

Migrator