src/java.sql/share/classes/java/sql/PreparedStatement.java
author alanb
Tue, 15 May 2018 09:33:02 +0100
changeset 50109 ea54197f4fe4
parent 47216 71c04702a3d5
child 57548 1f05f7952295
permissions -rw-r--r--
8203059: (so) Closing a socket channel registered with Selector and with SO_LINGER set to 0 does not reset connection Reviewed-by: chegar
Ignore whitespace changes - Everywhere: Within whitespace: At end of lines:
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     1
/*
41889
54d1ff9312ce 8169020: Add since element to JDBC deprecated methods
lancea
parents: 25991
diff changeset
     2
 * Copyright (c) 1996, 2016, Oracle and/or its affiliates. All rights reserved.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     3
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
90ce3da70b43 Initial load
duke
parents:
diff changeset
     4
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
     5
 * This code is free software; you can redistribute it and/or modify it
90ce3da70b43 Initial load
duke
parents:
diff changeset
     6
 * under the terms of the GNU General Public License version 2 only, as
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     7
 * published by the Free Software Foundation.  Oracle designates this
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
     8
 * particular file as subject to the "Classpath" exception as provided
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
     9
 * by Oracle in the LICENSE file that accompanied this code.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    10
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    11
 * This code is distributed in the hope that it will be useful, but WITHOUT
90ce3da70b43 Initial load
duke
parents:
diff changeset
    12
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    13
 * FITNESS FOR A PARTICULAR PURPOSE.  See the GNU General Public License
90ce3da70b43 Initial load
duke
parents:
diff changeset
    14
 * version 2 for more details (a copy is included in the LICENSE file that
90ce3da70b43 Initial load
duke
parents:
diff changeset
    15
 * accompanied this code).
90ce3da70b43 Initial load
duke
parents:
diff changeset
    16
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    17
 * You should have received a copy of the GNU General Public License version
90ce3da70b43 Initial load
duke
parents:
diff changeset
    18
 * 2 along with this work; if not, write to the Free Software Foundation,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    19
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    20
 *
5506
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    21
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    22
 * or visit www.oracle.com if you need additional information or have any
202f599c92aa 6943119: Rebrand source copyright notices
ohair
parents: 2
diff changeset
    23
 * questions.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    24
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    25
90ce3da70b43 Initial load
duke
parents:
diff changeset
    26
package java.sql;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    27
90ce3da70b43 Initial load
duke
parents:
diff changeset
    28
import java.math.BigDecimal;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    29
import java.util.Calendar;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    30
import java.io.Reader;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    31
import java.io.InputStream;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    32
90ce3da70b43 Initial load
duke
parents:
diff changeset
    33
/**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    34
 * An object that represents a precompiled SQL statement.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    35
 * <P>A SQL statement is precompiled and stored in a
90ce3da70b43 Initial load
duke
parents:
diff changeset
    36
 * <code>PreparedStatement</code> object. This object can then be used to
90ce3da70b43 Initial load
duke
parents:
diff changeset
    37
 * efficiently execute this statement multiple times.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    38
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    39
 * <P><B>Note:</B> The setter methods (<code>setShort</code>, <code>setString</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    40
 * and so on) for setting IN parameter values
90ce3da70b43 Initial load
duke
parents:
diff changeset
    41
 * must specify types that are compatible with the defined SQL type of
90ce3da70b43 Initial load
duke
parents:
diff changeset
    42
 * the input parameter. For instance, if the IN parameter has SQL type
90ce3da70b43 Initial load
duke
parents:
diff changeset
    43
 * <code>INTEGER</code>, then the method <code>setInt</code> should be used.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    44
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    45
 * <p>If arbitrary parameter type conversions are required, the method
90ce3da70b43 Initial load
duke
parents:
diff changeset
    46
 * <code>setObject</code> should be used with a target SQL type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    47
 * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    48
 * In the following example of setting a parameter, <code>con</code> represents
90ce3da70b43 Initial load
duke
parents:
diff changeset
    49
 * an active connection:
90ce3da70b43 Initial load
duke
parents:
diff changeset
    50
 * <PRE>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    51
 *   PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES
90ce3da70b43 Initial load
duke
parents:
diff changeset
    52
 *                                     SET SALARY = ? WHERE ID = ?");
90ce3da70b43 Initial load
duke
parents:
diff changeset
    53
 *   pstmt.setBigDecimal(1, 153833.00)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    54
 *   pstmt.setInt(2, 110592)
90ce3da70b43 Initial load
duke
parents:
diff changeset
    55
 * </PRE>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    56
 *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    57
 * @see Connection#prepareStatement
90ce3da70b43 Initial load
duke
parents:
diff changeset
    58
 * @see ResultSet
44256
12050b22e372 8176721: @since value errors java.sql module
mli
parents: 41889
diff changeset
    59
 * @since 1.1
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    60
 */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    61
90ce3da70b43 Initial load
duke
parents:
diff changeset
    62
public interface PreparedStatement extends Statement {
90ce3da70b43 Initial load
duke
parents:
diff changeset
    63
90ce3da70b43 Initial load
duke
parents:
diff changeset
    64
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    65
     * Executes the SQL query in this <code>PreparedStatement</code> object
90ce3da70b43 Initial load
duke
parents:
diff changeset
    66
     * and returns the <code>ResultSet</code> object generated by the query.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    67
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    68
     * @return a <code>ResultSet</code> object that contains the data produced by the
90ce3da70b43 Initial load
duke
parents:
diff changeset
    69
     *         query; never <code>null</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
    70
     * @exception SQLException if a database access error occurs;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    71
     * this method is called on a closed  <code>PreparedStatement</code> or the SQL
90ce3da70b43 Initial load
duke
parents:
diff changeset
    72
     *            statement does not return a <code>ResultSet</code> object
6540
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
    73
     * @throws SQLTimeoutException when the driver has determined that the
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
    74
     * timeout value that was specified by the {@code setQueryTimeout}
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
    75
     * method has been exceeded and has at least attempted to cancel
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
    76
     * the currently running {@code Statement}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    77
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    78
    ResultSet executeQuery() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    79
90ce3da70b43 Initial load
duke
parents:
diff changeset
    80
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    81
     * Executes the SQL statement in this <code>PreparedStatement</code> object,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    82
     * which must be an SQL Data Manipulation Language (DML) statement, such as <code>INSERT</code>, <code>UPDATE</code> or
90ce3da70b43 Initial load
duke
parents:
diff changeset
    83
     * <code>DELETE</code>; or an SQL statement that returns nothing,
90ce3da70b43 Initial load
duke
parents:
diff changeset
    84
     * such as a DDL statement.
90ce3da70b43 Initial load
duke
parents:
diff changeset
    85
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
    86
     * @return either (1) the row count for SQL Data Manipulation Language (DML) statements
90ce3da70b43 Initial load
duke
parents:
diff changeset
    87
     *         or (2) 0 for SQL statements that return nothing
90ce3da70b43 Initial load
duke
parents:
diff changeset
    88
     * @exception SQLException if a database access error occurs;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    89
     * this method is called on a closed  <code>PreparedStatement</code>
6540
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
    90
     * or the SQL statement returns a <code>ResultSet</code> object
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
    91
     * @throws SQLTimeoutException when the driver has determined that the
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
    92
     * timeout value that was specified by the {@code setQueryTimeout}
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
    93
     * method has been exceeded and has at least attempted to cancel
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
    94
     * the currently running {@code Statement}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
    95
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
    96
    int executeUpdate() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
    97
90ce3da70b43 Initial load
duke
parents:
diff changeset
    98
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
    99
     * Sets the designated parameter to SQL <code>NULL</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   100
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   101
     * <P><B>Note:</B> You must specify the parameter's SQL type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   102
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   103
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   104
     * @param sqlType the SQL type code defined in <code>java.sql.Types</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   105
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   106
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   107
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   108
     * @exception SQLFeatureNotSupportedException if <code>sqlType</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   109
     * a <code>ARRAY</code>, <code>BLOB</code>, <code>CLOB</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   110
     * <code>DATALINK</code>, <code>JAVA_OBJECT</code>, <code>NCHAR</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   111
     * <code>NCLOB</code>, <code>NVARCHAR</code>, <code>LONGNVARCHAR</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   112
     *  <code>REF</code>, <code>ROWID</code>, <code>SQLXML</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   113
     * or  <code>STRUCT</code> data type and the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   114
     * this data type
90ce3da70b43 Initial load
duke
parents:
diff changeset
   115
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   116
    void setNull(int parameterIndex, int sqlType) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   117
90ce3da70b43 Initial load
duke
parents:
diff changeset
   118
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   119
     * Sets the designated parameter to the given Java <code>boolean</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   120
     * The driver converts this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   121
     * to an SQL <code>BIT</code> or <code>BOOLEAN</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   122
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   123
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   124
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   125
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   126
     * marker in the SQL statement;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   127
     * if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   128
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   129
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   130
    void setBoolean(int parameterIndex, boolean x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   131
90ce3da70b43 Initial load
duke
parents:
diff changeset
   132
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   133
     * Sets the designated parameter to the given Java <code>byte</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   134
     * The driver converts this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   135
     * to an SQL <code>TINYINT</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   136
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   137
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   138
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   139
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   140
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   141
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   142
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   143
    void setByte(int parameterIndex, byte x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   144
90ce3da70b43 Initial load
duke
parents:
diff changeset
   145
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   146
     * Sets the designated parameter to the given Java <code>short</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   147
     * The driver converts this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   148
     * to an SQL <code>SMALLINT</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   149
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   150
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   151
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   152
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   153
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   154
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   155
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   156
    void setShort(int parameterIndex, short x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   157
90ce3da70b43 Initial load
duke
parents:
diff changeset
   158
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   159
     * Sets the designated parameter to the given Java <code>int</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   160
     * The driver converts this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   161
     * to an SQL <code>INTEGER</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   162
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   163
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   164
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   165
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   166
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   167
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   168
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   169
    void setInt(int parameterIndex, int x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   170
90ce3da70b43 Initial load
duke
parents:
diff changeset
   171
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   172
     * Sets the designated parameter to the given Java <code>long</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   173
     * The driver converts this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   174
     * to an SQL <code>BIGINT</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   175
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   176
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   177
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   178
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   179
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   180
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   181
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   182
    void setLong(int parameterIndex, long x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   183
90ce3da70b43 Initial load
duke
parents:
diff changeset
   184
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   185
     * Sets the designated parameter to the given Java <code>float</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   186
     * The driver converts this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   187
     * to an SQL <code>REAL</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   188
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   189
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   190
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   191
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   192
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   193
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   194
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   195
    void setFloat(int parameterIndex, float x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   196
90ce3da70b43 Initial load
duke
parents:
diff changeset
   197
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   198
     * Sets the designated parameter to the given Java <code>double</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   199
     * The driver converts this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   200
     * to an SQL <code>DOUBLE</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   201
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   202
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   203
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   204
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   205
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   206
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   207
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   208
    void setDouble(int parameterIndex, double x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   209
90ce3da70b43 Initial load
duke
parents:
diff changeset
   210
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   211
     * Sets the designated parameter to the given <code>java.math.BigDecimal</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   212
     * The driver converts this to an SQL <code>NUMERIC</code> value when
90ce3da70b43 Initial load
duke
parents:
diff changeset
   213
     * it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   214
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   215
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   216
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   217
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   218
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   219
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   220
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   221
    void setBigDecimal(int parameterIndex, BigDecimal x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   222
90ce3da70b43 Initial load
duke
parents:
diff changeset
   223
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   224
     * Sets the designated parameter to the given Java <code>String</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   225
     * The driver converts this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   226
     * to an SQL <code>VARCHAR</code> or <code>LONGVARCHAR</code> value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   227
     * (depending on the argument's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   228
     * size relative to the driver's limits on <code>VARCHAR</code> values)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   229
     * when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   230
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   231
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   232
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   233
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   234
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   235
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   236
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   237
    void setString(int parameterIndex, String x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   238
90ce3da70b43 Initial load
duke
parents:
diff changeset
   239
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   240
     * Sets the designated parameter to the given Java array of bytes.  The driver converts
90ce3da70b43 Initial load
duke
parents:
diff changeset
   241
     * this to an SQL <code>VARBINARY</code> or <code>LONGVARBINARY</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   242
     * (depending on the argument's size relative to the driver's limits on
90ce3da70b43 Initial load
duke
parents:
diff changeset
   243
     * <code>VARBINARY</code> values) when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   244
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   245
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   246
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   247
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   248
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   249
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   250
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   251
    void setBytes(int parameterIndex, byte x[]) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   252
90ce3da70b43 Initial load
duke
parents:
diff changeset
   253
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   254
     * Sets the designated parameter to the given <code>java.sql.Date</code> value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   255
     * using the default time zone of the virtual machine that is running
90ce3da70b43 Initial load
duke
parents:
diff changeset
   256
     * the application.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   257
     * The driver converts this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   258
     * to an SQL <code>DATE</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   259
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   260
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   261
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   262
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   263
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   264
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   265
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   266
    void setDate(int parameterIndex, java.sql.Date x)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   267
            throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   268
90ce3da70b43 Initial load
duke
parents:
diff changeset
   269
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   270
     * Sets the designated parameter to the given <code>java.sql.Time</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   271
     * The driver converts this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   272
     * to an SQL <code>TIME</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   273
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   274
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   275
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   276
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   277
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   278
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   279
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   280
    void setTime(int parameterIndex, java.sql.Time x)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   281
            throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   282
90ce3da70b43 Initial load
duke
parents:
diff changeset
   283
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   284
     * Sets the designated parameter to the given <code>java.sql.Timestamp</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   285
     * The driver
90ce3da70b43 Initial load
duke
parents:
diff changeset
   286
     * converts this to an SQL <code>TIMESTAMP</code> value when it sends it to the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   287
     * database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   288
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   289
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   290
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   291
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   292
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   293
     * this method is called on a closed <code>PreparedStatement</code>     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   294
    void setTimestamp(int parameterIndex, java.sql.Timestamp x)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   295
            throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   296
90ce3da70b43 Initial load
duke
parents:
diff changeset
   297
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   298
     * Sets the designated parameter to the given input stream, which will have
90ce3da70b43 Initial load
duke
parents:
diff changeset
   299
     * the specified number of bytes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   300
     * When a very large ASCII value is input to a <code>LONGVARCHAR</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   301
     * parameter, it may be more practical to send it via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   302
     * <code>java.io.InputStream</code>. Data will be read from the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   303
     * as needed until end-of-file is reached.  The JDBC driver will
90ce3da70b43 Initial load
duke
parents:
diff changeset
   304
     * do any necessary conversion from ASCII to the database char format.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   305
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   306
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
   307
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   308
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   309
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   310
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   311
     * @param x the Java input stream that contains the ASCII parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   312
     * @param length the number of bytes in the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   313
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   314
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   315
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   316
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   317
    void setAsciiStream(int parameterIndex, java.io.InputStream x, int length)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   318
            throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   319
90ce3da70b43 Initial load
duke
parents:
diff changeset
   320
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   321
     * Sets the designated parameter to the given input stream, which
90ce3da70b43 Initial load
duke
parents:
diff changeset
   322
     * will have the specified number of bytes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   323
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   324
     * When a very large Unicode value is input to a <code>LONGVARCHAR</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   325
     * parameter, it may be more practical to send it via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   326
     * <code>java.io.InputStream</code> object. The data will be read from the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   327
     * stream as needed until end-of-file is reached.  The JDBC driver will
90ce3da70b43 Initial load
duke
parents:
diff changeset
   328
     * do any necessary conversion from Unicode to the database char format.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   329
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   330
     *The byte format of the Unicode stream must be a Java UTF-8, as defined in the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   331
     *Java Virtual Machine Specification.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   332
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   333
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
   334
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   335
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   336
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   337
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   338
     * @param x a <code>java.io.InputStream</code> object that contains the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   339
     *        Unicode parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   340
     * @param length the number of bytes in the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   341
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   342
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   343
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   344
     * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   345
     * this method
14171
94eb36844bd7 7197395: Add @Deprecated to all deprecated methods to eliminate compiler warnings in JDBC
lancea
parents: 11016
diff changeset
   346
     * @deprecated Use {@code setCharacterStream}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   347
     */
41889
54d1ff9312ce 8169020: Add since element to JDBC deprecated methods
lancea
parents: 25991
diff changeset
   348
    @Deprecated(since="1.2")
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   349
    void setUnicodeStream(int parameterIndex, java.io.InputStream x,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   350
                          int length) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   351
90ce3da70b43 Initial load
duke
parents:
diff changeset
   352
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   353
     * Sets the designated parameter to the given input stream, which will have
90ce3da70b43 Initial load
duke
parents:
diff changeset
   354
     * the specified number of bytes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   355
     * When a very large binary value is input to a <code>LONGVARBINARY</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   356
     * parameter, it may be more practical to send it via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   357
     * <code>java.io.InputStream</code> object. The data will be read from the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   358
     * stream as needed until end-of-file is reached.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   359
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   360
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
   361
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   362
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   363
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   364
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   365
     * @param x the java input stream which contains the binary parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   366
     * @param length the number of bytes in the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   367
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   368
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   369
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   370
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   371
    void setBinaryStream(int parameterIndex, java.io.InputStream x,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   372
                         int length) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   373
90ce3da70b43 Initial load
duke
parents:
diff changeset
   374
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   375
     * Clears the current parameter values immediately.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   376
     * <P>In general, parameter values remain in force for repeated use of a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   377
     * statement. Setting a parameter value automatically clears its
90ce3da70b43 Initial load
duke
parents:
diff changeset
   378
     * previous value.  However, in some cases it is useful to immediately
90ce3da70b43 Initial load
duke
parents:
diff changeset
   379
     * release the resources used by the current parameter values; this can
90ce3da70b43 Initial load
duke
parents:
diff changeset
   380
     * be done by calling the method <code>clearParameters</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   381
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   382
     * @exception SQLException if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   383
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   384
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   385
    void clearParameters() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   386
90ce3da70b43 Initial load
duke
parents:
diff changeset
   387
    //----------------------------------------------------------------------
90ce3da70b43 Initial load
duke
parents:
diff changeset
   388
    // Advanced features:
90ce3da70b43 Initial load
duke
parents:
diff changeset
   389
90ce3da70b43 Initial load
duke
parents:
diff changeset
   390
   /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   391
    * Sets the value of the designated parameter with the given object.
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
   392
    *
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
   393
    * This method is similar to {@link #setObject(int parameterIndex,
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
   394
    * Object x, int targetSqlType, int scaleOrLength)},
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
   395
    * except that it assumes a scale of zero.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   396
    *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   397
    * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   398
    * @param x the object containing the input parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   399
    * @param targetSqlType the SQL type (as defined in java.sql.Types) to be
90ce3da70b43 Initial load
duke
parents:
diff changeset
   400
    *                      sent to the database
90ce3da70b43 Initial load
duke
parents:
diff changeset
   401
    * @exception SQLException if parameterIndex does not correspond to a parameter
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
   402
    * marker in the SQL statement; if a database access error occurs or this
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
   403
    * method is called on a closed PreparedStatement
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
   404
    * @exception SQLFeatureNotSupportedException if
21950
db3c826749f7 8029417: JDBC 4.2 javadoc updates
lancea
parents: 21278
diff changeset
   405
    * the JDBC driver does not support the specified targetSqlType
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   406
    * @see Types
90ce3da70b43 Initial load
duke
parents:
diff changeset
   407
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   408
    void setObject(int parameterIndex, Object x, int targetSqlType)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   409
      throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   410
90ce3da70b43 Initial load
duke
parents:
diff changeset
   411
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   412
     * <p>Sets the value of the designated parameter using the given object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   413
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   414
     * <p>The JDBC specification specifies a standard mapping from
90ce3da70b43 Initial load
duke
parents:
diff changeset
   415
     * Java <code>Object</code> types to SQL types.  The given argument
90ce3da70b43 Initial load
duke
parents:
diff changeset
   416
     * will be converted to the corresponding SQL type before being
90ce3da70b43 Initial load
duke
parents:
diff changeset
   417
     * sent to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   418
     *
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 23590
diff changeset
   419
     * <p>Note that this method may be used to pass database-
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   420
     * specific abstract data types, by using a driver-specific Java
90ce3da70b43 Initial load
duke
parents:
diff changeset
   421
     * type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   422
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   423
     * If the object is of a class implementing the interface <code>SQLData</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   424
     * the JDBC driver should call the method <code>SQLData.writeSQL</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   425
     * to write it to the SQL data stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   426
     * If, on the other hand, the object is of a class implementing
90ce3da70b43 Initial load
duke
parents:
diff changeset
   427
     * <code>Ref</code>, <code>Blob</code>, <code>Clob</code>,  <code>NClob</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   428
     *  <code>Struct</code>, <code>java.net.URL</code>, <code>RowId</code>, <code>SQLXML</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   429
     * or <code>Array</code>, the driver should pass it to the database as a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   430
     * value of the corresponding SQL type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   431
     * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   432
     *<b>Note:</b> Not all databases allow for a non-typed Null to be sent to
90ce3da70b43 Initial load
duke
parents:
diff changeset
   433
     * the backend. For maximum portability, the <code>setNull</code> or the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   434
     * <code>setObject(int parameterIndex, Object x, int sqlType)</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   435
     * method should be used
90ce3da70b43 Initial load
duke
parents:
diff changeset
   436
     * instead of <code>setObject(int parameterIndex, Object x)</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   437
     *<p>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   438
     * <b>Note:</b> This method throws an exception if there is an ambiguity, for example, if the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   439
     * object is of a class implementing more than one of the interfaces named above.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   440
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   441
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   442
     * @param x the object containing the input parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   443
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   444
     * marker in the SQL statement; if a database access error occurs;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   445
     *  this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   446
     * or the type of the given object is ambiguous
90ce3da70b43 Initial load
duke
parents:
diff changeset
   447
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   448
    void setObject(int parameterIndex, Object x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   449
90ce3da70b43 Initial load
duke
parents:
diff changeset
   450
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   451
     * Executes the SQL statement in this <code>PreparedStatement</code> object,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   452
     * which may be any kind of SQL statement.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   453
     * Some prepared statements return multiple results; the <code>execute</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   454
     * method handles these complex statements as well as the simpler
90ce3da70b43 Initial load
duke
parents:
diff changeset
   455
     * form of statements handled by the methods <code>executeQuery</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   456
     * and <code>executeUpdate</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   457
     * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   458
     * The <code>execute</code> method returns a <code>boolean</code> to
90ce3da70b43 Initial load
duke
parents:
diff changeset
   459
     * indicate the form of the first result.  You must call either the method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   460
     * <code>getResultSet</code> or <code>getUpdateCount</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   461
     * to retrieve the result; you must call <code>getMoreResults</code> to
90ce3da70b43 Initial load
duke
parents:
diff changeset
   462
     * move to any subsequent result(s).
90ce3da70b43 Initial load
duke
parents:
diff changeset
   463
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   464
     * @return <code>true</code> if the first result is a <code>ResultSet</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   465
     *         object; <code>false</code> if the first result is an update
90ce3da70b43 Initial load
duke
parents:
diff changeset
   466
     *         count or there is no result
90ce3da70b43 Initial load
duke
parents:
diff changeset
   467
     * @exception SQLException if a database access error occurs;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   468
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   469
     * or an argument is supplied to this method
6540
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
   470
     * @throws SQLTimeoutException when the driver has determined that the
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
   471
     * timeout value that was specified by the {@code setQueryTimeout}
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
   472
     * method has been exceeded and has at least attempted to cancel
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
   473
     * the currently running {@code Statement}
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   474
     * @see Statement#execute
90ce3da70b43 Initial load
duke
parents:
diff changeset
   475
     * @see Statement#getResultSet
90ce3da70b43 Initial load
duke
parents:
diff changeset
   476
     * @see Statement#getUpdateCount
90ce3da70b43 Initial load
duke
parents:
diff changeset
   477
     * @see Statement#getMoreResults
90ce3da70b43 Initial load
duke
parents:
diff changeset
   478
90ce3da70b43 Initial load
duke
parents:
diff changeset
   479
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   480
    boolean execute() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   481
90ce3da70b43 Initial load
duke
parents:
diff changeset
   482
    //--------------------------JDBC 2.0-----------------------------
90ce3da70b43 Initial load
duke
parents:
diff changeset
   483
90ce3da70b43 Initial load
duke
parents:
diff changeset
   484
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   485
     * Adds a set of parameters to this <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   486
     * object's batch of commands.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   487
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   488
     * @exception SQLException if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   489
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   490
     * @see Statement#addBatch
90ce3da70b43 Initial load
duke
parents:
diff changeset
   491
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   492
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   493
    void addBatch() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   494
90ce3da70b43 Initial load
duke
parents:
diff changeset
   495
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   496
     * Sets the designated parameter to the given <code>Reader</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   497
     * object, which is the given number of characters long.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   498
     * When a very large UNICODE value is input to a <code>LONGVARCHAR</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   499
     * parameter, it may be more practical to send it via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   500
     * <code>java.io.Reader</code> object. The data will be read from the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   501
     * as needed until end-of-file is reached.  The JDBC driver will
90ce3da70b43 Initial load
duke
parents:
diff changeset
   502
     * do any necessary conversion from UNICODE to the database char format.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   503
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   504
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
   505
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   506
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   507
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   508
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   509
     * @param reader the <code>java.io.Reader</code> object that contains the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   510
     *        Unicode data
90ce3da70b43 Initial load
duke
parents:
diff changeset
   511
     * @param length the number of characters in the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   512
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   513
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   514
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   515
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   516
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   517
    void setCharacterStream(int parameterIndex,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   518
                          java.io.Reader reader,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   519
                          int length) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   520
90ce3da70b43 Initial load
duke
parents:
diff changeset
   521
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   522
     * Sets the designated parameter to the given
90ce3da70b43 Initial load
duke
parents:
diff changeset
   523
     *  <code>REF(&lt;structured-type&gt;)</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   524
     * The driver converts this to an SQL <code>REF</code> value when it
90ce3da70b43 Initial load
duke
parents:
diff changeset
   525
     * sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   526
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   527
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   528
     * @param x an SQL <code>REF</code> value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   529
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   530
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   531
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   532
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   533
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   534
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   535
    void setRef (int parameterIndex, Ref x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   536
90ce3da70b43 Initial load
duke
parents:
diff changeset
   537
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   538
     * Sets the designated parameter to the given <code>java.sql.Blob</code> object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   539
     * The driver converts this to an SQL <code>BLOB</code> value when it
90ce3da70b43 Initial load
duke
parents:
diff changeset
   540
     * sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   541
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   542
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   543
     * @param x a <code>Blob</code> object that maps an SQL <code>BLOB</code> value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   544
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   545
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   546
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   547
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   548
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   549
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   550
    void setBlob (int parameterIndex, Blob x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   551
90ce3da70b43 Initial load
duke
parents:
diff changeset
   552
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   553
     * Sets the designated parameter to the given <code>java.sql.Clob</code> object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   554
     * The driver converts this to an SQL <code>CLOB</code> value when it
90ce3da70b43 Initial load
duke
parents:
diff changeset
   555
     * sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   556
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   557
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   558
     * @param x a <code>Clob</code> object that maps an SQL <code>CLOB</code> value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   559
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   560
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   561
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   562
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   563
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   564
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   565
    void setClob (int parameterIndex, Clob x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   566
90ce3da70b43 Initial load
duke
parents:
diff changeset
   567
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   568
     * Sets the designated parameter to the given <code>java.sql.Array</code> object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   569
     * The driver converts this to an SQL <code>ARRAY</code> value when it
90ce3da70b43 Initial load
duke
parents:
diff changeset
   570
     * sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   571
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   572
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   573
     * @param x an <code>Array</code> object that maps an SQL <code>ARRAY</code> value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   574
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   575
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   576
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   577
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   578
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   579
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   580
    void setArray (int parameterIndex, Array x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   581
90ce3da70b43 Initial load
duke
parents:
diff changeset
   582
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   583
     * Retrieves a <code>ResultSetMetaData</code> object that contains
90ce3da70b43 Initial load
duke
parents:
diff changeset
   584
     * information about the columns of the <code>ResultSet</code> object
90ce3da70b43 Initial load
duke
parents:
diff changeset
   585
     * that will be returned when this <code>PreparedStatement</code> object
90ce3da70b43 Initial load
duke
parents:
diff changeset
   586
     * is executed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   587
     * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   588
     * Because a <code>PreparedStatement</code> object is precompiled, it is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   589
     * possible to know about the <code>ResultSet</code> object that it will
90ce3da70b43 Initial load
duke
parents:
diff changeset
   590
     * return without having to execute it.  Consequently, it is possible
90ce3da70b43 Initial load
duke
parents:
diff changeset
   591
     * to invoke the method <code>getMetaData</code> on a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   592
     * <code>PreparedStatement</code> object rather than waiting to execute
90ce3da70b43 Initial load
duke
parents:
diff changeset
   593
     * it and then invoking the <code>ResultSet.getMetaData</code> method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   594
     * on the <code>ResultSet</code> object that is returned.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   595
     * <P>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   596
     * <B>NOTE:</B> Using this method may be expensive for some drivers due
90ce3da70b43 Initial load
duke
parents:
diff changeset
   597
     * to the lack of underlying DBMS support.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   598
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   599
     * @return the description of a <code>ResultSet</code> object's columns or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   600
     *         <code>null</code> if the driver cannot return a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   601
     *         <code>ResultSetMetaData</code> object
90ce3da70b43 Initial load
duke
parents:
diff changeset
   602
     * @exception SQLException if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   603
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   604
     * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   605
     * this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   606
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   607
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   608
    ResultSetMetaData getMetaData() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   609
90ce3da70b43 Initial load
duke
parents:
diff changeset
   610
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   611
     * Sets the designated parameter to the given <code>java.sql.Date</code> value,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   612
     * using the given <code>Calendar</code> object.  The driver uses
90ce3da70b43 Initial load
duke
parents:
diff changeset
   613
     * the <code>Calendar</code> object to construct an SQL <code>DATE</code> value,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   614
     * which the driver then sends to the database.  With
90ce3da70b43 Initial load
duke
parents:
diff changeset
   615
     * a <code>Calendar</code> object, the driver can calculate the date
90ce3da70b43 Initial load
duke
parents:
diff changeset
   616
     * taking into account a custom timezone.  If no
90ce3da70b43 Initial load
duke
parents:
diff changeset
   617
     * <code>Calendar</code> object is specified, the driver uses the default
90ce3da70b43 Initial load
duke
parents:
diff changeset
   618
     * timezone, which is that of the virtual machine running the application.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   619
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   620
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   621
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   622
     * @param cal the <code>Calendar</code> object the driver will use
90ce3da70b43 Initial load
duke
parents:
diff changeset
   623
     *            to construct the date
90ce3da70b43 Initial load
duke
parents:
diff changeset
   624
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   625
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   626
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   627
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   628
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   629
    void setDate(int parameterIndex, java.sql.Date x, Calendar cal)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   630
            throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   631
90ce3da70b43 Initial load
duke
parents:
diff changeset
   632
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   633
     * Sets the designated parameter to the given <code>java.sql.Time</code> value,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   634
     * using the given <code>Calendar</code> object.  The driver uses
90ce3da70b43 Initial load
duke
parents:
diff changeset
   635
     * the <code>Calendar</code> object to construct an SQL <code>TIME</code> value,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   636
     * which the driver then sends to the database.  With
90ce3da70b43 Initial load
duke
parents:
diff changeset
   637
     * a <code>Calendar</code> object, the driver can calculate the time
90ce3da70b43 Initial load
duke
parents:
diff changeset
   638
     * taking into account a custom timezone.  If no
90ce3da70b43 Initial load
duke
parents:
diff changeset
   639
     * <code>Calendar</code> object is specified, the driver uses the default
90ce3da70b43 Initial load
duke
parents:
diff changeset
   640
     * timezone, which is that of the virtual machine running the application.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   641
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   642
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   643
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   644
     * @param cal the <code>Calendar</code> object the driver will use
90ce3da70b43 Initial load
duke
parents:
diff changeset
   645
     *            to construct the time
90ce3da70b43 Initial load
duke
parents:
diff changeset
   646
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   647
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   648
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   649
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   650
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   651
    void setTime(int parameterIndex, java.sql.Time x, Calendar cal)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   652
            throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   653
90ce3da70b43 Initial load
duke
parents:
diff changeset
   654
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   655
     * Sets the designated parameter to the given <code>java.sql.Timestamp</code> value,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   656
     * using the given <code>Calendar</code> object.  The driver uses
90ce3da70b43 Initial load
duke
parents:
diff changeset
   657
     * the <code>Calendar</code> object to construct an SQL <code>TIMESTAMP</code> value,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   658
     * which the driver then sends to the database.  With a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   659
     *  <code>Calendar</code> object, the driver can calculate the timestamp
90ce3da70b43 Initial load
duke
parents:
diff changeset
   660
     * taking into account a custom timezone.  If no
90ce3da70b43 Initial load
duke
parents:
diff changeset
   661
     * <code>Calendar</code> object is specified, the driver uses the default
90ce3da70b43 Initial load
duke
parents:
diff changeset
   662
     * timezone, which is that of the virtual machine running the application.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   663
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   664
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   665
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   666
     * @param cal the <code>Calendar</code> object the driver will use
90ce3da70b43 Initial load
duke
parents:
diff changeset
   667
     *            to construct the timestamp
90ce3da70b43 Initial load
duke
parents:
diff changeset
   668
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   669
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   670
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   671
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   672
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   673
    void setTimestamp(int parameterIndex, java.sql.Timestamp x, Calendar cal)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   674
            throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   675
90ce3da70b43 Initial load
duke
parents:
diff changeset
   676
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   677
     * Sets the designated parameter to SQL <code>NULL</code>.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   678
     * This version of the method <code>setNull</code> should
90ce3da70b43 Initial load
duke
parents:
diff changeset
   679
     * be used for user-defined types and REF type parameters.  Examples
90ce3da70b43 Initial load
duke
parents:
diff changeset
   680
     * of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and
90ce3da70b43 Initial load
duke
parents:
diff changeset
   681
     * named array types.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   682
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   683
     * <P><B>Note:</B> To be portable, applications must give the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   684
     * SQL type code and the fully-qualified SQL type name when specifying
90ce3da70b43 Initial load
duke
parents:
diff changeset
   685
     * a NULL user-defined or REF parameter.  In the case of a user-defined type
90ce3da70b43 Initial load
duke
parents:
diff changeset
   686
     * the name is the type name of the parameter itself.  For a REF
90ce3da70b43 Initial load
duke
parents:
diff changeset
   687
     * parameter, the name is the type name of the referenced type.  If
90ce3da70b43 Initial load
duke
parents:
diff changeset
   688
     * a JDBC driver does not need the type code or type name information,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   689
     * it may ignore it.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   690
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   691
     * Although it is intended for user-defined and Ref parameters,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   692
     * this method may be used to set a null parameter of any JDBC type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   693
     * If the parameter does not have a user-defined or REF type, the given
90ce3da70b43 Initial load
duke
parents:
diff changeset
   694
     * typeName is ignored.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   695
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   696
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   697
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   698
     * @param sqlType a value from <code>java.sql.Types</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   699
     * @param typeName the fully-qualified name of an SQL user-defined type;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   700
     *  ignored if the parameter is not a user-defined type or REF
90ce3da70b43 Initial load
duke
parents:
diff changeset
   701
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   702
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   703
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   704
     * @exception SQLFeatureNotSupportedException if <code>sqlType</code> is
90ce3da70b43 Initial load
duke
parents:
diff changeset
   705
     * a <code>ARRAY</code>, <code>BLOB</code>, <code>CLOB</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   706
     * <code>DATALINK</code>, <code>JAVA_OBJECT</code>, <code>NCHAR</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   707
     * <code>NCLOB</code>, <code>NVARCHAR</code>, <code>LONGNVARCHAR</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   708
     *  <code>REF</code>, <code>ROWID</code>, <code>SQLXML</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   709
     * or  <code>STRUCT</code> data type and the JDBC driver does not support
90ce3da70b43 Initial load
duke
parents:
diff changeset
   710
     * this data type or if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   711
     * @since 1.2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   712
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   713
  void setNull (int parameterIndex, int sqlType, String typeName)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   714
    throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   715
90ce3da70b43 Initial load
duke
parents:
diff changeset
   716
    //------------------------- JDBC 3.0 -----------------------------------
90ce3da70b43 Initial load
duke
parents:
diff changeset
   717
90ce3da70b43 Initial load
duke
parents:
diff changeset
   718
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   719
     * Sets the designated parameter to the given <code>java.net.URL</code> value.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   720
     * The driver converts this to an SQL <code>DATALINK</code> value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   721
     * when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   722
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   723
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   724
     * @param x the <code>java.net.URL</code> object to be set
90ce3da70b43 Initial load
duke
parents:
diff changeset
   725
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   726
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   727
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   728
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   729
     * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
   730
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   731
    void setURL(int parameterIndex, java.net.URL x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   732
90ce3da70b43 Initial load
duke
parents:
diff changeset
   733
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   734
     * Retrieves the number, types and properties of this
90ce3da70b43 Initial load
duke
parents:
diff changeset
   735
     * <code>PreparedStatement</code> object's parameters.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   736
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   737
     * @return a <code>ParameterMetaData</code> object that contains information
90ce3da70b43 Initial load
duke
parents:
diff changeset
   738
     *         about the number, types and properties for each
90ce3da70b43 Initial load
duke
parents:
diff changeset
   739
     *  parameter marker of this <code>PreparedStatement</code> object
90ce3da70b43 Initial load
duke
parents:
diff changeset
   740
     * @exception SQLException if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   741
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   742
     * @see ParameterMetaData
90ce3da70b43 Initial load
duke
parents:
diff changeset
   743
     * @since 1.4
90ce3da70b43 Initial load
duke
parents:
diff changeset
   744
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   745
    ParameterMetaData getParameterMetaData() throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   746
90ce3da70b43 Initial load
duke
parents:
diff changeset
   747
    //------------------------- JDBC 4.0 -----------------------------------
90ce3da70b43 Initial load
duke
parents:
diff changeset
   748
90ce3da70b43 Initial load
duke
parents:
diff changeset
   749
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   750
     * Sets the designated parameter to the given <code>java.sql.RowId</code> object. The
90ce3da70b43 Initial load
duke
parents:
diff changeset
   751
     * driver converts this to a SQL <code>ROWID</code> value when it sends it
90ce3da70b43 Initial load
duke
parents:
diff changeset
   752
     * to the database
90ce3da70b43 Initial load
duke
parents:
diff changeset
   753
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   754
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   755
     * @param x the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   756
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   757
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   758
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   759
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   760
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   761
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   762
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   763
    void setRowId(int parameterIndex, RowId x) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   764
90ce3da70b43 Initial load
duke
parents:
diff changeset
   765
90ce3da70b43 Initial load
duke
parents:
diff changeset
   766
    /**
11016
e2665f4ac6d2 7110111: Minor Java SE javadoc & Constructor clean up
lancea
parents: 6540
diff changeset
   767
     * Sets the designated parameter to the given <code>String</code> object.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   768
     * The driver converts this to a SQL <code>NCHAR</code> or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   769
     * <code>NVARCHAR</code> or <code>LONGNVARCHAR</code> value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   770
     * (depending on the argument's
90ce3da70b43 Initial load
duke
parents:
diff changeset
   771
     * size relative to the driver's limits on <code>NVARCHAR</code> values)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   772
     * when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   773
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   774
     * @param parameterIndex of the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   775
     * @param value the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   776
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   777
     * marker in the SQL statement; if the driver does not support national
90ce3da70b43 Initial load
duke
parents:
diff changeset
   778
     *         character sets;  if the driver can detect that a data conversion
90ce3da70b43 Initial load
duke
parents:
diff changeset
   779
     *  error could occur; if a database access error occurs; or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   780
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   781
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   782
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   783
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   784
     void setNString(int parameterIndex, String value) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   785
90ce3da70b43 Initial load
duke
parents:
diff changeset
   786
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   787
     * Sets the designated parameter to a <code>Reader</code> object. The
90ce3da70b43 Initial load
duke
parents:
diff changeset
   788
     * <code>Reader</code> reads the data till end-of-file is reached. The
90ce3da70b43 Initial load
duke
parents:
diff changeset
   789
     * driver does the necessary conversion from Java character format to
90ce3da70b43 Initial load
duke
parents:
diff changeset
   790
     * the national character set in the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   791
     * @param parameterIndex of the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   792
     * @param value the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   793
     * @param length the number of characters in the parameter data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   794
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   795
     * marker in the SQL statement; if the driver does not support national
90ce3da70b43 Initial load
duke
parents:
diff changeset
   796
     *         character sets;  if the driver can detect that a data conversion
90ce3da70b43 Initial load
duke
parents:
diff changeset
   797
     *  error could occur; if a database access error occurs; or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   798
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   799
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   800
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   801
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   802
     void setNCharacterStream(int parameterIndex, Reader value, long length) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   803
90ce3da70b43 Initial load
duke
parents:
diff changeset
   804
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   805
     * Sets the designated parameter to a <code>java.sql.NClob</code> object. The driver converts this to a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   806
     * SQL <code>NCLOB</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   807
     * @param parameterIndex of the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   808
     * @param value the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   809
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   810
     * marker in the SQL statement; if the driver does not support national
90ce3da70b43 Initial load
duke
parents:
diff changeset
   811
     *         character sets;  if the driver can detect that a data conversion
90ce3da70b43 Initial load
duke
parents:
diff changeset
   812
     *  error could occur; if a database access error occurs; or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   813
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   814
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   815
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   816
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   817
     void setNClob(int parameterIndex, NClob value) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   818
90ce3da70b43 Initial load
duke
parents:
diff changeset
   819
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   820
     * Sets the designated parameter to a <code>Reader</code> object.  The reader must contain  the number
90ce3da70b43 Initial load
duke
parents:
diff changeset
   821
     * of characters specified by length otherwise a <code>SQLException</code> will be
90ce3da70b43 Initial load
duke
parents:
diff changeset
   822
     * generated when the <code>PreparedStatement</code> is executed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   823
     *This method differs from the <code>setCharacterStream (int, Reader, int)</code> method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   824
     * because it informs the driver that the parameter value should be sent to
90ce3da70b43 Initial load
duke
parents:
diff changeset
   825
     * the server as a <code>CLOB</code>.  When the <code>setCharacterStream</code> method is used, the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   826
     * driver may have to do extra work to determine whether the parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   827
     * data should be sent to the server as a <code>LONGVARCHAR</code> or a <code>CLOB</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   828
     * @param parameterIndex index of the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   829
     * @param reader An object that contains the data to set the parameter value to.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   830
     * @param length the number of characters in the parameter data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   831
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   832
     * marker in the SQL statement; if a database access error occurs; this method is called on
90ce3da70b43 Initial load
duke
parents:
diff changeset
   833
     * a closed <code>PreparedStatement</code> or if the length specified is less than zero.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   834
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   835
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   836
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   837
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   838
     void setClob(int parameterIndex, Reader reader, long length)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   839
       throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   840
90ce3da70b43 Initial load
duke
parents:
diff changeset
   841
    /**
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 23590
diff changeset
   842
     * Sets the designated parameter to a <code>InputStream</code> object.
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 23590
diff changeset
   843
     * The {@code Inputstream} must contain  the number
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   844
     * of characters specified by length otherwise a <code>SQLException</code> will be
90ce3da70b43 Initial load
duke
parents:
diff changeset
   845
     * generated when the <code>PreparedStatement</code> is executed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   846
     * This method differs from the <code>setBinaryStream (int, InputStream, int)</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   847
     * method because it informs the driver that the parameter value should be
90ce3da70b43 Initial load
duke
parents:
diff changeset
   848
     * sent to the server as a <code>BLOB</code>.  When the <code>setBinaryStream</code> method is used,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   849
     * the driver may have to do extra work to determine whether the parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   850
     * data should be sent to the server as a <code>LONGVARBINARY</code> or a <code>BLOB</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   851
     * @param parameterIndex index of the first parameter is 1,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   852
     * the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   853
     * @param inputStream An object that contains the data to set the parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   854
     * value to.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   855
     * @param length the number of bytes in the parameter data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   856
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   857
     * marker in the SQL statement; if a database access error occurs;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   858
     * this method is called on a closed <code>PreparedStatement</code>;
25976
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 23590
diff changeset
   859
     * if the length specified
4de01a56e3ee 8054555: javadoc cleanup for java.sql and javax.sql
lancea
parents: 23590
diff changeset
   860
     * is less than zero or if the number of bytes in the {@code InputStream} does not match
21278
ef8a3a2a72f2 8022746: List of spelling errors in API doc
malenkov
parents: 19849
diff changeset
   861
     * the specified length.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   862
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   863
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   864
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   865
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   866
     void setBlob(int parameterIndex, InputStream inputStream, long length)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   867
        throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   868
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   869
     * Sets the designated parameter to a <code>Reader</code> object.  The reader must contain  the number
90ce3da70b43 Initial load
duke
parents:
diff changeset
   870
     * of characters specified by length otherwise a <code>SQLException</code> will be
90ce3da70b43 Initial load
duke
parents:
diff changeset
   871
     * generated when the <code>PreparedStatement</code> is executed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   872
     * This method differs from the <code>setCharacterStream (int, Reader, int)</code> method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   873
     * because it informs the driver that the parameter value should be sent to
90ce3da70b43 Initial load
duke
parents:
diff changeset
   874
     * the server as a <code>NCLOB</code>.  When the <code>setCharacterStream</code> method is used, the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   875
     * driver may have to do extra work to determine whether the parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   876
     * data should be sent to the server as a <code>LONGNVARCHAR</code> or a <code>NCLOB</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   877
     * @param parameterIndex index of the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   878
     * @param reader An object that contains the data to set the parameter value to.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   879
     * @param length the number of characters in the parameter data.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   880
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   881
     * marker in the SQL statement; if the length specified is less than zero;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   882
     * if the driver does not support national character sets;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   883
     * if the driver can detect that a data conversion
90ce3da70b43 Initial load
duke
parents:
diff changeset
   884
     *  error could occur;  if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   885
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   886
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   887
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   888
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   889
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   890
     void setNClob(int parameterIndex, Reader reader, long length)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   891
       throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   892
90ce3da70b43 Initial load
duke
parents:
diff changeset
   893
     /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   894
      * Sets the designated parameter to the given <code>java.sql.SQLXML</code> object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   895
      * The driver converts this to an
90ce3da70b43 Initial load
duke
parents:
diff changeset
   896
      * SQL <code>XML</code> value when it sends it to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   897
      *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   898
      * @param parameterIndex index of the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   899
      * @param xmlObject a <code>SQLXML</code> object that maps an SQL <code>XML</code> value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   900
      * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   901
     * marker in the SQL statement; if a database access error occurs;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   902
      *  this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   903
      * or the <code>java.xml.transform.Result</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   904
      *  <code>Writer</code> or <code>OutputStream</code> has not been closed for
90ce3da70b43 Initial load
duke
parents:
diff changeset
   905
      * the <code>SQLXML</code> object
90ce3da70b43 Initial load
duke
parents:
diff changeset
   906
      * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
   907
      *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   908
      * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   909
      */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   910
     void setSQLXML(int parameterIndex, SQLXML xmlObject) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   911
90ce3da70b43 Initial load
duke
parents:
diff changeset
   912
    /**
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
   913
     * <p>Sets the value of the designated parameter with the given object.
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   914
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   915
     * If the second argument is an <code>InputStream</code> then the stream must contain
90ce3da70b43 Initial load
duke
parents:
diff changeset
   916
     * the number of bytes specified by scaleOrLength.  If the second argument is a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   917
     * <code>Reader</code> then the reader must contain the number of characters specified
90ce3da70b43 Initial load
duke
parents:
diff changeset
   918
     * by scaleOrLength. If these conditions are not true the driver will generate a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   919
     * <code>SQLException</code> when the prepared statement is executed.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   920
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   921
     * <p>The given Java object will be converted to the given targetSqlType
90ce3da70b43 Initial load
duke
parents:
diff changeset
   922
     * before being sent to the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   923
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   924
     * If the object has a custom mapping (is of a class implementing the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   925
     * interface <code>SQLData</code>),
90ce3da70b43 Initial load
duke
parents:
diff changeset
   926
     * the JDBC driver should call the method <code>SQLData.writeSQL</code> to
90ce3da70b43 Initial load
duke
parents:
diff changeset
   927
     * write it to the SQL data stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   928
     * If, on the other hand, the object is of a class implementing
90ce3da70b43 Initial load
duke
parents:
diff changeset
   929
     * <code>Ref</code>, <code>Blob</code>, <code>Clob</code>,  <code>NClob</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   930
     *  <code>Struct</code>, <code>java.net.URL</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   931
     * or <code>Array</code>, the driver should pass it to the database as a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   932
     * value of the corresponding SQL type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   933
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   934
     * <p>Note that this method may be used to pass database-specific
90ce3da70b43 Initial load
duke
parents:
diff changeset
   935
     * abstract data types.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   936
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   937
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   938
     * @param x the object containing the input parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   939
     * @param targetSqlType the SQL type (as defined in java.sql.Types) to be
90ce3da70b43 Initial load
duke
parents:
diff changeset
   940
     * sent to the database. The scale argument may further qualify this type.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   941
     * @param scaleOrLength for <code>java.sql.Types.DECIMAL</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   942
     *          or <code>java.sql.Types.NUMERIC types</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   943
     *          this is the number of digits after the decimal point. For
90ce3da70b43 Initial load
duke
parents:
diff changeset
   944
     *          Java Object types <code>InputStream</code> and <code>Reader</code>,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   945
     *          this is the length
90ce3da70b43 Initial load
duke
parents:
diff changeset
   946
     *          of the data in the stream or reader.  For all other types,
90ce3da70b43 Initial load
duke
parents:
diff changeset
   947
     *          this value will be ignored.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   948
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   949
     * marker in the SQL statement; if a database access error occurs;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   950
     * this method is called on a closed <code>PreparedStatement</code> or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   951
     *            if the Java Object specified by x is an InputStream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   952
     *            or Reader object and the value of the scale parameter is less
90ce3da70b43 Initial load
duke
parents:
diff changeset
   953
     *            than zero
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
   954
     * @exception SQLFeatureNotSupportedException if
21950
db3c826749f7 8029417: JDBC 4.2 javadoc updates
lancea
parents: 21278
diff changeset
   955
     * the JDBC driver does not support the specified targetSqlType
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
   956
     * @see Types
90ce3da70b43 Initial load
duke
parents:
diff changeset
   957
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   958
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   959
    void setObject(int parameterIndex, Object x, int targetSqlType, int scaleOrLength)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   960
            throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   961
   /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   962
     * Sets the designated parameter to the given input stream, which will have
90ce3da70b43 Initial load
duke
parents:
diff changeset
   963
     * the specified number of bytes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   964
     * When a very large ASCII value is input to a <code>LONGVARCHAR</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   965
     * parameter, it may be more practical to send it via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   966
     * <code>java.io.InputStream</code>. Data will be read from the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   967
     * as needed until end-of-file is reached.  The JDBC driver will
90ce3da70b43 Initial load
duke
parents:
diff changeset
   968
     * do any necessary conversion from ASCII to the database char format.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   969
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   970
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
   971
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   972
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   973
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   974
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   975
     * @param x the Java input stream that contains the ASCII parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   976
     * @param length the number of bytes in the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   977
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
   978
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
   979
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   980
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
   981
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
   982
    void setAsciiStream(int parameterIndex, java.io.InputStream x, long length)
90ce3da70b43 Initial load
duke
parents:
diff changeset
   983
            throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
   984
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
   985
     * Sets the designated parameter to the given input stream, which will have
90ce3da70b43 Initial load
duke
parents:
diff changeset
   986
     * the specified number of bytes.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   987
     * When a very large binary value is input to a <code>LONGVARBINARY</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
   988
     * parameter, it may be more practical to send it via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
   989
     * <code>java.io.InputStream</code> object. The data will be read from the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   990
     * stream as needed until end-of-file is reached.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   991
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   992
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
   993
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
   994
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
   995
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
   996
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
   997
     * @param x the java input stream which contains the binary parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
   998
     * @param length the number of bytes in the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
   999
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1000
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1001
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1002
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1003
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1004
    void setBinaryStream(int parameterIndex, java.io.InputStream x,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1005
                         long length) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1006
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1007
     * Sets the designated parameter to the given <code>Reader</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1008
     * object, which is the given number of characters long.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1009
     * When a very large UNICODE value is input to a <code>LONGVARCHAR</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1010
     * parameter, it may be more practical to send it via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1011
     * <code>java.io.Reader</code> object. The data will be read from the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1012
     * as needed until end-of-file is reached.  The JDBC driver will
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1013
     * do any necessary conversion from UNICODE to the database char format.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1014
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1015
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1016
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1017
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1018
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1019
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1020
     * @param reader the <code>java.io.Reader</code> object that contains the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1021
     *        Unicode data
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1022
     * @param length the number of characters in the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1023
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1024
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1025
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1026
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1027
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1028
    void setCharacterStream(int parameterIndex,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1029
                          java.io.Reader reader,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1030
                          long length) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1031
    //-----
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1032
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1033
     * Sets the designated parameter to the given input stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1034
     * When a very large ASCII value is input to a <code>LONGVARCHAR</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1035
     * parameter, it may be more practical to send it via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1036
     * <code>java.io.InputStream</code>. Data will be read from the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1037
     * as needed until end-of-file is reached.  The JDBC driver will
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1038
     * do any necessary conversion from ASCII to the database char format.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1039
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1040
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1041
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1042
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1043
     * <P><B>Note:</B> Consult your JDBC driver documentation to determine if
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1044
     * it might be more efficient to use a version of
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1045
     * <code>setAsciiStream</code> which takes a length parameter.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1046
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1047
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1048
     * @param x the Java input stream that contains the ASCII parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1049
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1050
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1051
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1052
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1053
       * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1054
    */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1055
    void setAsciiStream(int parameterIndex, java.io.InputStream x)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1056
            throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1057
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1058
     * Sets the designated parameter to the given input stream.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1059
     * When a very large binary value is input to a <code>LONGVARBINARY</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1060
     * parameter, it may be more practical to send it via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1061
     * <code>java.io.InputStream</code> object. The data will be read from the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1062
     * stream as needed until end-of-file is reached.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1063
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1064
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1065
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1066
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1067
     * <P><B>Note:</B> Consult your JDBC driver documentation to determine if
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1068
     * it might be more efficient to use a version of
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1069
     * <code>setBinaryStream</code> which takes a length parameter.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1070
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1071
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1072
     * @param x the java input stream which contains the binary parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1073
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1074
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1075
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1076
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1077
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1078
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1079
    void setBinaryStream(int parameterIndex, java.io.InputStream x)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1080
    throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1081
        /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1082
     * Sets the designated parameter to the given <code>Reader</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1083
     * object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1084
     * When a very large UNICODE value is input to a <code>LONGVARCHAR</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1085
     * parameter, it may be more practical to send it via a
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1086
     * <code>java.io.Reader</code> object. The data will be read from the stream
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1087
     * as needed until end-of-file is reached.  The JDBC driver will
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1088
     * do any necessary conversion from UNICODE to the database char format.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1089
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1090
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1091
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1092
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1093
     * <P><B>Note:</B> Consult your JDBC driver documentation to determine if
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1094
     * it might be more efficient to use a version of
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1095
     * <code>setCharacterStream</code> which takes a length parameter.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1096
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1097
     * @param parameterIndex the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1098
     * @param reader the <code>java.io.Reader</code> object that contains the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1099
     *        Unicode data
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1100
     * @exception SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1101
     * marker in the SQL statement; if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1102
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1103
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1104
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1105
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1106
    void setCharacterStream(int parameterIndex,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1107
                          java.io.Reader reader) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1108
  /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1109
     * Sets the designated parameter to a <code>Reader</code> object. The
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1110
     * <code>Reader</code> reads the data till end-of-file is reached. The
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1111
     * driver does the necessary conversion from Java character format to
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1112
     * the national character set in the database.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1113
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1114
     * <P><B>Note:</B> This stream object can either be a standard
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1115
     * Java stream object or your own subclass that implements the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1116
     * standard interface.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1117
     * <P><B>Note:</B> Consult your JDBC driver documentation to determine if
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1118
     * it might be more efficient to use a version of
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1119
     * <code>setNCharacterStream</code> which takes a length parameter.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1120
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1121
     * @param parameterIndex of the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1122
     * @param value the parameter value
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1123
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1124
     * marker in the SQL statement; if the driver does not support national
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1125
     *         character sets;  if the driver can detect that a data conversion
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1126
     *  error could occur; if a database access error occurs; or
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1127
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1128
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1129
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1130
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1131
     void setNCharacterStream(int parameterIndex, Reader value) throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1132
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1133
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1134
     * Sets the designated parameter to a <code>Reader</code> object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1135
     * This method differs from the <code>setCharacterStream (int, Reader)</code> method
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1136
     * because it informs the driver that the parameter value should be sent to
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1137
     * the server as a <code>CLOB</code>.  When the <code>setCharacterStream</code> method is used, the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1138
     * driver may have to do extra work to determine whether the parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1139
     * data should be sent to the server as a <code>LONGVARCHAR</code> or a <code>CLOB</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1140
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1141
     * <P><B>Note:</B> Consult your JDBC driver documentation to determine if
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1142
     * it might be more efficient to use a version of
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1143
     * <code>setClob</code> which takes a length parameter.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1144
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1145
     * @param parameterIndex index of the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1146
     * @param reader An object that contains the data to set the parameter value to.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1147
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1148
     * marker in the SQL statement; if a database access error occurs; this method is called on
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1149
     * a closed <code>PreparedStatement</code>or if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1150
     * marker in the SQL statement
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1151
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1152
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1153
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1154
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1155
     void setClob(int parameterIndex, Reader reader)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1156
       throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1157
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1158
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1159
     * Sets the designated parameter to a <code>InputStream</code> object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1160
     * This method differs from the <code>setBinaryStream (int, InputStream)</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1161
     * method because it informs the driver that the parameter value should be
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1162
     * sent to the server as a <code>BLOB</code>.  When the <code>setBinaryStream</code> method is used,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1163
     * the driver may have to do extra work to determine whether the parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1164
     * data should be sent to the server as a <code>LONGVARBINARY</code> or a <code>BLOB</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1165
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1166
     * <P><B>Note:</B> Consult your JDBC driver documentation to determine if
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1167
     * it might be more efficient to use a version of
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1168
     * <code>setBlob</code> which takes a length parameter.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1169
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1170
     * @param parameterIndex index of the first parameter is 1,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1171
     * the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1172
     * @param inputStream An object that contains the data to set the parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1173
     * value to.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1174
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1175
     * marker in the SQL statement; if a database access error occurs;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1176
     * this method is called on a closed <code>PreparedStatement</code> or
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1177
     * if parameterIndex does not correspond
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1178
     * to a parameter marker in the SQL statement,
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1179
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1180
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1181
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1182
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1183
     void setBlob(int parameterIndex, InputStream inputStream)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1184
        throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1185
    /**
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1186
     * Sets the designated parameter to a <code>Reader</code> object.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1187
     * This method differs from the <code>setCharacterStream (int, Reader)</code> method
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1188
     * because it informs the driver that the parameter value should be sent to
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1189
     * the server as a <code>NCLOB</code>.  When the <code>setCharacterStream</code> method is used, the
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1190
     * driver may have to do extra work to determine whether the parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1191
     * data should be sent to the server as a <code>LONGNVARCHAR</code> or a <code>NCLOB</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1192
     * <P><B>Note:</B> Consult your JDBC driver documentation to determine if
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1193
     * it might be more efficient to use a version of
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1194
     * <code>setNClob</code> which takes a length parameter.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1195
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1196
     * @param parameterIndex index of the first parameter is 1, the second is 2, ...
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1197
     * @param reader An object that contains the data to set the parameter value to.
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1198
     * @throws SQLException if parameterIndex does not correspond to a parameter
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1199
     * marker in the SQL statement;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1200
     * if the driver does not support national character sets;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1201
     * if the driver can detect that a data conversion
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1202
     *  error could occur;  if a database access error occurs or
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1203
     * this method is called on a closed <code>PreparedStatement</code>
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1204
     * @throws SQLFeatureNotSupportedException  if the JDBC driver does not support this method
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1205
     *
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1206
     * @since 1.6
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1207
     */
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1208
     void setNClob(int parameterIndex, Reader reader)
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1209
       throws SQLException;
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1210
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1211
    //------------------------- JDBC 4.2 -----------------------------------
6540
a4ae668f6125 6589685: JDBC 4.1 updates
lancea
parents: 5506
diff changeset
  1212
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1213
    /**
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1214
     * <p>Sets the value of the designated parameter with the given object.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1215
     *
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1216
     * If the second argument is an {@code InputStream} then the stream
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1217
     * must contain the number of bytes specified by scaleOrLength.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1218
     * If the second argument is a {@code Reader} then the reader must
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1219
     * contain the number of characters specified by scaleOrLength. If these
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1220
     * conditions are not true the driver will generate a
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1221
     * {@code SQLException} when the prepared statement is executed.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1222
     *
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1223
     * <p>The given Java object will be converted to the given targetSqlType
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1224
     * before being sent to the database.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1225
     *
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1226
     * If the object has a custom mapping (is of a class implementing the
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1227
     * interface {@code SQLData}),
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1228
     * the JDBC driver should call the method {@code SQLData.writeSQL} to
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1229
     * write it to the SQL data stream.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1230
     * If, on the other hand, the object is of a class implementing
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1231
     * {@code Ref}, {@code Blob}, {@code Clob},  {@code NClob},
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1232
     *  {@code Struct}, {@code java.net.URL},
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1233
     * or {@code Array}, the driver should pass it to the database as a
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1234
     * value of the corresponding SQL type.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1235
     *
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1236
     * <p>Note that this method may be used to pass database-specific
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1237
     * abstract data types.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1238
     *<P>
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1239
     * The default implementation will throw {@code SQLFeatureNotSupportedException}
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1240
     *
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1241
     * @param parameterIndex the first parameter is 1, the second is 2, ...
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1242
     * @param x the object containing the input parameter value
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1243
     * @param targetSqlType the SQL type to be sent to the database. The
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1244
     * scale argument may further qualify this type.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1245
     * @param scaleOrLength for {@code java.sql.JDBCType.DECIMAL}
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1246
     *          or {@code java.sql.JDBCType.NUMERIC types},
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1247
     *          this is the number of digits after the decimal point. For
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1248
     *          Java Object types {@code InputStream} and {@code Reader},
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1249
     *          this is the length
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1250
     *          of the data in the stream or reader.  For all other types,
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1251
     *          this value will be ignored.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1252
     * @exception SQLException if parameterIndex does not correspond to a
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1253
     * parameter marker in the SQL statement; if a database access error occurs
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1254
     * or this method is called on a closed {@code PreparedStatement}  or
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1255
     *            if the Java Object specified by x is an InputStream
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1256
     *            or Reader object and the value of the scale parameter is less
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1257
     *            than zero
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1258
     * @exception SQLFeatureNotSupportedException if
21950
db3c826749f7 8029417: JDBC 4.2 javadoc updates
lancea
parents: 21278
diff changeset
  1259
     * the JDBC driver does not support the specified targetSqlType
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1260
     * @see JDBCType
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1261
     * @see SQLType
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1262
     * @since 1.8
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1263
     */
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1264
    default void setObject(int parameterIndex, Object x, SQLType targetSqlType,
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1265
             int scaleOrLength) throws SQLException {
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1266
        throw new SQLFeatureNotSupportedException("setObject not implemented");
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1267
    }
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1268
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1269
    /**
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1270
     * Sets the value of the designated parameter with the given object.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1271
     *
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1272
     * This method is similar to {@link #setObject(int parameterIndex,
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1273
     * Object x, SQLType targetSqlType, int scaleOrLength)},
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1274
     * except that it assumes a scale of zero.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1275
     *<P>
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1276
     * The default implementation will throw {@code SQLFeatureNotSupportedException}
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1277
     *
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1278
     * @param parameterIndex the first parameter is 1, the second is 2, ...
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1279
     * @param x the object containing the input parameter value
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1280
     * @param targetSqlType the SQL type to be sent to the database
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1281
     * @exception SQLException if parameterIndex does not correspond to a
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1282
     * parameter marker in the SQL statement; if a database access error occurs
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1283
     * or this method is called on a closed {@code PreparedStatement}
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1284
     * @exception SQLFeatureNotSupportedException if
21950
db3c826749f7 8029417: JDBC 4.2 javadoc updates
lancea
parents: 21278
diff changeset
  1285
     * the JDBC driver does not support the specified targetSqlType
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1286
     * @see JDBCType
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1287
     * @see SQLType
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1288
     * @since 1.8
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1289
     */
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1290
    default void setObject(int parameterIndex, Object x, SQLType targetSqlType)
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1291
      throws SQLException {
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1292
        throw new SQLFeatureNotSupportedException("setObject not implemented");
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1293
    }
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1294
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1295
    /**
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1296
     * Executes the SQL statement in this <code>PreparedStatement</code> object,
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1297
     * which must be an SQL Data Manipulation Language (DML) statement,
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1298
     * such as <code>INSERT</code>, <code>UPDATE</code> or
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1299
     * <code>DELETE</code>; or an SQL statement that returns nothing,
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1300
     * such as a DDL statement.
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1301
     * <p>
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1302
     * This method should be used when the returned row count may exceed
15284
aa4ba8514e3d 8006642: Fix javadoc warnings due to Integer.MAX_VALUE
lancea
parents: 15278
diff changeset
  1303
     * {@link Integer#MAX_VALUE}.
15278
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1304
     * <p>
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1305
     * The default implementation will throw {@code UnsupportedOperationException}
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1306
     *
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1307
     * @return either (1) the row count for SQL Data Manipulation Language
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1308
     * (DML) statements or (2) 0 for SQL statements that return nothing
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1309
     * @exception SQLException if a database access error occurs;
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1310
     * this method is called on a closed  <code>PreparedStatement</code>
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1311
     * or the SQL statement returns a <code>ResultSet</code> object
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1312
     * @throws SQLTimeoutException when the driver has determined that the
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1313
     * timeout value that was specified by the {@code setQueryTimeout}
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1314
     * method has been exceeded and has at least attempted to cancel
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1315
     * the currently running {@code Statement}
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1316
     * @since 1.8
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1317
     */
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1318
    default long executeLargeUpdate() throws SQLException {
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1319
        throw new UnsupportedOperationException("executeLargeUpdate not implemented");
e081d3f73b75 8005080: JDBC 4.2 Core changes
lancea
parents: 14342
diff changeset
  1320
    }
2
90ce3da70b43 Initial load
duke
parents:
diff changeset
  1321
}