com.firefly.db.init.ScriptStatementFailedException Maven / Gradle / Ivy

Go to download
package com.firefly.db.init;

import com.firefly.utils.io.EncodedResource;

/**
 * Thrown by {@link ScriptUtils} if a statement in an SQL script failed when
 * executing it against the target database.
 */
@SuppressWarnings("serial")
public class ScriptStatementFailedException extends ScriptException {

    /**
     * Construct a new {@code ScriptStatementFailedException}.
     *
     * @param stmt            the actual SQL statement that failed
     * @param stmtNumber      the statement number in the SQL script (i.e.,
     *                        the n^th statement present in the resource)
     * @param encodedResource the resource from which the SQL statement was read
     * @param cause           the underlying cause of the failure
     */
    public ScriptStatementFailedException(String stmt, int stmtNumber, EncodedResource encodedResource, Throwable cause) {
        super(buildErrorMessage(stmt, stmtNumber, encodedResource), cause);
    }


    /**
     * Build an error message for an SQL script execution failure,
     * based on the supplied arguments.
     *
     * @param stmt            the actual SQL statement that failed
     * @param stmtNumber      the statement number in the SQL script (i.e.,
     *                        the n^th statement present in the resource)
     * @param encodedResource the resource from which the SQL statement was read
     * @return an error message suitable for an exception's detail message
     * or logging
     * @since 4.2
     */
    public static String buildErrorMessage(String stmt, int stmtNumber, EncodedResource encodedResource) {
        return String.format("Failed to execute SQL script statement #%s of %s: %s", stmtNumber, encodedResource, stmt);
    }

}