liquibase.executor.jvm.PreparedStatementCallback Maven / Gradle / Ivy

package liquibase.executor.jvm;

import java.sql.PreparedStatement;

/**
 * Generic callback interface for code that operates on a PreparedStatement.
 * Allows to execute any number of operations on a single PreparedStatement,
 * for example a single executeUpdate call or repeated
 * executeUpdate calls with varying parameters.
 * 
 * @author Spring Framework
 */
interface PreparedStatementCallback {

    /**
     * Gets called by JdbcTemplate.execute with an active JDBC
     * PreparedStatement. Does not need to care about closing the Statement
     * or the Connection, or about handling transactions: this will all be
     * handled by JdbcTemplate.
     * 
     * @param ps active JDBC PreparedStatement
     * @return a result object, or null if none
     * @throws java.sql.SQLException if thrown by a JDBC method, to be auto-converted
     *                               to a DataAccessException by a SQLExceptionTranslator
     * @throws liquibase.exception.DatabaseException         in case of custom exceptions
     */
    Object doInPreparedStatement(PreparedStatement ps);

}