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.

Constructor Summary

Constructors

Constructor and Description
PlainMigrationService()

Method Summary

Modifier and Type	Method and Description
boolean	checkAndMigrate(PropertyResource resource, List<Property<?>> properties) Checks the settings and perform any necessary migrations.
protected boolean	performMigrations(PropertyResource resource, List<Property<?>> properties) 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(PropertyResource resource,
                               List<Property<?>> properties)

Description copied from interface: MigrationService

Checks the settings and perform any necessary migrations.

Specified by:

checkAndMigrate in interface MigrationService

Parameters:

resource - the property resource

properties - all existing properties

Returns:

true if a migration has been performed, false if the settings are up-to-date

performMigrations

protected boolean performMigrations(PropertyResource resource,
                                    List<Property<?>> properties)

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 renamed properties in this method.

Note that you do not have to save the resource. The settings manager automatically does this if the migration service returns an according result.

Parameters:

resource - the property resource to check

properties - list of known properties

Returns:

true if a migration was performed and the config should be saved, false if no migration was performed