com.github.fabienbarbero.sql.migration.Migrator Maven / Gradle / Ivy

Go to download

Show more of this group Show more artifacts with this name
Show all versions of sql-api Show documentation

A simple SQL api

The newest version!

/*
 * This library is free software; you can redistribute it and/or
 * modify it under the terms of the GNU Lesser General Public
 * License as published by the Free Software Foundation; either
 * version 2.1 of the License, or (at your option) any later version.
 *
 * This library is distributed in the hope that it will be useful,
 * but WITHOUT ANY WARRANTY; without even the implied warranty of
 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the GNU
 * Lesser General Public License for more details.
 *
 * You should have received a copy of the GNU Lesser General Public
 * License along with this library; if not, write to the Free Software
 * Foundation, Inc., 51 Franklin Street, Fifth Floor, Boston,
 * MA 02110-1301  USA
 */
package com.github.fabienbarbero.sql.migration;

/**
 * Class executing a migration. It must be registered in {@link MigrationManager#register(Migrator)}.
 *
 * @author Fabien Barbero
 */
public abstract class Migrator
{

    private final String name;

    public Migrator( String name) {
        this.name = name;
    }

    String getName()
    {
        return name;
    }

    protected void migrateLiveBefore( MigrationContext context )
            throws Exception
    {
        throw new MigrationSkippedException();
    }

    protected void migrateNormal( MigrationContext context )
            throws Exception
    {
        throw new MigrationSkippedException();
    }

    protected void migrateLiveAfter( MigrationContext context )
            throws Exception
    {
        throw new MigrationSkippedException();
    }

}