/*
 * Copyright 2010-2020 Redgate Software Ltd
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 *         http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */
package org.flywaydb.core.api.callback;

The Flyway lifecycle events that can be handled in callbacks.
/**
 * The Flyway lifecycle events that can be handled in callbacks.
 */
public enum Event {
    
Fired before clean is executed. This event will be fired in a separate transaction from the actual clean operation.
/**
     * Fired before clean is executed. This event will be fired in a separate transaction from the actual clean operation.
     */
    BEFORE_CLEAN("beforeClean"),
    
Fired after clean has succeeded. This event will be fired in a separate transaction from the actual clean operation.
/**
     * Fired after clean has succeeded. This event will be fired in a separate transaction from the actual clean operation.
     */
    AFTER_CLEAN("afterClean"),
    
Fired after clean has failed. This event will be fired in a separate transaction from the actual clean operation.
/**
     * Fired after clean has failed. This event will be fired in a separate transaction from the actual clean operation.
     */
    AFTER_CLEAN_ERROR("afterCleanError"),

    
Fired before migrate is executed. This event will be fired in a separate transaction from the actual migrate operation.
/**
     * Fired before migrate is executed. This event will be fired in a separate transaction from the actual migrate operation.
     */
    BEFORE_MIGRATE("beforeMigrate"),
    
Fired before each individual migration is executed. This event will be fired within the same transaction (if any)
as the migration and can be used for things like setting up connection parameters that are required by migrations.
/**
     * Fired before each individual migration is executed. This event will be fired within the same transaction (if any)
     * as the migration and can be used for things like setting up connection parameters that are required by migrations.
     */
    BEFORE_EACH_MIGRATE("beforeEachMigrate"),
    
Fired before each individual statement in a migration is executed. This event will be fired within the same transaction (if any)
as the migration and can be used for things like asserting a statement complies with policy (for example: no grant statements allowed).
Flyway Pro and Enterprise Edition only
/**
     * Fired before each individual statement in a migration is executed. This event will be fired within the same transaction (if any)
     * as the migration and can be used for things like asserting a statement complies with policy (for example: no grant statements allowed).
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    BEFORE_EACH_MIGRATE_STATEMENT("beforeEachMigrateStatement"),
    
Fired after each individual statement in a migration that succeeded. This event will be fired within the same transaction (if any)
as the migration.
Flyway Pro and Enterprise Edition only
/**
     * Fired after each individual statement in a migration that succeeded. This event will be fired within the same transaction (if any)
     * as the migration.
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    AFTER_EACH_MIGRATE_STATEMENT("afterEachMigrateStatement"),
    
Fired after each individual statement in a migration that failed. This event will be fired within the same transaction (if any)
as the migration.
Flyway Pro and Enterprise Edition only
/**
     * Fired after each individual statement in a migration that failed. This event will be fired within the same transaction (if any)
     * as the migration.
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    AFTER_EACH_MIGRATE_STATEMENT_ERROR("afterEachMigrateStatementError"),
    
Fired after each individual migration that succeeded. This event will be fired within the same transaction (if any)
as the migration.
/**
     * Fired after each individual migration that succeeded. This event will be fired within the same transaction (if any)
     * as the migration.
     */
    AFTER_EACH_MIGRATE("afterEachMigrate"),
    
Fired after each individual migration that failed. This event will be fired within the same transaction (if any)
as the migration.
/**
     * Fired after each individual migration that failed. This event will be fired within the same transaction (if any)
     * as the migration.
     */
    AFTER_EACH_MIGRATE_ERROR("afterEachMigrateError"),
    
Fired after migrate has succeeded. This event will be fired in a separate transaction from the actual migrate operation.
/**
     * Fired after migrate has succeeded. This event will be fired in a separate transaction from the actual migrate operation.
     */
    AFTER_MIGRATE("afterMigrate"),
    
Fired after migrate has failed. This event will be fired in a separate transaction from the actual migrate operation.
/**
     * Fired after migrate has failed. This event will be fired in a separate transaction from the actual migrate operation.
     */
    AFTER_MIGRATE_ERROR("afterMigrateError"),

    
Fired before undo is executed. This event will be fired in a separate transaction from the actual undo operation.
Flyway Pro and Enterprise Edition only
/**
     * Fired before undo is executed. This event will be fired in a separate transaction from the actual undo operation.
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    BEFORE_UNDO("beforeUndo"),
    
Fired before each individual undo is executed. This event will be fired within the same transaction (if any)
as the undo and can be used for things like setting up connection parameters that are required by undo.
Flyway Pro and Enterprise Edition only
/**
     * Fired before each individual undo is executed. This event will be fired within the same transaction (if any)
     * as the undo and can be used for things like setting up connection parameters that are required by undo.
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    BEFORE_EACH_UNDO("beforeEachUndo"),
    
Fired before each individual statement in an undo migration is executed. This event will be fired within the same transaction (if any)
as the migration and can be used for things like asserting a statement complies with policy (for example: no grant statements allowed).
Flyway Pro and Enterprise Edition only
/**
     * Fired before each individual statement in an undo migration is executed. This event will be fired within the same transaction (if any)
     * as the migration and can be used for things like asserting a statement complies with policy (for example: no grant statements allowed).
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    BEFORE_EACH_UNDO_STATEMENT("beforeEachUndoStatement"),
    
Fired after each individual statement in an undo migration that succeeded. This event will be fired within the same transaction (if any)
as the migration.
Flyway Pro and Enterprise Edition only
/**
     * Fired after each individual statement in an undo migration that succeeded. This event will be fired within the same transaction (if any)
     * as the migration.
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    AFTER_EACH_UNDO_STATEMENT("afterEachUndoStatement"),
    
Fired after each individual statement in an undo migration that failed. This event will be fired within the same transaction (if any)
as the migration.
Flyway Pro and Enterprise Edition only
/**
     * Fired after each individual statement in an undo migration that failed. This event will be fired within the same transaction (if any)
     * as the migration.
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    AFTER_EACH_UNDO_STATEMENT_ERROR("afterEachUndoStatementError"),
    
Fired after each individual undo that succeeded. This event will be fired within the same transaction (if any)
as the undo.
Flyway Pro and Enterprise Edition only
/**
     * Fired after each individual undo that succeeded. This event will be fired within the same transaction (if any)
     * as the undo.
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    AFTER_EACH_UNDO("afterEachUndo"),
    
Fired after each individual undo that failed. This event will be fired within the same transaction (if any)
as the undo.
Flyway Pro and Enterprise Edition only
/**
     * Fired after each individual undo that failed. This event will be fired within the same transaction (if any)
     * as the undo.
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    AFTER_EACH_UNDO_ERROR("afterEachUndoError"),
    
Fired after undo has succeeded. This event will be fired in a separate transaction from the actual undo operation.
Flyway Pro and Enterprise Edition only
/**
     * Fired after undo has succeeded. This event will be fired in a separate transaction from the actual undo operation.
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    AFTER_UNDO("afterUndo"),
    
Fired after undo has failed. This event will be fired in a separate transaction from the actual undo operation.
Flyway Pro and Enterprise Edition only
/**
     * Fired after undo has failed. This event will be fired in a separate transaction from the actual undo operation.
     * <p><i>Flyway Pro and Enterprise Edition only</i></p>
     */
    AFTER_UNDO_ERROR("afterUndoError"),

    
Fired before validate is executed. This event will be fired in a separate transaction from the actual validate operation.
/**
     * Fired before validate is executed. This event will be fired in a separate transaction from the actual validate operation.
     */
    BEFORE_VALIDATE("beforeValidate"),
    
Fired after validate has succeeded. This event will be fired in a separate transaction from the actual validate operation.
/**
     * Fired after validate has succeeded. This event will be fired in a separate transaction from the actual validate operation.
     */
    AFTER_VALIDATE("afterValidate"),
    
Fired after validate has failed. This event will be fired in a separate transaction from the actual validate operation.
/**
     * Fired after validate has failed. This event will be fired in a separate transaction from the actual validate operation.
     */
    AFTER_VALIDATE_ERROR("afterValidateError"),

    
Fired before baseline is executed. This event will be fired in a separate transaction from the actual baseline operation.
/**
     * Fired before baseline is executed. This event will be fired in a separate transaction from the actual baseline operation.
     */
    BEFORE_BASELINE("beforeBaseline"),
    
Fired after baseline has succeeded. This event will be fired in a separate transaction from the actual baseline operation.
/**
     * Fired after baseline has succeeded. This event will be fired in a separate transaction from the actual baseline operation.
     */
    AFTER_BASELINE("afterBaseline"),
    
Fired after baseline has failed. This event will be fired in a separate transaction from the actual baseline operation.
/**
     * Fired after baseline has failed. This event will be fired in a separate transaction from the actual baseline operation.
     */
    AFTER_BASELINE_ERROR("afterBaselineError"),

    
Fired before repair is executed. This event will be fired in a separate transaction from the actual repair operation.
/**
     * Fired before repair is executed. This event will be fired in a separate transaction from the actual repair operation.
     */
    BEFORE_REPAIR("beforeRepair"),
    
Fired after repair has succeeded. This event will be fired in a separate transaction from the actual repair operation.
/**
     * Fired after repair has succeeded. This event will be fired in a separate transaction from the actual repair operation.
     */
    AFTER_REPAIR("afterRepair"),
    
Fired after repair has failed. This event will be fired in a separate transaction from the actual repair operation.
/**
     * Fired after repair has failed. This event will be fired in a separate transaction from the actual repair operation.
     */
    AFTER_REPAIR_ERROR("afterRepairError"),

    
Fired before info is executed. This event will be fired in a separate transaction from the actual info operation.
/**
     * Fired before info is executed. This event will be fired in a separate transaction from the actual info operation.
     */
    BEFORE_INFO("beforeInfo"),
    
Fired after info has succeeded. This event will be fired in a separate transaction from the actual info operation.
/**
     * Fired after info has succeeded. This event will be fired in a separate transaction from the actual info operation.
     */
    AFTER_INFO("afterInfo"),
    
Fired after info has failed. This event will be fired in a separate transaction from the actual info operation.
/**
     * Fired after info has failed. This event will be fired in a separate transaction from the actual info operation.
     */
    AFTER_INFO_ERROR("afterInfoError");

    private final String id;

    Event(String id) {
        this.id = id;
    }

    
Returns:
The id of an event. Examples: beforeClean, afterEachMigrate, .../**
     * @return The id of an event. Examples: {@code beforeClean}, {@code afterEachMigrate}, ...
     */
    public String getId() {
        return id;
    }

    
Retrieves the event with this id.
Params:
id – The id.
Returns:
The event. null if not found./**
     * Retrieves the event with this id.
     * @param id The id.
     * @return The event. {@code null} if not found.
     */
    public static Event fromId(String id) {
        for (Event event : values()) {
            if (event.id.equals(id)) {
                return event;
            }
        }
        return null;
    }

    @Override
    public String toString() {
        return id;
    }
}