PreparedStatementSetter


1   /*
2    * Copyright 2002-2005 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.PreparedStatement  ;
20  import java.sql.SQLException  ;
21  
22  /**
23   * Callback interface used by the JdbcTemplate class.
24   *
25   * <p>This interface sets values on a PreparedStatement provided by the
26   * JdbcTemplate class. Implementations are responsible for setting any
27   * necessary parameters. SQL with placeholders will already have been supplied.
28   *
29   * <p>It's easier to use this interface than PreparedStatementCreator,
30   * as the JdbcTemplate will create the prepared statement.
31   *
32   * <p>Implementations <i>do not</i> need to concern themselves with
33   * SQLExceptions that may be thrown from operations they attempt.
34   * The JdbcTemplate class will catch and handle SQLExceptions appropriately.
35   *
36   * @author Rod Johnson
37   * @since March 2, 2003
38   * @see JdbcTemplate#update(String, PreparedStatementSetter)
39   */
40  public interface PreparedStatementSetter {
41  
42      /** 
43      * Set values on the given PreparedStatement.
44      * @param ps PreparedStatement we'll invoke setter methods on
45      * @throws SQLException there is no need to catch SQLExceptions
46      * that may be thrown in the implementation of this method.
47      * The JdbcTemplate class will handle them.
48      */
49      void setValues(PreparedStatement   ps) throws SQLException  ;
50  
51  }
52
A to Z: JavaDoc & Examples Daily Java News & Articles Open Source Projects Open Source Codes Free Computer Books Remove Frame
Popular Tags