ch.jalu.configme.migration

Interface MigrationService

All Known Implementing Classes:

PlainMigrationService

public interface MigrationService

The migration service is called when the settings manager is instantiated. It allows to validate the settings and perform migrations (e.g. delete old settings, rename settings). If a migration is performed, the config file will be saved again.

Field Summary

Fields

Modifier and Type	Field and Description
static boolean	MIGRATION_REQUIRED Constant for the return value of checkAndMigrate(ch.jalu.configme.resource.PropertyReader, ch.jalu.configme.configurationdata.ConfigurationData), indicating that a migration has been performed.
static boolean	NO_MIGRATION_NEEDED Constant for the return value of checkAndMigrate(ch.jalu.configme.resource.PropertyReader, ch.jalu.configme.configurationdata.ConfigurationData), indicating that no migration was needed.

Method Summary

Modifier and Type	Method and Description
boolean	checkAndMigrate(PropertyReader reader, ConfigurationData configurationData) Performs the migration, returning whether a migration has been performed or not.

Field Detail

MIGRATION_REQUIRED

static final boolean MIGRATION_REQUIRED

Constant for the return value of checkAndMigrate(ch.jalu.configme.resource.PropertyReader, ch.jalu.configme.configurationdata.ConfigurationData), indicating that a migration has been performed.

See Also:

Constant Field Values

NO_MIGRATION_NEEDED

static final boolean NO_MIGRATION_NEEDED

Constant for the return value of checkAndMigrate(ch.jalu.configme.resource.PropertyReader, ch.jalu.configme.configurationdata.ConfigurationData), indicating that no migration was needed.

See Also:

Constant Field Values

Method Detail

checkAndMigrate

boolean checkAndMigrate(PropertyReader reader,
                        ConfigurationData configurationData)

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

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