1 /*
2 * Copyright 2002-2012 the original author or authors.
3 *
4 * Licensed under the Apache License, Version 2.0 (the "License");
5 * you may not use this file except in compliance with the License.
6 * You may obtain a copy of the License at
7 *
8 * http://www.apache.org/licenses/LICENSE-2.0
9 *
10 * Unless required by applicable law or agreed to in writing, software
11 * distributed under the License is distributed on an "AS IS" BASIS,
12 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13 * See the License for the specific language governing permissions and
14 * limitations under the License.
15 */
16
17 package org.springframework.jdbc.core;
18
19 import java.sql.Connection;
20 import java.sql.PreparedStatement;
21 import java.sql.SQLException;
22
23 /**
24 * One of the two central callback interfaces used by the JdbcTemplate class.
25 * This interface creates a PreparedStatement given a connection, provided
26 * by the JdbcTemplate class. Implementations are responsible for providing
27 * SQL and any necessary parameters.
28 *
29 * <p>Implementations <i>do not</i> need to concern themselves with
30 * SQLExceptions that may be thrown from operations they attempt.
31 * The JdbcTemplate class will catch and handle SQLExceptions appropriately.
32 *
33 * <p>A PreparedStatementCreator should also implement the SqlProvider interface
34 * if it is able to provide the SQL it uses for PreparedStatement creation.
35 * This allows for better contextual information in case of exceptions.
36 *
37 * @author Rod Johnson
38 * @see JdbcTemplate#execute(PreparedStatementCreator, PreparedStatementCallback)
39 * @see JdbcTemplate#query(PreparedStatementCreator, RowCallbackHandler)
40 * @see JdbcTemplate#update(PreparedStatementCreator)
41 * @see SqlProvider
42 */
43 public interface PreparedStatementCreator {
44
45 /**
46 * Create a statement in this connection. Allows implementations to use
47 * PreparedStatements. The JdbcTemplate will close the created statement.
48 * @param con Connection to use to create statement
49 * @return a prepared statement
50 * @throws SQLException there is no need to catch SQLExceptions
51 * that may be thrown in the implementation of this method.
52 * The JdbcTemplate class will handle them.
53 */
54 PreparedStatement createPreparedStatement(Connection con) throws SQLException;
55
56 }