/*
 * 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.internal.schemahistory;

import org.flywaydb.core.api.MigrationType;
import org.flywaydb.core.api.MigrationVersion;

import java.util.Date;
import java.util.Objects;

A migration applied to the database (maps to a row in the schema history table).
/**
 * A migration applied to the database (maps to a row in the schema history table).
 */
public class AppliedMigration implements Comparable<AppliedMigration> {
    
The order in which this migration was applied amongst all others. (For out of order detection)
/**
     * The order in which this migration was applied amongst all others. (For out of order detection)
     */
    private final int installedRank;

    
The target version of this migration. null if it is a repeatable migration. /**
     * The target version of this migration. {@code null} if it is a repeatable migration.
     */
    private final MigrationVersion version;

    
The description of the migration.
/**
     * The description of the migration.
     */
    private final String description;

    
The type of migration (BASELINE, SQL, ...)
/**
     * The type of migration (BASELINE, SQL, ...)
     */
    private final MigrationType type;

    
The name of the script to execute for this migration, relative to its classpath location.
/**
     * The name of the script to execute for this migration, relative to its classpath location.
     */
    private final String script;

    
The checksum of the migration. (Optional)
/**
     * The checksum of the migration. (Optional)
     */
    private final Integer checksum;

    
The timestamp when this migration was installed.
/**
     * The timestamp when this migration was installed.
     */
    private final Date installedOn;

    
The user that installed this migration.
/**
     * The user that installed this migration.
     */
    private final String installedBy;

    
The execution time (in millis) of this migration.
/**
     * The execution time (in millis) of this migration.
     */
    private final int executionTime;

    
Flag indicating whether the migration was successful or not.
/**
     * Flag indicating whether the migration was successful or not.
     */
    private final boolean success;

    
Creates a new applied migration. Only called from the RowMapper.
Params:
installedRank – The order in which this migration was applied amongst all others. (For out of order detection)
version –       The target version of this migration.
description –   The description of the migration.
type –          The type of migration (INIT, SQL, ...)
script –        The name of the script to execute for this migration, relative to its classpath location.
checksum –      The checksum of the migration. (Optional)
installedOn –   The timestamp when this migration was installed.
installedBy –   The user that installed this migration.
executionTime – The execution time (in millis) of this migration.
success –       Flag indicating whether the migration was successful or not./**
     * Creates a new applied migration. Only called from the RowMapper.
     *
     * @param installedRank The order in which this migration was applied amongst all others. (For out of order detection)
     * @param version       The target version of this migration.
     * @param description   The description of the migration.
     * @param type          The type of migration (INIT, SQL, ...)
     * @param script        The name of the script to execute for this migration, relative to its classpath location.
     * @param checksum      The checksum of the migration. (Optional)
     * @param installedOn   The timestamp when this migration was installed.
     * @param installedBy   The user that installed this migration.
     * @param executionTime The execution time (in millis) of this migration.
     * @param success       Flag indicating whether the migration was successful or not.
     */
    public AppliedMigration(int installedRank, MigrationVersion version, String description,
                     MigrationType type, String script, Integer checksum, Date installedOn,
                     String installedBy, int executionTime, boolean success) {
        this.installedRank = installedRank;
        this.version = version;
        this.description = description;
        this.type = type;
        this.script = script;
        this.checksum = checksum;
        this.installedOn = installedOn;
        this.installedBy = installedBy;
        this.executionTime = executionTime;
        this.success = success;
    }

    
Returns:
The order in which this migration was applied amongst all others. (For out of order detection)/**
     * @return The order in which this migration was applied amongst all others. (For out of order detection)
     */
    public int getInstalledRank() {
        return installedRank;
    }

    
Returns:
The target version of this migration./**
     * @return The target version of this migration.
     */
    public MigrationVersion getVersion() {
        return version;
    }

    
Returns:
The description of the migration./**
     * @return The description of the migration.
     */
    public String getDescription() {
        return description;
    }

    
Returns:
The type of migration (BASELINE, SQL, ...)/**
     * @return The type of migration (BASELINE, SQL, ...)
     */
    public MigrationType getType() {
        return type;
    }

    
Returns:
The name of the script to execute for this migration, relative to its classpath location./**
     * @return The name of the script to execute for this migration, relative to its classpath location.
     */
    public String getScript() {
        return script;
    }

    
Returns:
The checksum of the migration. (Optional)/**
     * @return The checksum of the migration. (Optional)
     */
    public Integer getChecksum() {
        return checksum;
    }

    
Returns:
The timestamp when this migration was installed./**
     * @return The timestamp when this migration was installed.
     */
    public Date getInstalledOn() {
        return installedOn;
    }

    
Returns:
The user that installed this migration./**
     * @return The user that installed this migration.
     */
    public String getInstalledBy() {
        return installedBy;
    }

    
Returns:
The execution time (in millis) of this migration./**
     * @return The execution time (in millis) of this migration.
     */
    public int getExecutionTime() {
        return executionTime;
    }

    
Returns:
Flag indicating whether the migration was successful or not./**
     * @return Flag indicating whether the migration was successful or not.
     */
    public boolean isSuccess() {
        return success;
    }

    @SuppressWarnings("SimplifiableIfStatement")
    @Override
    public boolean equals(Object o) {
        if (this == o) return true;
        if (o == null || getClass() != o.getClass()) return false;

        AppliedMigration that = (AppliedMigration) o;

        if (executionTime != that.executionTime) return false;
        if (installedRank != that.installedRank) return false;
        if (success != that.success) return false;
        if (checksum != null ? !checksum.equals(that.checksum) : that.checksum != null) return false;
        if (!description.equals(that.description)) return false;
        if (installedBy != null ? !installedBy.equals(that.installedBy) : that.installedBy != null) return false;
        if (installedOn != null ? !installedOn.equals(that.installedOn) : that.installedOn != null) return false;
        if (!script.equals(that.script)) return false;
        if (type != that.type) return false;
        return Objects.equals(version, that.version);
    }

    @Override
    public int hashCode() {
        int result = installedRank;
        result = 31 * result + (version != null ? version.hashCode() : 0);
        result = 31 * result + description.hashCode();
        result = 31 * result + type.hashCode();
        result = 31 * result + script.hashCode();
        result = 31 * result + (checksum != null ? checksum.hashCode() : 0);
        result = 31 * result + (installedOn != null ? installedOn.hashCode() : 0);
        result = 31 * result + (installedBy != null ? installedBy.hashCode() : 0);
        result = 31 * result + executionTime;
        result = 31 * result + (success ? 1 : 0);
        return result;
    }

    @SuppressWarnings("NullableProblems")
    public int compareTo(AppliedMigration o) {
        return installedRank - o.installedRank;
    }
}