com.github.unafraid.plugins.migrations

Class PluginMigrations

java.lang.Object

com.github.unafraid.plugins.migrations.PluginMigrations

public class PluginMigrations
extends java.lang.Object

A class that stores a set of migrations.
Migration happens whenever you upgrade your plugin from an older version to a newer.

Constructor Summary

Constructors

Constructor and Description
PluginMigrations()

Method Summary

Modifier and Type	Method and Description
void	addMigration(IPluginMigration migration) Registers a migration into this storage class.
boolean	equals(java.lang.Object obj)
java.util.Set<IPluginMigration>	getMigrations() Gets a Set view of the migrations.
int	hashCode()
void	migrate(int from, int to, AbstractPlugin plugin) A method to start all possible applicable migrations.

Methods inherited from class java.lang.Object

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

Constructor Detail

PluginMigrations

public PluginMigrations()

Method Detail

addMigration

public void addMigration(IPluginMigration migration)

Registers a migration into this storage class.

Parameters:

migration -

getMigrations

public java.util.Set<IPluginMigration> getMigrations()

Gets a Set view of the migrations.

Returns:

migrations

migrate

public void migrate(int from,
                    int to,
                    AbstractPlugin plugin)
             throws PluginException

A method to start all possible applicable migrations.

Parameters:

from - the older version

to - the newer version

plugin - the plugin

Throws:

PluginException

hashCode

public int hashCode()

Overrides:

hashCode in class java.lang.Object

equals

public boolean equals(java.lang.Object obj)

Overrides:

equals in class java.lang.Object