/*
 * Copyright 2019-2022 the original author or authors.
 *
 * 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
 *
 *      https://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.springframework.data.cassandra.core.cql.session.init;

import org.springframework.core.io.support.EncodedResource;

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

	/**
	 * Construct a new {@link ScriptStatementFailedException}.
	 *
	 * @param stmt the actual CQL statement that failed.
	 * @param stmtNumber the statement number in the CQL script (i.e., the n<sup>th</sup> statement present in the
	 *          resource).
	 * @param encodedResource the resource from which the CQL statement was read.
	 * @param cause the root cause.
	 */
	public ScriptStatementFailedException(String stmt, int stmtNumber, EncodedResource encodedResource, Throwable cause) {
		super(buildErrorMessage(stmt, stmtNumber, encodedResource), cause);
	}

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