ch.jalu.configme.migration.version

Interface VersionMigration

public interface VersionMigration

A migration used by VersionMigrationService to migrate from one configuration version to a newer one.

See Also:

VersionMigrationService

Method Summary

Modifier and Type	Method and Description
int	fromVersion()
void	migrate(@NotNull PropertyReader reader, @NotNull ConfigurationData configurationData) Migrates the configuration.
int	targetVersion()

Method Detail

fromVersion

int fromVersion()

Returns:

the configuration version this migration converts from (e.g. 1)

targetVersion

int targetVersion()

Returns:

the configuration version this migration converts to (e.g. 2)

migrate

void migrate(@NotNull
             @NotNull PropertyReader reader,
             @NotNull
             @NotNull ConfigurationData configurationData)

Migrates the configuration.

Parameters:

reader - the property reader to read the configuration file from

configurationData - configuration data to update a property's value