/*
* 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.jdbi.v3.core.statement;
import java.sql.CallableStatement;
import java.sql.Connection;
import java.sql.PreparedStatement;
import java.sql.SQLException;
import java.sql.Statement;
Used to convert translated SQL into a prepared statement. The default implementation created by DefaultStatementBuilder.FACTORY
creates a new statement on every call. A StatementBuilder is always associated with exactly one Handle instance See Also:
/**
* Used to convert translated SQL into a prepared statement. The default implementation
* created by {@link DefaultStatementBuilder#FACTORY} creates a new statement on every call.
*
* A StatementBuilder is always associated with exactly one Handle instance
*
* @see StatementBuilderFactory
*/
public interface StatementBuilder {
Called each time a statement needs to be created.
Params: - conn – the JDBC Connection the statement is being created for
- ctx – Statement context associated with the SqlStatement this is building for
Throws: - SQLException – if anything goes wrong getting the statement
Returns: a Statement
/**
* Called each time a statement needs to be created.
* @param conn the JDBC Connection the statement is being created for
* @param ctx Statement context associated with the SqlStatement this is building for
*
* @return a Statement
*
* @throws SQLException if anything goes wrong getting the statement
*/
Statement create(Connection conn, StatementContext ctx) throws SQLException;
Called each time a prepared statement needs to be created.
Params: - conn – the JDBC Connection the statement is being created for
- sql – the translated SQL which should be prepared
- ctx – Statement context associated with the SqlStatement this is building for
Throws: - SQLException – if anything goes wrong preparing the statement
Returns: a PreparedStatement for the given arguments
/**
* Called each time a prepared statement needs to be created.
*
* @param conn the JDBC Connection the statement is being created for
* @param sql the translated SQL which should be prepared
* @param ctx Statement context associated with the SqlStatement this is building for
*
* @return a PreparedStatement for the given arguments
*
* @throws SQLException if anything goes wrong preparing the statement
*/
PreparedStatement create(Connection conn, String sql, StatementContext ctx) throws SQLException;
Called each time a Callable statement needs to be created.
Params: - conn – the JDBC Connection the statement is being created for
- sql – the translated SQL which should be prepared
- ctx – Statement context associated with the SqlStatement this is building for
Throws: - SQLException – if anything goes wrong preparing the statement
Returns: a CallableStatement for the given arguments
/**
* Called each time a Callable statement needs to be created.
*
* @param conn the JDBC Connection the statement is being created for
* @param sql the translated SQL which should be prepared
* @param ctx Statement context associated with the SqlStatement this is building for
*
* @return a CallableStatement for the given arguments
*
* @throws SQLException if anything goes wrong preparing the statement
*/
CallableStatement createCall(Connection conn, String sql, StatementContext ctx) throws SQLException;
Called to close an individual prepared statement created from this builder.
Params: - conn – the connection to close
- sql – the translated SQL which was prepared
- stmt – the statement
Throws: - SQLException – if anything goes wrong closing the statement
/**
* Called to close an individual prepared statement created from this builder.
*
* @param conn the connection to close
* @param sql the translated SQL which was prepared
* @param stmt the statement
*
* @throws SQLException if anything goes wrong closing the statement
*/
void close(Connection conn, String sql, Statement stmt) throws SQLException;
Called when the handle this StatementBuilder is attached to is closed.
Params: - conn – the connection to close.
/**
* Called when the handle this StatementBuilder is attached to is closed.
*
* @param conn the connection to close.
*/
void close(Connection conn);
}