ch.jalu.configme.migration

Class PlainMigrationService

java.lang.Object

ch.jalu.configme.migration.PlainMigrationService

All Implemented Interfaces:

MigrationService

public class PlainMigrationService
extends Object
implements MigrationService

Simple migration service that can be extended.

Field Summary

Fields inherited from interface ch.jalu.configme.migration.MigrationService

MIGRATION_REQUIRED, NO_MIGRATION_NEEDED

Constructor Summary

Constructors

Constructor and Description
PlainMigrationService()

Method Summary

Modifier and Type	Method and Description
boolean	checkAndMigrate(@NotNull PropertyReader reader, @NotNull ConfigurationData configurationData) Performs the migration, returning whether a migration has been performed or not.
protected boolean	performMigrations(@NotNull PropertyReader reader, @NotNull ConfigurationData configurationData) Override this method for custom migrations.

Methods inherited from class java.lang.Object

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

Constructor Detail

PlainMigrationService

public PlainMigrationService()

Method Detail

checkAndMigrate

public boolean checkAndMigrate(@NotNull
                               @NotNull PropertyReader reader,
                               @NotNull
                               @NotNull ConfigurationData configurationData)

Description copied from interface: MigrationService

Performs the migration, returning whether a migration has been performed or not.

Specified by:

checkAndMigrate in interface MigrationService

Parameters:

reader - reader to access the values in the configuration file

configurationData - configuration data, which knows all properties and manages their associated values

Returns:

true if a migration has been performed, false otherwise. Indicates whether the configuration data should be saved to the configuration file or not

performMigrations

protected boolean performMigrations(@NotNull
                                    @NotNull PropertyReader reader,
                                    @NotNull
                                    @NotNull ConfigurationData configurationData)

Override this method for custom migrations. This method is executed before checking if all settings are present. For instance, you could implement deleting obsolete properties and rename properties in this method.

Note that the settings manager automatically saves the resource if the migration service returns MigrationService.MIGRATION_REQUIRED from checkAndMigrate(ch.jalu.configme.resource.PropertyReader, ch.jalu.configme.configurationdata.ConfigurationData).

Parameters:

reader - the reader with which the configuration file can be read

configurationData - the configuration data

Returns:

true if a migration has been performed, false otherwise (see constants on MigrationService)