/*
 * 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;

The state of a migration.
/**
 * The state of a migration.
 */
public enum MigrationState {
    
This migration has not been applied yet.
/**
     * This migration has not been applied yet.
     */
    PENDING("Pending", true, false, false),

    
This migration has not been applied yet, and won't be applied because target is set to a lower version.
/**
     * This migration has not been applied yet, and won't be applied because target is set to a lower version.
     */
    ABOVE_TARGET("Above Target", true, false, false),

    
This migration was not applied against this DB, because the schema history table was baselined with a higher version.
/**
     * This migration was not applied against this DB, because the schema history table was baselined with a higher version.
     */
    BELOW_BASELINE("Below Baseline", true, false, false),

    
This migration has baselined this DB.
/**
     * This migration has baselined this DB.
     */
    BASELINE("Baseline", true, true, false),

    
This usually indicates a problem.

This migration was not applied against this DB, because a migration with a higher version has already been
applied. This probably means some checkins happened out of order.

Fix by increasing the version number, run clean and migrate again or rerun migration with outOfOrder enabled.
/**
     * <p>This usually indicates a problem.</p>
     * <p>
     * This migration was not applied against this DB, because a migration with a higher version has already been
     * applied. This probably means some checkins happened out of order.
     * </p>
     * <p>Fix by increasing the version number, run clean and migrate again or rerun migration with outOfOrder enabled.</p>
     */
    IGNORED("Ignored", true, false, false),

    
This migration succeeded.

This migration was applied against this DB, but it is not available locally.
This usually results from multiple older migration files being consolidated into a single one.

/**
     * <p>This migration succeeded.</p>
     * <p>
     * This migration was applied against this DB, but it is not available locally.
     * This usually results from multiple older migration files being consolidated into a single one.
     * </p>
     */
    MISSING_SUCCESS("Missing", false, true, false),

    
This migration failed.

This migration was applied against this DB, but it is not available locally.
This usually results from multiple older migration files being consolidated into a single one.

This should rarely, if ever, occur in practice.
/**
     * <p>This migration failed.</p>
     * <p>
     * This migration was applied against this DB, but it is not available locally.
     * This usually results from multiple older migration files being consolidated into a single one.
     * </p>
     * <p>This should rarely, if ever, occur in practice.</p>
     */
    MISSING_FAILED("Failed (Missing)", false, true, true),

    
This migration succeeded.
/**
     * This migration succeeded.
     */
    SUCCESS("Success", true, true, false),

    
This versioned migration succeeded, but has since been undone.
/**
     * This versioned migration succeeded, but has since been undone.
     */
    UNDONE("Undone", true, true, false),

    
This undo migration is ready to be applied if desired.
/**
     * This undo migration is ready to be applied if desired.
     */
    AVAILABLE("Available", true, false, false),

    
This migration failed.
/**
     * This migration failed.
     */
    FAILED("Failed", true, true, true),

    
This migration succeeded.

This migration succeeded, but it was applied out of order.
Rerunning the entire migration history might produce different results!

/**
     * <p>This migration succeeded.</p>
     * <p>
     * This migration succeeded, but it was applied out of order.
     * Rerunning the entire migration history might produce different results!
     * </p>
     */
    OUT_OF_ORDER("Out of Order", true, true, false),

    
This migration succeeded.

This migration has been applied against the DB, but it is not available locally.
Its version is higher than the highest version available locally.
It was most likely successfully installed by a future version of this deployable.

/**
     * <p>This migration succeeded.</p>
     * <p>
     * This migration has been applied against the DB, but it is not available locally.
     * Its version is higher than the highest version available locally.
     * It was most likely successfully installed by a future version of this deployable.
     * </p>
     */
    FUTURE_SUCCESS("Future", false, true, false),

    
This migration failed.

This migration has been applied against the DB, but it is not available locally.
Its version is higher than the highest version available locally.
It most likely failed during the installation of a future version of this deployable.

/**
     * <p>This migration failed.</p>
     * <p>
     * This migration has been applied against the DB, but it is not available locally.
     * Its version is higher than the highest version available locally.
     * It most likely failed during the installation of a future version of this deployable.
     * </p>
     */
    FUTURE_FAILED("Failed (Future)", false, true, true),

    
This is a repeatable migration that is outdated and should be re-applied.
/**
     * This is a repeatable migration that is outdated and should be re-applied.
     */
    OUTDATED("Outdated", true, true, false),

    
This is a repeatable migration that is outdated and has already been superseded by a newer run.
/**
     * This is a repeatable migration that is outdated and has already been superseded by a newer run.
     */
    SUPERSEDED("Superseded", true, true, false);

    
The name suitable for display to the end-user.
/**
     * The name suitable for display to the end-user.
     */
    private final String displayName;

    
Flag indicating if this migration is available on the classpath or not.
/**
     * Flag indicating if this migration is available on the classpath or not.
     */
    private final boolean resolved;

    
Flag indicating if this migration has been applied or not.
/**
     * Flag indicating if this migration has been applied or not.
     */
    private final boolean applied;

    
Flag indicating if this migration has failed when it was applied or not.
/**
     * Flag indicating if this migration has failed when it was applied or not.
     */
    private final boolean failed;

    
Creates a new MigrationState.
Params:
displayName – The name suitable for display to the end-user.
resolved –   Flag indicating if this migration is available on the classpath or not.
applied –     Flag indicating if this migration has been applied or not.
failed –      Flag indicating if this migration has failed when it was applied or not./**
     * Creates a new MigrationState.
     *
     * @param displayName The name suitable for display to the end-user.
     * @param resolved   Flag indicating if this migration is available on the classpath or not.
     * @param applied     Flag indicating if this migration has been applied or not.
     * @param failed      Flag indicating if this migration has failed when it was applied or not.
     */
    MigrationState(String displayName, boolean resolved, boolean applied, boolean failed) {
        this.displayName = displayName;
        this.resolved = resolved;
        this.applied = applied;
        this.failed = failed;
    }

    
Returns:
The name suitable for display to the end-user./**
     * @return The name suitable for display to the end-user.
     */
    public String getDisplayName() {
        return displayName;
    }

    
Returns:
Flag indicating if this migration has been applied or not./**
     * @return Flag indicating if this migration has been applied or not.
     */
    public boolean isApplied() {
        return applied;
    }

    
Returns:
Flag indicating if this migration has been resolved or not./**
     * @return Flag indicating if this migration has been resolved or not.
     */
    public boolean isResolved() {
        return resolved;
    }

    
Returns:
Flag indicating if this migration has failed or not./**
     * @return Flag indicating if this migration has failed or not.
     */
    public boolean isFailed() {
        return failed;
    }
}