PreparedStatement.java

/*
 * Copyright (c) 1996, 2020, Oracle and/or its affiliates. All rights reserved.
 * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
 *
 * This code is free software; you can redistribute it and/or modify it
 * under the terms of the GNU General Public License version 2 only, as
 * published by the Free Software Foundation. Oracle designates this
 * particular file as subject to the "Classpath" exception as provided
 * by Oracle in the LICENSE file that accompanied this code.
 *
 * This code is distributed in the hope that it will be useful, but WITHOUT
 * ANY WARRANTY; without even the implied warranty of MERCHANTABILITY or
 * FITNESS FOR A PARTICULAR PURPOSE. See the GNU General Public License
 * version 2 for more details (a copy is included in the LICENSE file that
 * accompanied this code).
 *
 * You should have received a copy of the GNU General Public License version
 * 2 along with this work; if not, write to the Free Software Foundation,
 * Inc., 51 Franklin St, Fifth Floor, Boston, MA 02110-1301 USA.
 *
 * Please contact Oracle, 500 Oracle Parkway, Redwood Shores, CA 94065 USA
 * or visit www.oracle.com if you need additional information or have any
 * questions.
 */

packagejava.sql;

importjava.math.BigDecimal;
importjava.util.Calendar;
importjava.io.Reader;
importjava.io.InputStream;

/**
 * An object that represents a precompiled SQL statement.
 * <P>A SQL statement is precompiled and stored in a
 * {@code PreparedStatement} object. This object can then be used to
 * efficiently execute this statement multiple times.
 *
 * <P><B>Note:</B> The setter methods ({@code setShort}, {@code setString},
 * and so on) for setting IN parameter values
 * must specify types that are compatible with the defined SQL type of
 * the input parameter. For instance, if the IN parameter has SQL type
 * {@code INTEGER}, then the method {@code setInt} should be used.
 *
 * <p>If arbitrary parameter type conversions are required, the method
 * {@code setObject} should be used with a target SQL type.
 * <P>
 * In the following example of setting a parameter, {@code con} represents
 * an active connection:
 * <pre>{@code
 * BigDecimal sal = new BigDecimal("153833.00");
 * PreparedStatement pstmt = con.prepareStatement("UPDATE EMPLOYEES
 * SET SALARY = ? WHERE ID = ?");
 * pstmt.setBigDecimal(1, sal);
 * pstmt.setInt(2, 110592);
 * }</pre>
 *
 * @see Connection#prepareStatement
 * @see ResultSet
 * @since 1.1
 */

publicinterfacePreparedStatementextendsStatement {

/**
 * Executes the SQL query in this {@code PreparedStatement} object
 * and returns the {@code ResultSet} object generated by the query.
 *
 * @return a {@code ResultSet} object that contains the data produced by the
 * query; never {@code null}
 * @throws SQLException if a database access error occurs;
 * this method is called on a closed {@code PreparedStatement} or the SQL
 * statement does not return a {@code ResultSet} object
 * @throws SQLTimeoutException when the driver has determined that the
 * timeout value that was specified by the {@code setQueryTimeout}
 * method has been exceeded and has at least attempted to cancel
 * the currently running {@code Statement}
 */
ResultSetexecuteQuery() throwsSQLException;

/**
 * Executes the SQL statement in this {@code PreparedStatement} object,
 * which must be an SQL Data Manipulation Language (DML) statement, such as {@code INSERT}, {@code UPDATE} or
 * {@code DELETE}; or an SQL statement that returns nothing,
 * such as a DDL statement.
 *
 * @return either (1) the row count for SQL Data Manipulation Language (DML) statements
 * or (2) 0 for SQL statements that return nothing
 * @throws SQLException if a database access error occurs;
 * this method is called on a closed {@code PreparedStatement}
 * or the SQL statement returns a {@code ResultSet} object
 * @throws SQLTimeoutException when the driver has determined that the
 * timeout value that was specified by the {@code setQueryTimeout}
 * method has been exceeded and has at least attempted to cancel
 * the currently running {@code Statement}
 */
intexecuteUpdate() throwsSQLException;

/**
 * Sets the designated parameter to SQL {@code NULL}.
 *
 * <P><B>Note:</B> You must specify the parameter's SQL type.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param sqlType the SQL type code defined in {@code java.sql.Types}
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if {@code sqlType} is
 * a {@code ARRAY}, {@code BLOB}, {@code CLOB},
 * {@code DATALINK}, {@code JAVA_OBJECT}, {@code NCHAR},
 * {@code NCLOB}, {@code NVARCHAR}, {@code LONGNVARCHAR},
 * {@code REF}, {@code ROWID}, {@code SQLXML}
 * or {@code STRUCT} data type and the JDBC driver does not support
 * this data type
 */
voidsetNull(intparameterIndex, intsqlType) throwsSQLException;

/**
 * Sets the designated parameter to the given Java {@code boolean} value.
 * The driver converts this
 * to an SQL {@code BIT} or {@code BOOLEAN} value when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement;
 * if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetBoolean(intparameterIndex, booleanx) throwsSQLException;

/**
 * Sets the designated parameter to the given Java {@code byte} value.
 * The driver converts this
 * to an SQL {@code TINYINT} value when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetByte(intparameterIndex, bytex) throwsSQLException;

/**
 * Sets the designated parameter to the given Java {@code short} value.
 * The driver converts this
 * to an SQL {@code SMALLINT} value when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetShort(intparameterIndex, shortx) throwsSQLException;

/**
 * Sets the designated parameter to the given Java {@code int} value.
 * The driver converts this
 * to an SQL {@code INTEGER} value when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetInt(intparameterIndex, intx) throwsSQLException;

/**
 * Sets the designated parameter to the given Java {@code long} value.
 * The driver converts this
 * to an SQL {@code BIGINT} value when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetLong(intparameterIndex, longx) throwsSQLException;

/**
 * Sets the designated parameter to the given Java {@code float} value.
 * The driver converts this
 * to an SQL {@code REAL} value when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetFloat(intparameterIndex, floatx) throwsSQLException;

/**
 * Sets the designated parameter to the given Java {@code double} value.
 * The driver converts this
 * to an SQL {@code DOUBLE} value when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetDouble(intparameterIndex, doublex) throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.math.BigDecimal} value.
 * The driver converts this to an SQL {@code NUMERIC} value when
 * it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetBigDecimal(intparameterIndex, BigDecimalx) throwsSQLException;

/**
 * Sets the designated parameter to the given Java {@code String} value.
 * The driver converts this
 * to an SQL {@code VARCHAR} or {@code LONGVARCHAR} value
 * (depending on the argument's
 * size relative to the driver's limits on {@code VARCHAR} values)
 * when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetString(intparameterIndex, Stringx) throwsSQLException;

/**
 * Sets the designated parameter to the given Java array of bytes. The driver converts
 * this to an SQL {@code VARBINARY} or {@code LONGVARBINARY}
 * (depending on the argument's size relative to the driver's limits on
 * {@code VARBINARY} values) when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetBytes(intparameterIndex, bytex[]) throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.sql.Date} value
 * using the default time zone of the virtual machine that is running
 * the application.
 * The driver converts this
 * to an SQL {@code DATE} value when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetDate(intparameterIndex, java.sql.Datex)
throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.sql.Time} value.
 * The driver converts this
 * to an SQL {@code TIME} value when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetTime(intparameterIndex, java.sql.Timex)
throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.sql.Timestamp} value.
 * The driver
 * converts this to an SQL {@code TIMESTAMP} value when it sends it to the
 * database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement} */
voidsetTimestamp(intparameterIndex, java.sql.Timestampx)
throwsSQLException;

/**
 * Sets the designated parameter to the given input stream, which will have
 * the specified number of bytes.
 * When a very large ASCII value is input to a {@code LONGVARCHAR}
 * parameter, it may be more practical to send it via a
 * {@code java.io.InputStream}. Data will be read from the stream
 * as needed until end-of-file is reached. The JDBC driver will
 * do any necessary conversion from ASCII to the database char format.
 *
 * <P><B>Note:</B> This stream object can either be a standard
 * Java stream object or your own subclass that implements the
 * standard interface.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the Java input stream that contains the ASCII parameter value
 * @param length the number of bytes in the stream
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetAsciiStream(intparameterIndex, java.io.InputStreamx, intlength)
throwsSQLException;

/**
 * Sets the designated parameter to the given input stream, which
 * will have the specified number of bytes.
 *
 * When a very large Unicode value is input to a {@code LONGVARCHAR}
 * parameter, it may be more practical to send it via a
 * {@code java.io.InputStream} object. The data will be read from the
 * stream as needed until end-of-file is reached. The JDBC driver will
 * do any necessary conversion from Unicode to the database char format.
 *
 *The byte format of the Unicode stream must be a Java UTF-8, as defined in the
 *Java Virtual Machine Specification.
 *
 * <P><B>Note:</B> This stream object can either be a standard
 * Java stream object or your own subclass that implements the
 * standard interface.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x a {@code java.io.InputStream} object that contains the
 * Unicode parameter value
 * @param length the number of bytes in the stream
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support
 * this method
 * @deprecated Use {@code setCharacterStream}
 */
@Deprecated(since="1.2")
voidsetUnicodeStream(intparameterIndex, java.io.InputStreamx,
intlength) throwsSQLException;

/**
 * Sets the designated parameter to the given input stream, which will have
 * the specified number of bytes.
 * When a very large binary value is input to a {@code LONGVARBINARY}
 * parameter, it may be more practical to send it via a
 * {@code java.io.InputStream} object. The data will be read from the
 * stream as needed until end-of-file is reached.
 *
 * <P><B>Note:</B> This stream object can either be a standard
 * Java stream object or your own subclass that implements the
 * standard interface.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the java input stream which contains the binary parameter value
 * @param length the number of bytes in the stream
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidsetBinaryStream(intparameterIndex, java.io.InputStreamx,
intlength) throwsSQLException;

/**
 * Clears the current parameter values immediately.
 * <P>In general, parameter values remain in force for repeated use of a
 * statement. Setting a parameter value automatically clears its
 * previous value. However, in some cases it is useful to immediately
 * release the resources used by the current parameter values; this can
 * be done by calling the method {@code clearParameters}.
 *
 * @throws SQLException if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 */
voidclearParameters() throwsSQLException;

//----------------------------------------------------------------------
// Advanced features:

/**
 * Sets the value of the designated parameter with the given object.
 *
 * This method is similar to {@link #setObject(int parameterIndex,
 * Object x, int targetSqlType, int scaleOrLength)},
 * except that it assumes a scale of zero.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the object containing the input parameter value
 * @param targetSqlType the SQL type (as defined in java.sql.Types) to be
 * sent to the database
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or this
 * method is called on a closed PreparedStatement
 * @throws SQLFeatureNotSupportedException if
 * the JDBC driver does not support the specified targetSqlType
 * @see Types
 */
voidsetObject(intparameterIndex, Objectx, inttargetSqlType)
throwsSQLException;

/**
 * <p>Sets the value of the designated parameter using the given object.
 *
 * <p>The JDBC specification specifies a standard mapping from
 * Java {@code Object} types to SQL types. The given argument
 * will be converted to the corresponding SQL type before being
 * sent to the database.
 *
 * <p>Note that this method may be used to pass database-
 * specific abstract data types, by using a driver-specific Java
 * type.
 *
 * If the object is of a class implementing the interface {@code SQLData},
 * the JDBC driver should call the method {@code SQLData.writeSQL}
 * to write it to the SQL data stream.
 * If, on the other hand, the object is of a class implementing
 * {@code Ref}, {@code Blob}, {@code Clob}, {@code NClob},
 * {@code Struct}, {@code java.net.URL}, {@code RowId}, {@code SQLXML}
 * or {@code Array}, the driver should pass it to the database as a
 * value of the corresponding SQL type.
 * <P>
 *<b>Note:</b> Not all databases allow for a non-typed Null to be sent to
 * the backend. For maximum portability, the {@code setNull} or the
 * {@code setObject(int parameterIndex, Object x, int sqlType)}
 * method should be used
 * instead of {@code setObject(int parameterIndex, Object x)}.
 *<p>
 * <b>Note:</b> This method throws an exception if there is an ambiguity, for example, if the
 * object is of a class implementing more than one of the interfaces named above.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the object containing the input parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs;
 * this method is called on a closed {@code PreparedStatement}
 * or the type of the given object is ambiguous
 */
voidsetObject(intparameterIndex, Objectx) throwsSQLException;

/**
 * Executes the SQL statement in this {@code PreparedStatement} object,
 * which may be any kind of SQL statement.
 * Some prepared statements return multiple results; the {@code execute}
 * method handles these complex statements as well as the simpler
 * form of statements handled by the methods {@code executeQuery}
 * and {@code executeUpdate}.
 * <P>
 * The {@code execute} method returns a {@code boolean} to
 * indicate the form of the first result. You must call either the method
 * {@code getResultSet} or {@code getUpdateCount}
 * to retrieve the result; you must call {@code getMoreResults} to
 * move to any subsequent result(s).
 *
 * @return {@code true} if the first result is a {@code ResultSet}
 * object; {@code false} if the first result is an update
 * count or there is no result
 * @throws SQLException if a database access error occurs;
 * this method is called on a closed {@code PreparedStatement}
 * or an argument is supplied to this method
 * @throws SQLTimeoutException when the driver has determined that the
 * timeout value that was specified by the {@code setQueryTimeout}
 * method has been exceeded and has at least attempted to cancel
 * the currently running {@code Statement}
 * @see Statement#execute
 * @see Statement#getResultSet
 * @see Statement#getUpdateCount
 * @see Statement#getMoreResults

 */
booleanexecute() throwsSQLException;

//--------------------------JDBC 2.0-----------------------------

/**
 * Adds a set of parameters to this {@code PreparedStatement}
 * object's batch of commands.
 *
 * @throws SQLException if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @see Statement#addBatch
 * @since 1.2
 */
voidaddBatch() throwsSQLException;

/**
 * Sets the designated parameter to the given {@code Reader}
 * object, which is the given number of characters long.
 * When a very large UNICODE value is input to a {@code LONGVARCHAR}
 * parameter, it may be more practical to send it via a
 * {@code java.io.Reader} object. The data will be read from the stream
 * as needed until end-of-file is reached. The JDBC driver will
 * do any necessary conversion from UNICODE to the database char format.
 *
 * <P><B>Note:</B> This stream object can either be a standard
 * Java stream object or your own subclass that implements the
 * standard interface.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param reader the {@code java.io.Reader} object that contains the
 * Unicode data
 * @param length the number of characters in the stream
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @since 1.2
 */
voidsetCharacterStream(intparameterIndex,
java.io.Readerreader,
intlength) throwsSQLException;

/**
 * Sets the designated parameter to the given
 * {@code REF(<structured-type>)} value.
 * The driver converts this to an SQL {@code REF} value when it
 * sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x an SQL {@code REF} value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 * @since 1.2
 */
voidsetRef (intparameterIndex, Refx) throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.sql.Blob} object.
 * The driver converts this to an SQL {@code BLOB} value when it
 * sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x a {@code Blob} object that maps an SQL {@code BLOB} value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 * @since 1.2
 */
voidsetBlob (intparameterIndex, Blobx) throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.sql.Clob} object.
 * The driver converts this to an SQL {@code CLOB} value when it
 * sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x a {@code Clob} object that maps an SQL {@code CLOB} value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 * @since 1.2
 */
voidsetClob (intparameterIndex, Clobx) throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.sql.Array} object.
 * The driver converts this to an SQL {@code ARRAY} value when it
 * sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x an {@code Array} object that maps an SQL {@code ARRAY} value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 * @since 1.2
 */
voidsetArray (intparameterIndex, Arrayx) throwsSQLException;

/**
 * Retrieves a {@code ResultSetMetaData} object that contains
 * information about the columns of the {@code ResultSet} object
 * that will be returned when this {@code PreparedStatement} object
 * is executed.
 * <P>
 * Because a {@code PreparedStatement} object is precompiled, it is
 * possible to know about the {@code ResultSet} object that it will
 * return without having to execute it. Consequently, it is possible
 * to invoke the method {@code getMetaData} on a
 * {@code PreparedStatement} object rather than waiting to execute
 * it and then invoking the {@code ResultSet.getMetaData} method
 * on the {@code ResultSet} object that is returned.
 * <P>
 * <B>NOTE:</B> Using this method may be expensive for some drivers due
 * to the lack of underlying DBMS support.
 *
 * @return the description of a {@code ResultSet} object's columns or
 * {@code null} if the driver cannot return a
 * {@code ResultSetMetaData} object
 * @throws SQLException if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support
 * this method
 * @since 1.2
 */
ResultSetMetaDatagetMetaData() throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.sql.Date} value,
 * using the given {@code Calendar} object. The driver uses
 * the {@code Calendar} object to construct an SQL {@code DATE} value,
 * which the driver then sends to the database. With
 * a {@code Calendar} object, the driver can calculate the date
 * taking into account a custom timezone. If no
 * {@code Calendar} object is specified, the driver uses the default
 * timezone, which is that of the virtual machine running the application.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @param cal the {@code Calendar} object the driver will use
 * to construct the date
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @since 1.2
 */
voidsetDate(intparameterIndex, java.sql.Datex, Calendarcal)
throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.sql.Time} value,
 * using the given {@code Calendar} object. The driver uses
 * the {@code Calendar} object to construct an SQL {@code TIME} value,
 * which the driver then sends to the database. With
 * a {@code Calendar} object, the driver can calculate the time
 * taking into account a custom timezone. If no
 * {@code Calendar} object is specified, the driver uses the default
 * timezone, which is that of the virtual machine running the application.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @param cal the {@code Calendar} object the driver will use
 * to construct the time
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @since 1.2
 */
voidsetTime(intparameterIndex, java.sql.Timex, Calendarcal)
throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.sql.Timestamp} value,
 * using the given {@code Calendar} object. The driver uses
 * the {@code Calendar} object to construct an SQL {@code TIMESTAMP} value,
 * which the driver then sends to the database. With a
 * {@code Calendar} object, the driver can calculate the timestamp
 * taking into account a custom timezone. If no
 * {@code Calendar} object is specified, the driver uses the default
 * timezone, which is that of the virtual machine running the application.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @param cal the {@code Calendar} object the driver will use
 * to construct the timestamp
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @since 1.2
 */
voidsetTimestamp(intparameterIndex, java.sql.Timestampx, Calendarcal)
throwsSQLException;

/**
 * Sets the designated parameter to SQL {@code NULL}.
 * This version of the method {@code setNull} should
 * be used for user-defined types and REF type parameters. Examples
 * of user-defined types include: STRUCT, DISTINCT, JAVA_OBJECT, and
 * named array types.
 *
 * <P><B>Note:</B> To be portable, applications must give the
 * SQL type code and the fully-qualified SQL type name when specifying
 * a NULL user-defined or REF parameter. In the case of a user-defined type
 * the name is the type name of the parameter itself. For a REF
 * parameter, the name is the type name of the referenced type. If
 * a JDBC driver does not need the type code or type name information,
 * it may ignore it.
 *
 * Although it is intended for user-defined and Ref parameters,
 * this method may be used to set a null parameter of any JDBC type.
 * If the parameter does not have a user-defined or REF type, the given
 * typeName is ignored.
 *
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param sqlType a value from {@code java.sql.Types}
 * @param typeName the fully-qualified name of an SQL user-defined type;
 * ignored if the parameter is not a user-defined type or REF
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if {@code sqlType} is
 * a {@code ARRAY}, {@code BLOB}, {@code CLOB},
 * {@code DATALINK}, {@code JAVA_OBJECT}, {@code NCHAR},
 * {@code NCLOB}, {@code NVARCHAR}, {@code LONGNVARCHAR},
 * {@code REF}, {@code ROWID}, {@code SQLXML}
 * or {@code STRUCT} data type and the JDBC driver does not support
 * this data type or if the JDBC driver does not support this method
 * @since 1.2
 */
voidsetNull (intparameterIndex, intsqlType, StringtypeName)
throwsSQLException;

//------------------------- JDBC 3.0 -----------------------------------

/**
 * Sets the designated parameter to the given {@code java.net.URL} value.
 * The driver converts this to an SQL {@code DATALINK} value
 * when it sends it to the database.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the {@code java.net.URL} object to be set
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 * @since 1.4
 */
voidsetURL(intparameterIndex, java.net.URLx) throwsSQLException;

/**
 * Retrieves the number, types and properties of this
 * {@code PreparedStatement} object's parameters.
 *
 * @return a {@code ParameterMetaData} object that contains information
 * about the number, types and properties for each
 * parameter marker of this {@code PreparedStatement} object
 * @throws SQLException if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @see ParameterMetaData
 * @since 1.4
 */
ParameterMetaDatagetParameterMetaData() throwsSQLException;

//------------------------- JDBC 4.0 -----------------------------------

/**
 * Sets the designated parameter to the given {@code java.sql.RowId} object. The
 * driver converts this to a SQL {@code ROWID} value when it sends it
 * to the database
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 *
 * @since 1.6
 */
voidsetRowId(intparameterIndex, RowIdx) throwsSQLException;


/**
 * Sets the designated parameter to the given {@code String} object.
 * The driver converts this to a SQL {@code NCHAR} or
 * {@code NVARCHAR} or {@code LONGNVARCHAR} value
 * (depending on the argument's
 * size relative to the driver's limits on {@code NVARCHAR} values)
 * when it sends it to the database.
 *
 * @param parameterIndex of the first parameter is 1, the second is 2, ...
 * @param value the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if the driver does not support national
 * character sets; if the driver can detect that a data conversion
 * error could occur; if a database access error occurs; or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 * @since 1.6
 */
voidsetNString(intparameterIndex, Stringvalue) throwsSQLException;

/**
 * Sets the designated parameter to a {@code Reader} object. The
 * {@code Reader} reads the data till end-of-file is reached. The
 * driver does the necessary conversion from Java character format to
 * the national character set in the database.
 * @param parameterIndex of the first parameter is 1, the second is 2, ...
 * @param value the parameter value
 * @param length the number of characters in the parameter data.
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if the driver does not support national
 * character sets; if the driver can detect that a data conversion
 * error could occur; if a database access error occurs; or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 * @since 1.6
 */
voidsetNCharacterStream(intparameterIndex, Readervalue, longlength) throwsSQLException;

/**
 * Sets the designated parameter to a {@code java.sql.NClob} object. The driver converts this to a
 * SQL {@code NCLOB} value when it sends it to the database.
 * @param parameterIndex of the first parameter is 1, the second is 2, ...
 * @param value the parameter value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if the driver does not support national
 * character sets; if the driver can detect that a data conversion
 * error could occur; if a database access error occurs; or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 * @since 1.6
 */
voidsetNClob(intparameterIndex, NClobvalue) throwsSQLException;

/**
 * Sets the designated parameter to a {@code Reader} object. The reader must contain the number
 * of characters specified by length otherwise a {@code SQLException} will be
 * generated when the {@code PreparedStatement} is executed.
 *This method differs from the {@code setCharacterStream (int, Reader, int)} method
 * because it informs the driver that the parameter value should be sent to
 * the server as a {@code CLOB}. When the {@code setCharacterStream} method is used, the
 * driver may have to do extra work to determine whether the parameter
 * data should be sent to the server as a {@code LONGVARCHAR} or a {@code CLOB}
 * @param parameterIndex index of the first parameter is 1, the second is 2, ...
 * @param reader An object that contains the data to set the parameter value to.
 * @param length the number of characters in the parameter data.
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs; this method is called on
 * a closed {@code PreparedStatement} or if the length specified is less than zero.
 *
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 * @since 1.6
 */
voidsetClob(intparameterIndex, Readerreader, longlength)
throwsSQLException;

/**
 * Sets the designated parameter to a {@code InputStream} object.
 * The {@code Inputstream} must contain the number
 * of characters specified by length otherwise a {@code SQLException} will be
 * generated when the {@code PreparedStatement} is executed.
 * This method differs from the {@code setBinaryStream (int, InputStream, int)}
 * method because it informs the driver that the parameter value should be
 * sent to the server as a {@code BLOB}. When the {@code setBinaryStream} method is used,
 * the driver may have to do extra work to determine whether the parameter
 * data should be sent to the server as a {@code LONGVARBINARY} or a {@code BLOB}
 * @param parameterIndex index of the first parameter is 1,
 * the second is 2, ...
 * @param inputStream An object that contains the data to set the parameter
 * value to.
 * @param length the number of bytes in the parameter data.
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs;
 * this method is called on a closed {@code PreparedStatement};
 * if the length specified
 * is less than zero or if the number of bytes in the {@code InputStream} does not match
 * the specified length.
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 *
 * @since 1.6
 */
voidsetBlob(intparameterIndex, InputStreaminputStream, longlength)
throwsSQLException;
/**
 * Sets the designated parameter to a {@code Reader} object. The reader must contain the number
 * of characters specified by length otherwise a {@code SQLException} will be
 * generated when the {@code PreparedStatement} is executed.
 * This method differs from the {@code setCharacterStream (int, Reader, int)} method
 * because it informs the driver that the parameter value should be sent to
 * the server as a {@code NCLOB}. When the {@code setCharacterStream} method is used, the
 * driver may have to do extra work to determine whether the parameter
 * data should be sent to the server as a {@code LONGNVARCHAR} or a {@code NCLOB}
 * @param parameterIndex index of the first parameter is 1, the second is 2, ...
 * @param reader An object that contains the data to set the parameter value to.
 * @param length the number of characters in the parameter data.
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if the length specified is less than zero;
 * if the driver does not support national character sets;
 * if the driver can detect that a data conversion
 * error could occur; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 *
 * @since 1.6
 */
voidsetNClob(intparameterIndex, Readerreader, longlength)
throwsSQLException;

/**
 * Sets the designated parameter to the given {@code java.sql.SQLXML} object.
 * The driver converts this to an
 * SQL {@code XML} value when it sends it to the database.
 *
 * @param parameterIndex index of the first parameter is 1, the second is 2, ...
 * @param xmlObject a {@code SQLXML} object that maps an SQL {@code XML} value
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs;
 * this method is called on a closed {@code PreparedStatement}
 * or the {@code java.xml.transform.Result},
 * {@code Writer} or {@code OutputStream} has not been closed for
 * the {@code SQLXML} object
 * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
 *
 * @since 1.6
 */
voidsetSQLXML(intparameterIndex, SQLXMLxmlObject) throwsSQLException;

/**
 * <p>Sets the value of the designated parameter with the given object.
 *
 * If the second argument is an {@code InputStream} then the stream must contain
 * the number of bytes specified by scaleOrLength. If the second argument is a
 * {@code Reader} then the reader must contain the number of characters specified
 * by scaleOrLength. If these conditions are not true the driver will generate a
 * {@code SQLException} when the prepared statement is executed.
 *
 * <p>The given Java object will be converted to the given targetSqlType
 * before being sent to the database.
 *
 * If the object has a custom mapping (is of a class implementing the
 * interface {@code SQLData}),
 * the JDBC driver should call the method {@code SQLData.writeSQL} to
 * write it to the SQL data stream.
 * If, on the other hand, the object is of a class implementing
 * {@code Ref}, {@code Blob}, {@code Clob}, {@code NClob},
 * {@code Struct}, {@code java.net.URL},
 * or {@code Array}, the driver should pass it to the database as a
 * value of the corresponding SQL type.
 *
 * <p>Note that this method may be used to pass database-specific
 * abstract data types.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the object containing the input parameter value
 * @param targetSqlType the SQL type (as defined in java.sql.Types) to be
 * sent to the database. The scale argument may further qualify this type.
 * @param scaleOrLength for {@code java.sql.Types.DECIMAL}
 * or {@code java.sql.Types.NUMERIC types},
 * this is the number of digits after the decimal point. For
 * Java Object types {@code InputStream} and {@code Reader},
 * this is the length
 * of the data in the stream or reader. For all other types,
 * this value will be ignored.
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs;
 * this method is called on a closed {@code PreparedStatement} or
 * if the Java Object specified by x is an InputStream
 * or Reader object and the value of the scale parameter is less
 * than zero
 * @throws SQLFeatureNotSupportedException if
 * the JDBC driver does not support the specified targetSqlType
 * @see Types
 *
 */
voidsetObject(intparameterIndex, Objectx, inttargetSqlType, intscaleOrLength)
throwsSQLException;
/**
 * Sets the designated parameter to the given input stream, which will have
 * the specified number of bytes.
 * When a very large ASCII value is input to a {@code LONGVARCHAR}
 * parameter, it may be more practical to send it via a
 * {@code java.io.InputStream}. Data will be read from the stream
 * as needed until end-of-file is reached. The JDBC driver will
 * do any necessary conversion from ASCII to the database char format.
 *
 * <P><B>Note:</B> This stream object can either be a standard
 * Java stream object or your own subclass that implements the
 * standard interface.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the Java input stream that contains the ASCII parameter value
 * @param length the number of bytes in the stream
 * @throws SQLException if parameterIndex does not correspond to a parameter
 * marker in the SQL statement; if a database access error occurs or
 * this method is called on a closed {@code PreparedStatement}
 * @since 1.6
 */
voidsetAsciiStream(intparameterIndex, java.io.InputStreamx, longlength)
throwsSQLException;
/**
 * Sets the designated parameter to the given input stream, which will have
 * the specified number of bytes.
 * When a very large binary value is input to a {@code LONGVARBINARY}
 * parameter, it may be more practical to send it via a
 * {@code java.io.InputStream} object. The data will be read from the
 * stream as needed until end-of-file is reached.
 *
 * <P><B>Note:</B> This stream object can either be a standard
 * Java stream object or your own subclass that implements the
 * standard interface.
 *
 * @param parameterIndex the first parameter is 1, the second is 2, ...
 * @param x the java input stream which contains the binary parameter value
 * @param length the number of bytes in the stream
 * @throws SQLException if parameterIndex does not correspond to a parameter