--- old/src/java.sql.rowset/share/classes/com/sun/rowset/JdbcRowSetImpl.java 2015-06-05 21:17:27.535465439 +0400
+++ new/src/java.sql.rowset/share/classes/com/sun/rowset/JdbcRowSetImpl.java 2015-06-05 21:17:27.359465439 +0400
@@ -35,7 +35,7 @@
import javax.sql.rowset.*;
/**
- * The standard implementation of the JdbcRowSet
interface. See the interface
+ * The standard implementation of the {@code JdbcRowSet} interface. See the interface
* definition for full behavior and implementation requirements.
*
* @author Jonathan Bruce, Amit Handa
@@ -44,40 +44,40 @@
public class JdbcRowSetImpl extends BaseRowSet implements JdbcRowSet, Joinable {
/**
- * The Connection
object that is this rowset's
+ * The {@code Connection} object that is this rowset's
* current connection to the database. This field is set
* internally when the connection is established.
*/
private Connection conn;
/**
- * The PreparedStatement
object that is this rowset's
+ * The {@code PreparedStatement} object that is this rowset's
* current command. This field is set internally when the method
- * execute
creates the PreparedStatement
+ * {@code execute} creates the {@code PreparedStatement}
* object.
*/
private PreparedStatement ps;
/**
- * The ResultSet
object that is this rowset's
+ * The {@code ResultSet} object that is this rowset's
* current result set. This field is set internally when the method
- * execute
executes the rowset's command and thereby
- * creates the rowset's ResultSet
object.
+ * {@code execute} executes the rowset's command and thereby
+ * creates the rowset's {@code ResultSet} object.
*/
private ResultSet rs;
/**
- * The RowSetMetaDataImpl
object that is constructed when
- * a ResultSet
object is passed to the JdbcRowSet
+ * The {@code RowSetMetaDataImpl} object that is constructed when
+ * a {@code ResultSet} object is passed to the {@code JdbcRowSet}
* constructor. This helps in constructing all metadata associated
- * with the ResultSet
object using the setter methods of
- * RowSetMetaDataImpl
.
+ * with the {@code ResultSet} object using the setter methods of
+ * {@code RowSetMetaDataImpl}.
*/
private RowSetMetaDataImpl rowsMD;
/**
- * The ResultSetMetaData
object from which this
- * RowSetMetaDataImpl
is formed and which helps in getting
+ * The {@code ResultSetMetaData} object from which this
+ * {@code RowSetMetaDataImpl} is formed and which helps in getting
* the metadata information.
*/
private ResultSetMetaData resMD;
@@ -97,13 +97,13 @@
protected transient JdbcRowSetResourceBundle resBundle;
/**
- * Constructs a default JdbcRowSet
object.
- * The new instance of JdbcRowSet
will serve as a proxy
- * for the ResultSet
object it creates, and by so doing,
+ * Constructs a default {@code JdbcRowSet} object.
+ * The new instance of {@code JdbcRowSet} will serve as a proxy
+ * for the {@code ResultSet} object it creates, and by so doing,
* it will make it possible to use the result set as a JavaBeans
* component.
*
- * The following is true of a default JdbcRowSet
instance:
+ * The following is true of a default {@code JdbcRowSet} instance:
*
null
- * Hashtable
object for storing any
+ * JdbcRowSet
object must have its
- * execute
method invoked before other public methods
+ * A newly created {@code JdbcRowSet} object must have its
+ * {@code execute} method invoked before other public methods
* are called on it; otherwise, such method calls will cause an
* exception to be thrown.
*
* @throws SQLException [1] if any of its public methods are called prior
- * to calling the execute
method; [2] if invalid JDBC driver
+ * to calling the {@code execute} method; [2] if invalid JDBC driver
* properties are set or [3] if no connection to a data source exists.
*/
public JdbcRowSetImpl() {
@@ -217,14 +217,14 @@
}
/**
- * Constructs a default JdbcRowSet
object given a
- * valid Connection
object. The new
- * instance of JdbcRowSet
will serve as a proxy for
- * the ResultSet
object it creates, and by so doing,
+ * Constructs a default {@code JdbcRowSet} object given a
+ * valid {@code Connection} object. The new
+ * instance of {@code JdbcRowSet} will serve as a proxy for
+ * the {@code ResultSet} object it creates, and by so doing,
* it will make it possible to use the result set as a JavaBeans
* component.
*
- * The following is true of a default JdbcRowSet
instance:
+ * The following is true of a default {@code JdbcRowSet} instance:
*
null
- * Hashtable
object for storing any
+ * JdbcRowSet
object must have its
- * execute
method invoked before other public methods
+ * A newly created {@code JdbcRowSet} object must have its
+ * {@code execute} method invoked before other public methods
* are called on it; otherwise, such method calls will cause an
* exception to be thrown.
*
* @throws SQLException [1] if any of its public methods are called prior
- * to calling the execute
method, [2] if invalid JDBC driver
+ * to calling the {@code execute} method, [2] if invalid JDBC driver
* properties are set, or [3] if no connection to a data source exists.
*/
public JdbcRowSetImpl(Connection con) throws SQLException {
@@ -289,15 +289,15 @@
}
/**
- * Constructs a default JdbcRowSet
object using the
+ * Constructs a default {@code JdbcRowSet} object using the
* URL, username, and password arguments supplied. The new
- * instance of JdbcRowSet
will serve as a proxy for
- * the ResultSet
object it creates, and by so doing,
+ * instance of {@code JdbcRowSet} will serve as a proxy for
+ * the {@code ResultSet} object it creates, and by so doing,
* it will make it possible to use the result set as a JavaBeans
* component.
*
*
- * The following is true of a default JdbcRowSet
instance:
+ * The following is true of a default {@code JdbcRowSet} instance:
*
null
- * Hashtable
object for storing any
+ * JdbcRowSet
+ * @param url a JDBC URL for the database to which this {@code JdbcRowSet}
* object will be connected. The form for a JDBC URL is
- * jdbc:subprotocol:subname
.
- * @param user - the database user on whose behalf the connection
+ * {@code jdbc:subprotocol:subname}.
+ * @param user the database user on whose behalf the connection
* is being made
- * @param password - the user's password
+ * @param password the user's password
*
* @throws SQLException if a database access error occurs
*
@@ -372,15 +372,15 @@
/**
- * Constructs a JdbcRowSet
object using the given valid
- * ResultSet
object. The new
- * instance of JdbcRowSet
will serve as a proxy for
- * the ResultSet
object, and by so doing,
+ * Constructs a {@code JdbcRowSet} object using the given valid
+ * {@code ResultSet} object. The new
+ * instance of {@code JdbcRowSet} will serve as a proxy for
+ * the {@code ResultSet} object, and by so doing,
* it will make it possible to use the result set as a JavaBeans
* component.
*
*
- * The following is true of a default JdbcRowSet
instance:
+ * The following is true of a default {@code JdbcRowSet} instance:
*
null
- * Hashtable
object for storing any
+ * ResultSet
object
+ * @param res a valid {@code ResultSet} object
*
* @throws SQLException if a database access occurs due to a non
* valid ResultSet handle.
@@ -460,13 +460,13 @@
}
/**
- * Initializes the given RowSetMetaData
object with the values
- * in the given ResultSetMetaData
object.
+ * Initializes the given {@code RowSetMetaData} object with the values
+ * in the given {@code ResultSetMetaData} object.
*
- * @param md the RowSetMetaData
object for this
- * JdbcRowSetImpl
object, which will be set with
+ * @param md the {@code RowSetMetaData} object for this
+ * {@code JdbcRowSetImpl} object, which will be set with
* values from rsmd
- * @param rsmd the ResultSetMetaData
object from which new
+ * @param rsmd the {@code ResultSetMetaData} object from which new
* values for md will be read
* @throws SQLException if an error occurs
*/
@@ -511,24 +511,24 @@
//---------------------------------------------------------------------
/**
- * Creates the internal ResultSet
object for which this
- * JdbcRowSet
object is a wrapper, effectively
+ * Creates the internal {@code ResultSet} object for which this
+ * {@code JdbcRowSet} object is a wrapper, effectively
* making the result set a JavaBeans component.
*
* Certain properties must have been set before this method is called
* so that it can establish a connection to a database and execute the
- * query that will create the result set. If a DataSource
+ * query that will create the result set. If a {@code DataSource}
* object will be used to create the connection, properties for the
* data source name, user name, and password must be set. If the
- * DriverManager
will be used, the properties for the
+ * {@code DriverManager} will be used, the properties for the
* URL, user name, and password must be set. In either case, the
* property for the command must be set. If the command has placeholder
* parameters, those must also be set. This method throws
* an exception if the required properties are not set.
*
* Other properties have default values that may optionally be set
- * to new values. The execute
method will use the value
- * for the command property to create a PreparedStatement
+ * to new values. The {@code execute} method will use the value
+ * for the command property to create a {@code PreparedStatement}
* object and set its properties (escape processing, maximum field
* size, maximum number of rows, and query timeout limit) to be those
* of this rowset.
@@ -784,20 +784,20 @@
}
/**
- * Moves the cursor for this rowset's ResultSet
+ * Moves the cursor for this rowset's {@code ResultSet}
* object down one row from its current position.
- * A ResultSet
cursor is initially positioned
+ * A {@code ResultSet} cursor is initially positioned
* before the first row; the first call to the method
- * next
makes the first row the current row; the
+ * {@code next} makes the first row the current row; the
* second call makes the second row the current row, and so on.
*
*
If an input stream is open for the current row, a call
- * to the method next
will
- * implicitly close it. A ResultSet
object's
+ * to the method {@code next} will
+ * implicitly close it. A {@code ResultSet} object's
* warning chain is cleared when a new row is read.
*
- * @return true
if the new current row is valid;
- * false
if there are no more rows
+ * @return {@code true} if the new current row is valid;
+ * {@code false} if there are no more rows
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -811,16 +811,16 @@
}
/**
- * Releases this rowset's ResultSet
object's database and
+ * Releases this rowset's {@code ResultSet} object's database and
* JDBC resources immediately instead of waiting for
* this to happen when it is automatically closed.
*
- *
Note: A ResultSet
object
+ *
Note: A {@code ResultSet} object
* is automatically closed by the
- * Statement
object that generated it when
- * that Statement
object is closed,
+ * {@code Statement} object that generated it when
+ * that {@code Statement} object is closed,
* re-executed, or is used to retrieve the next result from a
- * sequence of multiple results. A ResultSet
object
+ * sequence of multiple results. A {@code ResultSet} object
* is also automatically closed when it is garbage collected.
*
* @throws SQLException if a database access error occurs
@@ -836,14 +836,14 @@
/**
* Reports whether the last column read from this rowset's
- * ResultSet
object had a value of SQL NULL
.
- * Note that you must first call one of the getXXX
methods
+ * {@code ResultSet} object had a value of SQL {@code NULL}.
+ * Note that you must first call one of the {@code getXXX} methods
* on a column to try to read its value and then call
- * the method wasNull
to see if the value read was
- * SQL NULL
.
+ * the method {@code wasNull} to see if the value read was
+ * SQL {@code NULL}.
*
- * @return true
if the last column value read was SQL
- * NULL
and false
otherwise
+ * @return {@code true} if the last column value read was SQL
+ * {@code NULL} and {@code false} otherwise
* @throws SQLException if a database access error occurs
* or this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -860,12 +860,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a String
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code String}.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -878,12 +878,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a boolean
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code boolean}.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is false
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code false}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -896,12 +896,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a byte
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code byte}.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -914,12 +914,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a short
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code short}.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -932,12 +932,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * an int
.
+ * of this rowset's {@code ResultSet} object as
+ * an {@code int}.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -950,12 +950,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a long
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code long}.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -968,12 +968,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a float
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code float}.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -986,12 +986,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a double
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code double}.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1004,13 +1004,13 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a java.sql.BigDecimal
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code java.sql.BigDecimal}.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param scale the number of digits to the right of the decimal point
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1025,13 +1025,13 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a byte
array in the Java programming language.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code byte} array in the Java programming language.
* The bytes represent the raw values returned by the driver.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1044,12 +1044,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a java.sql.Date
object in the Java programming language.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code java.sql.Date} object in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1062,12 +1062,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a java.sql.Time
object in the Java programming language.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code java.sql.Time} object in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1080,12 +1080,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a java.sql.Timestamp
object in the Java programming language.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code java.sql.Timestamp} object in the Java programming language.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1098,25 +1098,25 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
+ * of this rowset's {@code ResultSet} object as
* a stream of ASCII characters. The value can then be read in chunks from the
* stream. This method is particularly
- * suitable for retrieving large LONGVARCHAR
values.
+ * suitable for retrieving large {@code LONGVARCHAR} values.
* The JDBC driver will
* do any necessary conversion from the database format into ASCII.
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
- * call to a getXXX
method implicitly closes the stream. Also, a
- * stream may return 0
when the method
- * InputStream.available
+ * call to a {@code getXXX} method implicitly closes the stream. Also, a
+ * stream may return {@code 0} when the method
+ * {@code InputStream.available}
* is called whether there is data available or not.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @return a Java input stream that delivers the database column value
- * as a stream of one-byte ASCII characters;
- * if the value is SQL NULL
, the
- * value returned is null
+ * as a stream of one-byte ASCII characters;
+ * if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) database access error occurs
* (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1129,31 +1129,31 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
+ * of this rowset's {@code ResultSet} object as
* as a stream of Unicode characters.
* The value can then be read in chunks from the
* stream. This method is particularly
- * suitable for retrieving largeLONGVARCHAR
values. The JDBC driver will
+ * suitable for retrieving large{@code LONGVARCHAR}values. The JDBC driver will
* do any necessary conversion from the database format into Unicode.
* The byte format of the Unicode stream must be Java UTF-8,
* as specified in the Java virtual machine specification.
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
- * call to a getXXX
method implicitly closes the stream. Also, a
- * stream may return 0
when the method
- * InputStream.available
+ * call to a {@code getXXX} method implicitly closes the stream. Also, a
+ * stream may return {@code 0} when the method
+ * {@code InputStream.available}
* is called whether there is data available or not.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @return a Java input stream that delivers the database column value
- * as a stream in Java UTF-8 byte format;
- * if the value is SQL NULL
, the value returned is null
+ * as a stream in Java UTF-8 byte format;
+ * if the value is SQL {@code NULL}, the value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
- * @deprecated use getCharacterStream
in place of
- * getUnicodeStream
+ * @deprecated use {@code getCharacterStream} in place of
+ * {@code getUnicodeStream}
*/
@Deprecated
public java.io.InputStream getUnicodeStream(int columnIndex) throws SQLException {
@@ -1165,22 +1165,22 @@
/**
* Gets the value of a column in the current row as a stream of
* the value of the designated column in the current row
- * of this rowset's ResultSet
object as a binary stream of
+ * of this rowset's {@code ResultSet} object as a binary stream of
* uninterpreted bytes. The value can then be read in chunks from the
* stream. This method is particularly
- * suitable for retrieving large LONGVARBINARY
values.
+ * suitable for retrieving large {@code LONGVARBINARY} values.
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
- * call to a getXXX
method implicitly closes the stream. Also, a
- * stream may return 0
when the method
- * InputStream.available
+ * call to a {@code getXXX} method implicitly closes the stream. Also, a
+ * stream may return {@code 0} when the method
+ * {@code InputStream.available}
* is called whether there is data available or not.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @return a Java input stream that delivers the database column value
- * as a stream of uninterpreted bytes;
- * if the value is SQL NULL
, the value returned is null
+ * as a stream of uninterpreted bytes;
+ * if the value is SQL {@code NULL}, the value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1198,12 +1198,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a String
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code String}.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1214,12 +1214,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a boolean
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code boolean}.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is false
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code false}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1230,12 +1230,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a byte
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code byte}.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1246,12 +1246,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a short
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code short}.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1262,12 +1262,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * an int
.
+ * of this rowset's {@code ResultSet} object as
+ * an {@code int}.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1278,12 +1278,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a long
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code long}.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if a database access error occurs
* or this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1294,12 +1294,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a float
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code float}.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1310,12 +1310,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a double
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code double}.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is 0
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code 0}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1326,13 +1326,13 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a java.math.BigDecimal
.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code java.math.BigDecimal}.
*
* @param columnName the SQL name of the column
* @param scale the number of digits to the right of the decimal point
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) adatabase access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1345,13 +1345,13 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a byte
array in the Java programming language.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code byte} array in the Java programming language.
* The bytes represent the raw values returned by the driver.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1362,12 +1362,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a java.sql.Date
object in the Java programming language.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code java.sql.Date} object in the Java programming language.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1378,13 +1378,13 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a java.sql.Time
object in the Java programming language.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code java.sql.Time} object in the Java programming language.
*
* @param columnName the SQL name of the column
* @return the column value;
- * if the value is SQL NULL
,
- * the value returned is null
+ * if the value is SQL {@code NULL},
+ * the value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1395,12 +1395,12 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * a java.sql.Timestamp
object.
+ * of this rowset's {@code ResultSet} object as
+ * a {@code java.sql.Timestamp} object.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1411,24 +1411,24 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as a stream of
+ * of this rowset's {@code ResultSet} object as a stream of
* ASCII characters. The value can then be read in chunks from the
* stream. This method is particularly
- * suitable for retrieving large LONGVARCHAR
values.
+ * suitable for retrieving large {@code LONGVARCHAR} values.
* The JDBC driver will
* do any necessary conversion from the database format into ASCII.
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
- * call to a getXXX
method implicitly closes the stream. Also, a
- * stream may return 0
when the method available
+ * call to a {@code getXXX} method implicitly closes the stream. Also, a
+ * stream may return {@code 0} when the method {@code available}
* is called whether there is data available or not.
*
* @param columnName the SQL name of the column
* @return a Java input stream that delivers the database column value
- * as a stream of one-byte ASCII characters.
- * If the value is SQL NULL
,
- * the value returned is null
.
+ * as a stream of one-byte ASCII characters.
+ * If the value is SQL {@code NULL},
+ * the value returned is {@code null}.
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1439,10 +1439,10 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as a stream of
+ * of this rowset's {@code ResultSet} object as a stream of
* Unicode characters. The value can then be read in chunks from the
* stream. This method is particularly
- * suitable for retrieving large LONGVARCHAR
values.
+ * suitable for retrieving large {@code LONGVARCHAR} values.
* The JDBC driver will
* do any necessary conversion from the database format into Unicode.
* The byte format of the Unicode stream must be Java UTF-8,
@@ -1450,15 +1450,15 @@
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
- * call to a getXXX
method implicitly closes the stream. Also, a
- * stream may return 0
when the method available
+ * call to a {@code getXXX} method implicitly closes the stream. Also, a
+ * stream may return {@code 0} when the method {@code available}
* is called whether there is data available or not.
*
* @param columnName the SQL name of the column
* @return a Java input stream that delivers the database column value
- * as a stream of two-byte Unicode characters.
- * If the value is SQL NULL
,
- * the value returned is null
.
+ * as a stream of two-byte Unicode characters.
+ * If the value is SQL {@code NULL},
+ * the value returned is {@code null}.
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1471,23 +1471,23 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as a stream of uninterpreted
- * byte
s.
+ * of this rowset's {@code ResultSet} object as a stream of uninterpreted
+ * {@code byte}s.
* The value can then be read in chunks from the
* stream. This method is particularly
- * suitable for retrieving large LONGVARBINARY
+ * suitable for retrieving large {@code LONGVARBINARY}
* values.
*
*
Note: All the data in the returned stream must be
* read prior to getting the value of any other column. The next
- * call to a getXXX
method implicitly closes the stream. Also, a
- * stream may return 0
when the method available
+ * call to a {@code getXXX} method implicitly closes the stream. Also, a
+ * stream may return {@code 0} when the method {@code available}
* is called whether there is data available or not.
*
* @param columnName the SQL name of the column
* @return a Java input stream that delivers the database column value
- * as a stream of uninterpreted bytes;
- * if the value is SQL NULL
, the result is null
+ * as a stream of uninterpreted bytes;
+ * if the value is SQL {@code NULL}, the result is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1503,21 +1503,21 @@
/**
* Returns the first warning reported by calls on this rowset's
- * ResultSet
object.
- * Subsequent warnings on this rowset's ResultSet
object
- * will be chained to the SQLWarning
object that
+ * {@code ResultSet} object.
+ * Subsequent warnings on this rowset's {@code ResultSet} object
+ * will be chained to the {@code SQLWarning} object that
* this method returns.
*
*
The warning chain is automatically cleared each time a new * row is read. * *
Note: This warning chain only covers warnings caused
- * by ResultSet
methods. Any warning caused by
- * Statement
methods
+ * by {@code ResultSet} methods. Any warning caused by
+ * {@code Statement} methods
* (such as reading OUT parameters) will be chained on the
- * Statement
object.
+ * {@code Statement} object.
*
- * @return the first SQLWarning
object reported or null
+ * @return the first {@code SQLWarning} object reported or {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1529,10 +1529,10 @@
}
/**
- * Clears all warnings reported on this rowset's ResultSet
object.
- * After this method is called, the method getWarnings
- * returns null
until a new warning is
- * reported for this rowset's ResultSet
object.
+ * Clears all warnings reported on this rowset's {@code ResultSet} object.
+ * After this method is called, the method {@code getWarnings}
+ * returns {@code null} until a new warning is
+ * reported for this rowset's {@code ResultSet} object.
*
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
@@ -1545,26 +1545,26 @@
}
/**
- * Gets the name of the SQL cursor used by this rowset's ResultSet
+ * Gets the name of the SQL cursor used by this rowset's {@code ResultSet}
* object.
*
*
In SQL, a result table is retrieved through a cursor that is
* named. The current row of a result set can be updated or deleted
* using a positioned update/delete statement that references the
* cursor name. To insure that the cursor has the proper isolation
- * level to support update, the cursor's select
statement should be
+ * level to support update, the cursor's {@code select} statement should be
* of the form 'select for update'. If the 'for update' clause is
* omitted, the positioned updates may fail.
*
*
The JDBC API supports this SQL feature by providing the name of the
- * SQL cursor used by a ResultSet
object.
- * The current row of a ResultSet
object
+ * SQL cursor used by a {@code ResultSet} object.
+ * The current row of a {@code ResultSet} object
* is also the current row of this SQL cursor.
*
*
Note: If positioned update is not supported, a
- * SQLException
is thrown.
+ * {@code SQLException} is thrown.
*
- * @return the SQL name for this rowset's ResultSet
object's cursor
+ * @return the SQL name for this rowset's {@code ResultSet} object's cursor
* @throws SQLException if (1) a database access error occurs
* or (2) xthis rowset does not have a currently valid connection,
* prepared statement, and result set
@@ -1577,9 +1577,9 @@
/**
* Retrieves the number, types and properties of
- * this rowset's ResultSet
object's columns.
+ * this rowset's {@code ResultSet} object's columns.
*
- * @return the description of this rowset's ResultSet
+ * @return the description of this rowset's {@code ResultSet}
* object's columns
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not have a currently valid connection,
@@ -1607,8 +1607,8 @@
/**
*
Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * an Object
.
+ * of this rowset's {@code ResultSet} object as
+ * an {@code Object}.
*
*
This method will return the value of the given column as a
* Java object. The type of the Java object will be the default
@@ -1620,14 +1620,14 @@
* abstract data types.
*
* In the JDBC 3.0 API, the behavior of method
- * getObject
is extended to materialize
+ * {@code getObject} is extended to materialize
* data of SQL user-defined types. When a column contains
* a structured or distinct value, the behavior of this method is as
- * if it were a call to: getObject(columnIndex,
- * this.getStatement().getConnection().getTypeMap())
.
+ * if it were a call to: {@code getObject(columnIndex,
+ * this.getStatement().getConnection().getTypeMap())}.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @return a java.lang.Object
holding the column value
+ * @return a {@code java.lang.Object} holding the column value
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -1640,8 +1640,8 @@
/**
*
Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as
- * an Object
.
+ * of this rowset's {@code ResultSet} object as
+ * an {@code Object}.
*
*
This method will return the value of the given column as a
* Java object. The type of the Java object will be the default
@@ -1653,14 +1653,14 @@
* abstract data types.
*
* In the JDBC 3.0 API, the behavior of the method
- * getObject
is extended to materialize
+ * {@code getObject} is extended to materialize
* data of SQL user-defined types. When a column contains
* a structured or distinct value, the behavior of this method is as
- * if it were a call to: getObject(columnIndex,
- * this.getStatement().getConnection().getTypeMap())
.
+ * if it were a call to: {@code getObject(columnIndex,
+ * this.getStatement().getConnection().getTypeMap())}.
*
* @param columnName the SQL name of the column
- * @return a java.lang.Object
holding the column value
+ * @return a {@code java.lang.Object} holding the column value
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -1672,9 +1672,9 @@
//----------------------------------------------------------------
/**
- * Maps the given JdbcRowSetImpl
column name to its
- * JdbcRowSetImpl
column index and reflects this on
- * the internal ResultSet
object.
+ * Maps the given {@code JdbcRowSetImpl} column name to its
+ * {@code JdbcRowSetImpl} column index and reflects this on
+ * the internal {@code ResultSet} object.
*
* @param columnName the name of the column
* @return the column index of the given column name
@@ -1697,11 +1697,11 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as a
- * java.io.Reader
object.
- * @return a java.io.Reader
object that contains the column
- * value; if the value is SQL NULL
, the value returned is
- * null
.
+ * of this rowset's {@code ResultSet} object as a
+ * {@code java.io.Reader} object.
+ * @return a {@code java.io.Reader} object that contains the column
+ * value; if the value is SQL {@code NULL}, the value returned is
+ * {@code null}.
* @param columnIndex the first column is 1, the second is 2, and so on
*
*/
@@ -1713,14 +1713,14 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as a
- * java.io.Reader
object.
+ * of this rowset's {@code ResultSet} object as a
+ * {@code java.io.Reader} object.
*
- * @return a java.io.Reader
object that contains the column
- * value; if the value is SQL NULL
, the value returned is
- * null
.
+ * @return a {@code java.io.Reader} object that contains the column
+ * value; if the value is SQL {@code NULL}, the value returned is
+ * {@code null}.
* @param columnName the name of the column
- * @return the value in the specified column as a java.io.Reader
+ * @return the value in the specified column as a {@code java.io.Reader}
*
*/
public java.io.Reader getCharacterStream(String columnName) throws SQLException {
@@ -1729,13 +1729,13 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as a
- * java.math.BigDecimal
with full precision.
+ * of this rowset's {@code ResultSet} object as a
+ * {@code java.math.BigDecimal} with full precision.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @return the column value (full precision);
- * if the value is SQL NULL
, the value returned is
- * null
.
+ * if the value is SQL {@code NULL}, the value returned is
+ * {@code null}.
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid
* connection, prepared statement, and result set
@@ -1748,13 +1748,13 @@
/**
* Gets the value of the designated column in the current row
- * of this rowset's ResultSet
object as a
- * java.math.BigDecimal
with full precision.
+ * of this rowset's {@code ResultSet} object as a
+ * {@code java.math.BigDecimal} with full precision.
*
* @param columnName the column name
* @return the column value (full precision);
- * if the value is SQL NULL
, the value returned is
- * null
.
+ * if the value is SQL {@code NULL}, the value returned is
+ * {@code null}.
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid
* connection, prepared statement, and result set
@@ -1769,11 +1769,11 @@
/**
* Indicates whether the cursor is before the first row in
- * this rowset's ResultSet
object.
+ * this rowset's {@code ResultSet} object.
*
- * @return true
if the cursor is before the first row;
- * false
if the cursor is at any other position or the
- * result set contains no rows
+ * @return {@code true} if the cursor is before the first row;
+ * {@code false} if the cursor is at any other position or the
+ * result set contains no rows
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid
* connection, prepared statement, and result set
@@ -1786,11 +1786,11 @@
/**
* Indicates whether the cursor is after the last row in
- * this rowset's ResultSet
object.
+ * this rowset's {@code ResultSet} object.
*
- * @return true
if the cursor is after the last row;
- * false
if the cursor is at any other position or the
- * result set contains no rows
+ * @return {@code true} if the cursor is after the last row;
+ * {@code false} if the cursor is at any other position or the
+ * result set contains no rows
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid
* connection, prepared statement, and result set
@@ -1803,10 +1803,10 @@
/**
* Indicates whether the cursor is on the first row of
- * this rowset's ResultSet
object.
+ * this rowset's {@code ResultSet} object.
*
- * @return true
if the cursor is on the first row;
- * false
otherwise
+ * @return {@code true} if the cursor is on the first row;
+ * {@code false} otherwise
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid
* connection, prepared statement, and result set
@@ -1819,14 +1819,14 @@
/**
* Indicates whether the cursor is on the last row of
- * this rowset's ResultSet
object.
- * Note: Calling the method isLast
may be expensive
+ * this rowset's {@code ResultSet} object.
+ * Note: Calling the method {@code isLast} may be expensive
* because the JDBC driver
* might need to fetch ahead one row in order to determine
* whether the current row is the last row in the result set.
*
- * @return true
if the cursor is on the last row;
- * false
otherwise
+ * @return {@code true} if the cursor is on the last row;
+ * {@code false} otherwise
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid
* connection, prepared statement, and result set
@@ -1840,11 +1840,11 @@
/**
* Moves the cursor to the front of
- * this rowset's ResultSet
object, just before the
+ * this rowset's {@code ResultSet} object, just before the
* first row. This method has no effect if the result set contains no rows.
*
* @throws SQLException if (1) a database access error occurs,
- * (2) the result set type is TYPE_FORWARD_ONLY
,
+ * (2) the result set type is {@code TYPE_FORWARD_ONLY},
* or (3) this rowset does not currently have a valid
* connection, prepared statement, and result set
*/
@@ -1857,10 +1857,10 @@
/**
* Moves the cursor to the end of
- * this rowset's ResultSet
object, just after the
+ * this rowset's {@code ResultSet} object, just after the
* last row. This method has no effect if the result set contains no rows.
* @throws SQLException if (1) a database access error occurs,
- * (2) the result set type is TYPE_FORWARD_ONLY
,
+ * (2) the result set type is {@code TYPE_FORWARD_ONLY},
* or (3) this rowset does not currently have a valid
* connection, prepared statement, and result set
*/
@@ -1873,12 +1873,12 @@
/**
* Moves the cursor to the first row in
- * this rowset's ResultSet
object.
+ * this rowset's {@code ResultSet} object.
*
- * @return true
if the cursor is on a valid row;
- * false
if there are no rows in the result set
+ * @return {@code true} if the cursor is on a valid row;
+ * {@code false} if there are no rows in the result set
* @throws SQLException if (1) a database access error occurs,
- * (2) the result set type is TYPE_FORWARD_ONLY
,
+ * (2) the result set type is {@code TYPE_FORWARD_ONLY},
* or (3) this rowset does not currently have a valid
* connection, prepared statement, and result set
*/
@@ -1893,12 +1893,12 @@
/**
* Moves the cursor to the last row in
- * this rowset's ResultSet
object.
+ * this rowset's {@code ResultSet} object.
*
- * @return true
if the cursor is on a valid row;
- * false
if there are no rows in the result set
+ * @return {@code true} if the cursor is on a valid row;
+ * {@code false} if there are no rows in the result set
* @throws SQLException if (1) a database access error occurs,
- * (2) the result set type is TYPE_FORWARD_ONLY
,
+ * (2) the result set type is {@code TYPE_FORWARD_ONLY},
* or (3) this rowset does not currently have a valid
* connection, prepared statement, and result set
*/
@@ -1914,7 +1914,7 @@
* Retrieves the current row number. The first row is number 1, the
* second is number 2, and so on.
*
- * @return the current row number; 0
if there is no current row
+ * @return the current row number; {@code 0} if there is no current row
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -1927,7 +1927,7 @@
/**
* Moves the cursor to the given row number in
- * this rowset's internal ResultSet
object.
+ * this rowset's internal {@code ResultSet} object.
*
*
If the row number is positive, the cursor moves to * the given row number with respect to the @@ -1937,23 +1937,23 @@ *
If the given row number is negative, the cursor moves to
* an absolute row position with respect to
* the end of the result set. For example, calling the method
- * absolute(-1)
positions the
- * cursor on the last row, calling the method absolute(-2)
+ * {@code absolute(-1)} positions the
+ * cursor on the last row, calling the method {@code absolute(-2)}
* moves the cursor to the next-to-last row, and so on.
*
*
An attempt to position the cursor beyond the first/last row in * the result set leaves the cursor before the first row or after * the last row. * - *
Note: Calling absolute(1)
is the same
- * as calling first()
. Calling absolute(-1)
- * is the same as calling last()
.
+ *
Note: Calling {@code absolute(1)} is the same
+ * as calling {@code first()}. Calling {@code absolute(-1)}
+ * is the same as calling {@code last()}.
*
- * @return true
if the cursor is on the result set;
- * false
otherwise
+ * @return {@code true} if the cursor is on the result set;
+ * {@code false} otherwise
* @throws SQLException if (1) a database access error occurs,
- * (2) the row is 0
, (3) the result set
- * type is TYPE_FORWARD_ONLY
, or (4) this
+ * (2) the row is {@code 0}, (3) the result set
+ * type is {@code TYPE_FORWARD_ONLY}, or (4) this
* rowset does not currently have a valid connection,
* prepared statement, and result set
*/
@@ -1969,21 +1969,21 @@
* Moves the cursor a relative number of rows, either positive or negative.
* Attempting to move beyond the first/last row in the
* result set positions the cursor before/after the
- * the first/last row. Calling relative(0)
is valid, but does
+ * the first/last row. Calling {@code relative(0)} is valid, but does
* not change the cursor position.
*
- *
Note: Calling the method relative(1)
- * is different from calling the method next()
- * because is makes sense to call next()
when there
+ *
Note: Calling the method {@code relative(1)}
+ * is different from calling the method {@code next()}
+ * because is makes sense to call {@code next()} when there
* is no current row,
* for example, when the cursor is positioned before the first row
* or after the last row of the result set.
*
- * @return true
if the cursor is on a row;
- * false
otherwise
+ * @return {@code true} if the cursor is on a row;
+ * {@code false} otherwise
* @throws SQLException if (1) a database access error occurs,
* (2) there is no current row, (3) the result set
- * type is TYPE_FORWARD_ONLY
, or (4) this
+ * type is {@code TYPE_FORWARD_ONLY}, or (4) this
* rowset does not currently have a valid connection,
* prepared statement, and result set
*/
@@ -1997,16 +1997,16 @@
/**
* Moves the cursor to the previous row in this
- * ResultSet
object.
+ * {@code ResultSet} object.
*
- *
Note: Calling the method previous()
is not the same as
- * calling the method relative(-1)
because it
- * makes sense to call previous()
when there is no current row.
+ *
Note: Calling the method {@code previous()} is not the same as
+ * calling the method {@code relative(-1)} because it
+ * makes sense to call {@code previous()} when there is no current row.
*
- * @return true
if the cursor is on a valid row;
- * false
if it is off the result set
+ * @return {@code true} if the cursor is on a valid row;
+ * {@code false} if it is off the result set
* @throws SQLException if (1) a database access error occurs,
- * (2) the result set type is TYPE_FORWARD_ONLY
,
+ * (2) the result set type is {@code TYPE_FORWARD_ONLY},
* or (3) this rowset does not currently have a valid
* connection, prepared statement, and result set
*/
@@ -2020,15 +2020,15 @@
/**
* Gives a hint as to the direction in which the rows in this
- * ResultSet
object will be processed.
+ * {@code ResultSet} object will be processed.
* The initial value is determined by the
- * Statement
object
- * that produced this rowset's ResultSet
object.
+ * {@code Statement} object
+ * that produced this rowset's {@code ResultSet} object.
* The fetch direction may be changed at any time.
*
* @throws SQLException if (1) a database access error occurs,
- * (2) the result set type is TYPE_FORWARD_ONLY
- * and the fetch direction is not FETCH_FORWARD
,
+ * (2) the result set type is {@code TYPE_FORWARD_ONLY}
+ * and the fetch direction is not {@code FETCH_FORWARD},
* or (3) this rowset does not currently have a valid
* connection, prepared statement, and result set
* @see java.sql.Statement#setFetchDirection
@@ -2041,10 +2041,10 @@
/**
* Returns the fetch direction for this
- * ResultSet
object.
+ * {@code ResultSet} object.
*
* @return the current fetch direction for this rowset's
- * ResultSet
object
+ * {@code ResultSet} object
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -2061,16 +2061,16 @@
/**
* Gives the JDBC driver a hint as to the number of rows that should
* be fetched from the database when more rows are needed for this
- * ResultSet
object.
+ * {@code ResultSet} object.
* If the fetch size specified is zero, the JDBC driver
* ignores the value and is free to make its own best guess as to what
* the fetch size should be. The default value is set by the
- * Statement
object
+ * {@code Statement} object
* that created the result set. The fetch size may be changed at any time.
*
* @param rows the number of rows to fetch
* @throws SQLException if (1) a database access error occurs, (2) the
- * condition 0 <= rows <= this.getMaxRows()
is not
+ * condition {@code 0 <= rows <= this.getMaxRows()} is not
* satisfied, or (3) this rowset does not currently have a valid
* connection, prepared statement, and result set
*
@@ -2084,9 +2084,9 @@
/**
*
* Returns the fetch size for this
- * ResultSet
object.
+ * {@code ResultSet} object.
*
- * @return the current fetch size for this rowset's ResultSet
object
+ * @return the current fetch size for this rowset's {@code ResultSet} object
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -2111,12 +2111,12 @@
}
/**
- * Returns the concurrency mode of this rowset's ResultSet
object.
+ * Returns the concurrency mode of this rowset's {@code ResultSet} object.
* The concurrency used is determined by the
- * Statement
object that created the result set.
+ * {@code Statement} object that created the result set.
*
- * @return the concurrency type, either CONCUR_READ_ONLY
- * or CONCUR_UPDATABLE
+ * @return the concurrency type, either {@code CONCUR_READ_ONLY}
+ * or {@code CONCUR_UPDATABLE}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -2138,7 +2138,7 @@
* Indicates whether the current row has been updated. The value returned
* depends on whether or not the result set can detect updates.
*
- * @return true
if the row has been visibly updated
+ * @return {@code true} if the row has been visibly updated
* by the owner or another, and updates are detected
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
@@ -2154,10 +2154,10 @@
/**
* Indicates whether the current row has had an insertion.
* The value returned depends on whether or not this
- * ResultSet
object can detect visible inserts.
+ * {@code ResultSet} object can detect visible inserts.
*
- * @return true
if a row has had an insertion
- * and insertions are detected; false
otherwise
+ * @return {@code true} if a row has had an insertion
+ * and insertions are detected; {@code false} otherwise
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -2174,10 +2174,10 @@
* Indicates whether a row has been deleted. A deleted row may leave
* a visible "hole" in a result set. This method can be used to
* detect holes in a result set. The value returned depends on whether
- * or not this rowset's ResultSet
object can detect deletions.
+ * or not this rowset's {@code ResultSet} object can detect deletions.
*
- * @return true
if a row was deleted and deletions are detected;
- * false
otherwise
+ * @return {@code true} if a row was deleted and deletions are detected;
+ * {@code false} otherwise
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -2192,10 +2192,10 @@
/**
* Gives a nullable column a null value.
*
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
- * or insertRow
methods are called to update the database.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow}
+ * or {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @throws SQLException if a database access error occurs
@@ -2213,11 +2213,11 @@
}
/**
- * Updates the designated column with a boolean
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code boolean} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2237,11 +2237,11 @@
}
/**
- * Updates the designated column with a byte
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code byte} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
*
* @param columnIndex the first column is 1, the second is 2, and so on
@@ -2262,11 +2262,11 @@
}
/**
- * Updates the designated column with a short
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code short} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2286,11 +2286,11 @@
}
/**
- * Updates the designated column with an int
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with an {@code int} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2309,11 +2309,11 @@
}
/**
- * Updates the designated column with a long
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code long} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2333,11 +2333,11 @@
}
/**
- * Updates the designated column with a float
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code float} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2357,11 +2357,11 @@
}
/**
- * Updates the designated column with a double
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code double} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2381,12 +2381,12 @@
}
/**
- * Updates the designated column with a java.math.BigDecimal
+ * Updates the designated column with a {@code java.math.BigDecimal}
* value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2406,11 +2406,11 @@
}
/**
- * Updates the designated column with a String
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code String} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2430,11 +2430,11 @@
}
/**
- * Updates the designated column with a byte
array value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code byte} array value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2454,11 +2454,11 @@
}
/**
- * Updates the designated column with a java.sql.Date
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code java.sql.Date} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2479,11 +2479,11 @@
/**
- * Updates the designated column with a java.sql.Time
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code java.sql.Time} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2503,12 +2503,12 @@
}
/**
- * Updates the designated column with a java.sql.Timestamp
+ * Updates the designated column with a {@code java.sql.Timestamp}
* value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2529,10 +2529,10 @@
/**
* Updates the designated column with an ascii stream value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2554,10 +2554,10 @@
/**
* Updates the designated column with a binary stream value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2579,10 +2579,10 @@
/**
* Updates the designated column with a character stream value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2603,18 +2603,18 @@
}
/**
- * Updates the designated column with an Object
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with an {@code Object} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
- * @param scale for java.sql.Types.DECIMAl
- * or java.sql.Types.NUMERIC
types,
- * this is the number of digits after the decimal point. For all other
- * types this value will be ignored.
+ * @param scale for {@code java.sql.Types.DECIMAl}
+ * or {@code java.sql.Types.NUMERIC} types,
+ * this is the number of digits after the decimal point. For all other
+ * types this value will be ignored.
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -2631,11 +2631,11 @@
}
/**
- * Updates the designated column with an Object
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with an {@code Object} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, and so on
* @param x the new column value
@@ -2655,11 +2655,11 @@
}
/**
- * Updates the designated column with a null
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code null} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @throws SQLException if a database access error occurs
@@ -2672,11 +2672,11 @@
}
/**
- * Updates the designated column with a boolean
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code boolean} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2688,11 +2688,11 @@
}
/**
- * Updates the designated column with a byte
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code byte} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2704,11 +2704,11 @@
}
/**
- * Updates the designated column with a short
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code short} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2720,11 +2720,11 @@
}
/**
- * Updates the designated column with an int
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with an {@code int} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2736,11 +2736,11 @@
}
/**
- * Updates the designated column with a long
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code long} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2752,11 +2752,11 @@
}
/**
- * Updates the designated column with a float
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code float } value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2768,11 +2768,11 @@
}
/**
- * Updates the designated column with a double
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code double} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2784,12 +2784,12 @@
}
/**
- * Updates the designated column with a java.sql.BigDecimal
+ * Updates the designated column with a {@code java.sql.BigDecimal}
* value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2801,11 +2801,11 @@
}
/**
- * Updates the designated column with a String
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code String} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2817,19 +2817,19 @@
}
/**
- * Updates the designated column with a boolean
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code boolean} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* JDBC 2.0
*
* Updates a column with a byte array value.
*
- * The updateXXX
methods are used to update column values in the
- * current row, or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or insertRow
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row, or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or {@code insertRow}
* methods are called to update the database.
*
* @param columnName the name of the column
@@ -2842,11 +2842,11 @@
}
/**
- * Updates the designated column with a java.sql.Date
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code java.sql.Date} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2858,11 +2858,11 @@
}
/**
- * Updates the designated column with a java.sql.Time
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with a {@code java.sql.Time} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2874,12 +2874,12 @@
}
/**
- * Updates the designated column with a java.sql.Timestamp
+ * Updates the designated column with a {@code java.sql.Timestamp}
* value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2892,10 +2892,10 @@
/**
* Updates the designated column with an ascii stream value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2909,10 +2909,10 @@
/**
* Updates the designated column with a binary stream value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2926,14 +2926,14 @@
/**
* Updates the designated column with a character stream value.
- * The updateXXX
methods are used to update column values
- * in the current row or the insert row. The updateXXX
+ * The {@code updateXXX} methods are used to update column values
+ * in the current row or the insert row. The {@code updateXXX}
* methods do not update the underlying database; instead the
- * updateRow
or insertRow
methods are called
+ * {@code updateRow} or {@code insertRow} methods are called
* to update the database.
*
* @param columnName the name of the column
- * @param reader the new column Reader
stream value
+ * @param reader the new column {@code Reader} stream value
* @param length the length of the stream
* @throws SQLException if a database access error occurs
*
@@ -2943,16 +2943,16 @@
}
/**
- * Updates the designated column with an Object
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with an {@code Object} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
- * @param scale for java.sql.Types.DECIMAL
- * or java.sql.Types.NUMERIC
types,
+ * @param scale for {@code java.sql.Types.DECIMAL}
+ * or {@code java.sql.Types.NUMERIC} types,
* this is the number of digits after the decimal point. For all other
* types this value will be ignored.
* @throws SQLException if a database access error occurs
@@ -2963,11 +2963,11 @@
}
/**
- * Updates the designated column with an Object
value.
- * The updateXXX
methods are used to update column values in the
- * current row or the insert row. The updateXXX
methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * Updates the designated column with an {@code Object} value.
+ * The {@code updateXXX} methods are used to update column values in the
+ * current row or the insert row. The {@code updateXXX} methods do not
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnName the name of the column
* @param x the new column value
@@ -2980,7 +2980,7 @@
/**
* Inserts the contents of the insert row into this
- * ResultSet
object and into the database
+ * {@code ResultSet} object and into the database
* and also notifies listeners that a row has changed.
* The cursor must be on the insert row when this method is called.
*
@@ -3000,14 +3000,14 @@
/**
* Updates the underlying database with the new contents of the
- * current row of this rowset's ResultSet
object
+ * current row of this rowset's {@code ResultSet} object
* and notifies listeners that a row has changed.
* This method cannot be called when the cursor is on the insert row.
*
* @throws SQLException if (1) a database access error occurs,
* (2) this method is called when the cursor is
* on the insert row, (3) the concurrency of the result
- * set is ResultSet.CONCUR_READ_ONLY
, or
+ * set is {@code ResultSet.CONCUR_READ_ONLY}, or
* (4) this rowset does not currently have a valid connection,
* prepared statement, and result set
*/
@@ -3019,18 +3019,18 @@
}
/**
- * Deletes the current row from this rowset's ResultSet
object
+ * Deletes the current row from this rowset's {@code ResultSet} object
* and from the underlying database and also notifies listeners that a row
* has changed. This method cannot be called when the cursor is on the insert
* row.
*
* @throws SQLException if a database access error occurs
- * or if this method is called when the cursor is on the insert row
+ * or if this method is called when the cursor is on the insert row
* @throws SQLException if (1) a database access error occurs,
* (2) this method is called when the cursor is before the
* first row, after the last row, or on the insert row,
* (3) the concurrency of this rowset's result
- * set is ResultSet.CONCUR_READ_ONLY
, or
+ * set is {@code ResultSet.CONCUR_READ_ONLY}, or
* (4) this rowset does not currently have a valid connection,
* prepared statement, and result set
*/
@@ -3042,24 +3042,24 @@
}
/**
- * Refreshes the current row of this rowset's ResultSet
+ * Refreshes the current row of this rowset's {@code ResultSet}
* object with its most recent value in the database. This method
* cannot be called when the cursor is on the insert row.
*
- *
The refreshRow
method provides a way for an
+ *
The {@code refreshRow} method provides a way for an
* application to explicitly tell the JDBC driver to refetch
* a row(s) from the database. An application may want to call
- * refreshRow
when caching or prefetching is being
+ * {@code refreshRow} when caching or prefetching is being
* done by the JDBC driver to fetch the latest value of a row
* from the database. The JDBC driver may actually refresh multiple
* rows at once if the fetch size is greater than one.
*
*
All values are refetched subject to the transaction isolation
- * level and cursor sensitivity. If refreshRow
is called after
- * calling an updateXXX
method, but before calling
- * the method updateRow
, then the
+ * level and cursor sensitivity. If {@code refreshRow} is called after
+ * calling an {@code updateXXX} method, but before calling
+ * the method {@code updateRow}, then the
* updates made to the row are lost. Calling the method
- * refreshRow
frequently will likely slow performance.
+ * {@code refreshRow} frequently will likely slow performance.
*
* @throws SQLException if (1) a database access error occurs,
* (2) this method is called when the cursor is
@@ -3076,12 +3076,12 @@
/**
* Cancels the updates made to the current row in this
- * ResultSet
object and notifies listeners that a row
+ * {@code ResultSet} object and notifies listeners that a row
* has changed. This method may be called after calling an
- * updateXXX
method(s) and before calling
- * the method updateRow
to roll back
+ * {@code updateXXX} method(s) and before calling
+ * the method {@code updateRow} to roll back
* the updates made to a row. If no updates have been made or
- * updateRow
has already been called, this method has no
+ * {@code updateRow} has already been called, this method has no
* effect.
*
* @throws SQLException if (1) a database access error occurs,
@@ -3104,19 +3104,19 @@
*
* The insert row is a special row associated with an updatable
* result set. It is essentially a buffer where a new row may
- * be constructed by calling the updateXXX
methods prior to
+ * be constructed by calling the {@code updateXXX} methods prior to
* inserting the row into the result set.
*
- * Only the updateXXX
, getXXX
,
- * and insertRow
methods may be
+ * Only the {@code updateXXX}, {@code getXXX},
+ * and {@code insertRow} methods may be
* called when the cursor is on the insert row. All of the columns in
* a result set must be given a value each time this method is
- * called before calling insertRow
.
- * An updateXXX
method must be called before a
- * getXXX
method can be called on a column value.
+ * called before calling {@code insertRow}.
+ * An {@code updateXXX} method must be called before a
+ * {@code getXXX} method can be called on a column value.
*
* @throws SQLException if (1) a database access error occurs,
- * (2) this rowset's ResultSet
object is
+ * (2) this rowset's {@code ResultSet} object is
* not updatable, or (3) this rowset does not
* currently have a valid connection, prepared statement,
* and result set
@@ -3134,7 +3134,7 @@
* the insert row.
*
* @throws SQLException if (1) a database access error occurs,
- * (2) this rowset's ResultSet
object is
+ * (2) this rowset's {@code ResultSet} object is
* not updatable, or (3) this rowset does not
* currently have a valid connection, prepared statement,
* and result set
@@ -3146,14 +3146,14 @@
}
/**
- * Returns the Statement
object that produced this
- * ResultSet
object.
+ * Returns the {@code Statement} object that produced this
+ * {@code ResultSet} object.
* If the result set was generated some other way, such as by a
- * DatabaseMetaData
method, this method returns
- * null
.
+ * {@code DatabaseMetaData} method, this method returns
+ * {@code null}.
*
- * @return the Statement
object that produced
- * this rowset's ResultSet
object or null
+ * @return the {@code Statement} object that produced
+ * this rowset's {@code ResultSet} object or {@code null}
* if the result set was produced some other way
* @throws SQLException if a database access error occurs
*/
@@ -3169,16 +3169,16 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as an Object
.
- * This method uses the given Map
object
+ * of this rowset's {@code ResultSet} object as an {@code Object}.
+ * This method uses the given {@code Map} object
* for the custom mapping of the
* SQL structured or distinct type that is being retrieved.
*
* @param i the first column is 1, the second is 2, and so on
- * @param map a java.util.Map
object that contains the mapping
- * from SQL type names to classes in the Java programming language
- * @return an Object
in the Java programming language
- * representing the SQL value
+ * @param map a {@code java.util.Map} object that contains the mapping
+ * from SQL type names to classes in the Java programming language
+ * @return an {@code Object} in the Java programming language
+ * representing the SQL value
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -3193,10 +3193,10 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a Ref
object.
+ * of this rowset's {@code ResultSet} object as a {@code Ref} object.
*
* @param i the first column is 1, the second is 2, and so on
- * @return a Ref
object representing an SQL REF
value
+ * @return a {@code Ref} object representing an SQL {@code REF} value
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -3210,10 +3210,10 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a Blob
object.
+ * of this rowset's {@code ResultSet} object as a {@code Blob} object.
*
* @param i the first column is 1, the second is 2, and so on
- * @return a Blob
object representing the SQL BLOB
+ * @return a {@code Blob} object representing the SQL {@code BLOB}
* value in the specified column
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
@@ -3227,10 +3227,10 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a Clob
object.
+ * of this rowset's {@code ResultSet} object as a {@code Clob} object.
*
* @param i the first column is 1, the second is 2, and so on
- * @return a Clob
object representing the SQL CLOB
+ * @return a {@code Clob} object representing the SQL {@code CLOB}
* value in the specified column
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
@@ -3244,10 +3244,10 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as an Array
object.
+ * of this rowset's {@code ResultSet} object as an {@code Array} object.
*
* @param i the first column is 1, the second is 2, and so on.
- * @return an Array
object representing the SQL ARRAY
+ * @return an {@code Array} object representing the SQL {@code ARRAY}
* value in the specified column
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
@@ -3261,14 +3261,14 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as an Object
.
- * This method uses the specified Map
object for
+ * of this rowset's {@code ResultSet} object as an {@code Object}.
+ * This method uses the specified {@code Map} object for
* custom mapping if appropriate.
*
* @param colName the name of the column from which to retrieve the value
- * @param map a java.util.Map
object that contains the mapping
+ * @param map a {@code java.util.Map} object that contains the mapping
* from SQL type names to classes in the Java programming language
- * @return an Object
representing the SQL
+ * @return an {@code Object} representing the SQL
* value in the specified column
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
@@ -3282,10 +3282,10 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a Ref
object.
+ * of this rowset's {@code ResultSet} object as a {@code Ref} object.
*
* @param colName the column name
- * @return a Ref
object representing the SQL REF
value in
+ * @return a {@code Ref} object representing the SQL {@code REF} value in
* the specified column
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
@@ -3297,10 +3297,10 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a Blob
object.
+ * of this rowset's {@code ResultSet} object as a {@code Blob} object.
*
* @param colName the name of the column from which to retrieve the value
- * @return a Blob
object representing the SQL BLOB
+ * @return a {@code Blob} object representing the SQL {@code BLOB}
* value in the specified column
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
@@ -3312,10 +3312,10 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a Clob
object.
+ * of this rowset's {@code ResultSet} object as a {@code Clob} object.
*
* @param colName the name of the column from which to retrieve the value
- * @return a Clob
object representing the SQL CLOB
+ * @return a {@code Clob} object representing the SQL {@code CLOB}
* value in the specified column
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
@@ -3327,10 +3327,10 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as an Array
object.
+ * of this rowset's {@code ResultSet} object as an {@code Array} object.
*
* @param colName the name of the column from which to retrieve the value
- * @return an Array
object representing the SQL ARRAY
+ * @return an {@code Array} object representing the SQL {@code ARRAY}
* value in the specified column
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
@@ -3342,17 +3342,17 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a java.sql.Date
+ * of this rowset's {@code ResultSet} object as a {@code java.sql.Date}
* object. This method uses the given calendar to construct an appropriate
* millisecond value for the date if the underlying database does not store
* timezone information.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @param cal the java.util.Calendar
object
+ * @param cal the {@code java.util.Calendar} object
* to use in constructing the date
- * @return the column value as a java.sql.Date
object;
- * if the value is SQL NULL
,
- * the value returned is null
+ * @return the column value as a {@code java.sql.Date} object;
+ * if the value is SQL {@code NULL},
+ * the value returned is {@code null}
* @throws SQLException if (1) a database access error occurs
* or (2) this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -3365,17 +3365,17 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a java.sql.Date
+ * of this rowset's {@code ResultSet} object as a {@code java.sql.Date}
* object. This method uses the given calendar to construct an appropriate
* millisecond value for the date if the underlying database does not store
* timezone information.
*
* @param columnName the SQL name of the column from which to retrieve the value
- * @param cal the java.util.Calendar
object
+ * @param cal the {@code java.util.Calendar} object
* to use in constructing the date
- * @return the column value as a java.sql.Date
object;
- * if the value is SQL NULL
,
- * the value returned is null
+ * @return the column value as a {@code java.sql.Date} object;
+ * if the value is SQL {@code NULL},
+ * the value returned is {@code null}
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -3387,17 +3387,17 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a java.sql.Time
+ * of this rowset's {@code ResultSet} object as a {@code java.sql.Time}
* object. This method uses the given calendar to construct an appropriate
* millisecond value for the date if the underlying database does not store
* timezone information.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @param cal the java.util.Calendar
object
+ * @param cal the {@code java.util.Calendar} object
* to use in constructing the time
- * @return the column value as a java.sql.Time
object;
- * if the value is SQL NULL
,
- * the value returned is null
in the Java programming language
+ * @return the column value as a {@code java.sql.Time} object;
+ * if the value is SQL {@code NULL},
+ * the value returned is {@code null} in the Java programming language
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -3410,17 +3410,17 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a java.sql.Time
+ * of this rowset's {@code ResultSet} object as a {@code java.sql.Time}
* object. This method uses the given calendar to construct an appropriate
* millisecond value for the date if the underlying database does not store
* timezone information.
*
* @param columnName the SQL name of the column
- * @param cal the java.util.Calendar
object
+ * @param cal the {@code java.util.Calendar} object
* to use in constructing the time
- * @return the column value as a java.sql.Time
object;
- * if the value is SQL NULL
,
- * the value returned is null
in the Java programming language
+ * @return the column value as a {@code java.sql.Time} object;
+ * if the value is SQL {@code NULL},
+ * the value returned is {@code null} in the Java programming language
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -3431,18 +3431,18 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a
- * java.sql.Timestamp
object.
+ * of this rowset's {@code ResultSet} object as a
+ * {@code java.sql.Timestamp} object.
* This method uses the given calendar to construct an appropriate millisecond
* value for the timestamp if the underlying database does not store
* timezone information.
*
* @param columnIndex the first column is 1, the second is 2, and so on
- * @param cal the java.util.Calendar
object
+ * @param cal the {@code java.util.Calendar} object
* to use in constructing the timestamp
- * @return the column value as a java.sql.Timestamp
object;
- * if the value is SQL NULL
,
- * the value returned is null
+ * @return the column value as a {@code java.sql.Timestamp} object;
+ * if the value is SQL {@code NULL},
+ * the value returned is {@code null}
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -3455,18 +3455,18 @@
/**
* Returns the value of the designated column in the current row
- * of this rowset's ResultSet
object as a
- * java.sql.Timestamp
object.
+ * of this rowset's {@code ResultSet} object as a
+ * {@code java.sql.Timestamp} object.
* This method uses the given calendar to construct an appropriate millisecond
* value for the timestamp if the underlying database does not store
* timezone information.
*
* @param columnName the SQL name of the column
- * @param cal the java.util.Calendar
object
+ * @param cal the {@code java.util.Calendar} object
* to use in constructing the timestamp
- * @return the column value as a java.sql.Timestamp
object;
- * if the value is SQL NULL
,
- * the value returned is null
+ * @return the column value as a {@code java.sql.Timestamp} object;
+ * if the value is SQL {@code NULL},
+ * the value returned is {@code null}
* @throws SQLException if a database access error occurs
* or this rowset does not currently have a valid connection,
* prepared statement, and result set
@@ -3478,8 +3478,8 @@
/**
* Sets the designated column in either the current row or the insert
- * row of this JdbcRowSetImpl
object with the given
- * double
value.
+ * row of this {@code JdbcRowSetImpl} object with the given
+ * {@code double} value.
*
* This method updates a column value in either the current row or
* the insert row of this rowset, but it does not update the
@@ -3490,14 +3490,14 @@
* and the database. Both of these methods must be called before the
* cursor moves to another row.
*
- * @param columnIndex the first column is 1
, the second
- * is 2
, and so on; must be 1
or larger
+ * @param columnIndex the first column is {@code 1}, the second
+ * is {@code 2}, and so on; must be {@code 1} or larger
* and equal to or less than the number of columns in this rowset
- * @param ref the new Ref
column value
+ * @param ref the new {@code Ref} column value
* @throws SQLException if (1) the given column index is out of bounds,
* (2) the cursor is not on one of this rowset's rows or its
* insert row, or (3) this rowset is
- * ResultSet.CONCUR_READ_ONLY
+ * {@code ResultSet.CONCUR_READ_ONLY}
*/
public void updateRef(int columnIndex, java.sql.Ref ref)
throws SQLException {
@@ -3507,8 +3507,8 @@
/**
* Sets the designated column in either the current row or the insert
- * row of this JdbcRowSetImpl
object with the given
- * double
value.
+ * row of this {@code JdbcRowSetImpl} object with the given
+ * {@code double} value.
*
* This method updates a column value in either the current row or
* the insert row of this rowset, but it does not update the
@@ -3519,13 +3519,13 @@
* and the database. Both of these methods must be called before the
* cursor moves to another row.
*
- * @param columnName a String
object that must match the
+ * @param columnName a {@code String} object that must match the
* SQL name of a column in this rowset, ignoring case
* @param ref the new column value
* @throws SQLException if (1) the given column name does not match the
* name of a column in this rowset, (2) the cursor is not on
* one of this rowset's rows or its insert row, or (3) this
- * rowset is ResultSet.CONCUR_READ_ONLY
+ * rowset is {@code ResultSet.CONCUR_READ_ONLY}
*/
public void updateRef(String columnName, java.sql.Ref ref)
throws SQLException {
@@ -3534,8 +3534,8 @@
/**
* Sets the designated column in either the current row or the insert
- * row of this JdbcRowSetImpl
object with the given
- * double
value.
+ * row of this {@code JdbcRowSetImpl} object with the given
+ * {@code double} value.
*
* This method updates a column value in either the current row or
* the insert row of this rowset, but it does not update the
@@ -3546,14 +3546,14 @@
* and the database. Both of these methods must be called before the
* cursor moves to another row.
*
- * @param columnIndex the first column is 1
, the second
- * is 2
, and so on; must be 1
or larger
+ * @param columnIndex the first column is {@code 1}, the second
+ * is {@code 2}, and so on; must be {@code 1} or larger
* and equal to or less than the number of columns in this rowset
- * @param c the new column Clob
value
+ * @param c the new column {@code Clob} value
* @throws SQLException if (1) the given column index is out of bounds,
* (2) the cursor is not on one of this rowset's rows or its
* insert row, or (3) this rowset is
- * ResultSet.CONCUR_READ_ONLY
+ * {@code ResultSet.CONCUR_READ_ONLY}
*/
public void updateClob(int columnIndex, Clob c) throws SQLException {
checkState();
@@ -3563,8 +3563,8 @@
/**
* Sets the designated column in either the current row or the insert
- * row of this JdbcRowSetImpl
object with the given
- * double
value.
+ * row of this {@code JdbcRowSetImpl} object with the given
+ * {@code double} value.
*
* This method updates a column value in either the current row or
* the insert row of this rowset, but it does not update the
@@ -3575,13 +3575,13 @@
* and the database. Both of these methods must be called before the
* cursor moves to another row.
*
- * @param columnName a String
object that must match the
+ * @param columnName a {@code String} object that must match the
* SQL name of a column in this rowset, ignoring case
- * @param c the new column Clob
value
+ * @param c the new column {@code Clob} value
* @throws SQLException if (1) the given column name does not match the
* name of a column in this rowset, (2) the cursor is not on
* one of this rowset's rows or its insert row, or (3) this
- * rowset is ResultSet.CONCUR_READ_ONLY
+ * rowset is {@code ResultSet.CONCUR_READ_ONLY}
*/
public void updateClob(String columnName, Clob c) throws SQLException {
updateClob(findColumn(columnName), c);
@@ -3589,8 +3589,8 @@
/**
* Sets the designated column in either the current row or the insert
- * row of this JdbcRowSetImpl
object with the given
- * java.sql.Blob
value.
+ * row of this {@code JdbcRowSetImpl} object with the given
+ * {@code java.sql.Blob} value.
*
* This method updates a column value in either the current row or
* the insert row of this rowset, but it does not update the
@@ -3601,14 +3601,14 @@
* and the database. Both of these methods must be called before the
* cursor moves to another row.
*
- * @param columnIndex the first column is 1
, the second
- * is 2
, and so on; must be 1
or larger
+ * @param columnIndex the first column is {@code 1}, the second
+ * is {@code 2}, and so on; must be {@code 1} or larger
* and equal to or less than the number of columns in this rowset
- * @param b the new column Blob
value
+ * @param b the new column {@code Blob} value
* @throws SQLException if (1) the given column index is out of bounds,
* (2) the cursor is not on one of this rowset's rows or its
* insert row, or (3) this rowset is
- * ResultSet.CONCUR_READ_ONLY
+ * {@code ResultSet.CONCUR_READ_ONLY}
*/
public void updateBlob(int columnIndex, Blob b) throws SQLException {
checkState();
@@ -3617,8 +3617,8 @@
/**
* Sets the designated column in either the current row or the insert
- * row of this JdbcRowSetImpl
object with the given
- * java.sql.Blob
value.
+ * row of this {@code JdbcRowSetImpl} object with the given
+ * {@code java.sql.Blob } value.
*
* This method updates a column value in either the current row or
* the insert row of this rowset, but it does not update the
@@ -3629,13 +3629,13 @@
* and the database. Both of these methods must be called before the
* cursor moves to another row.
*
- * @param columnName a String
object that must match the
+ * @param columnName a {@code String} object that must match the
* SQL name of a column in this rowset, ignoring case
- * @param b the new column Blob
value
+ * @param b the new column {@code Blob} value
* @throws SQLException if (1) the given column name does not match the
* name of a column in this rowset, (2) the cursor is not on
* one of this rowset's rows or its insert row, or (3) this
- * rowset is ResultSet.CONCUR_READ_ONLY
+ * rowset is {@code ResultSet.CONCUR_READ_ONLY}
*/
public void updateBlob(String columnName, Blob b) throws SQLException {
updateBlob(findColumn(columnName), b);
@@ -3643,8 +3643,8 @@
/**
* Sets the designated column in either the current row or the insert
- * row of this JdbcRowSetImpl
object with the given
- * java.sql.Array
values.
+ * row of this {@code JdbcRowSetImpl} object with the given
+ * {@code java.sql.Array} values.
*
* This method updates a column value in either the current row or
* the insert row of this rowset, but it does not update the
@@ -3655,14 +3655,14 @@
* and the database. Both of these methods must be called before the
* cursor moves to another row.
*
- * @param columnIndex the first column is 1
, the second
- * is 2
, and so on; must be 1
or larger
+ * @param columnIndex the first column is {@code 1}, the second
+ * is {@code 2}, and so on; must be {@code 1} or larger
* and equal to or less than the number of columns in this rowset
- * @param a the new column Array
value
+ * @param a the new column {@code Array} value
* @throws SQLException if (1) the given column index is out of bounds,
* (2) the cursor is not on one of this rowset's rows or its
* insert row, or (3) this rowset is
- * ResultSet.CONCUR_READ_ONLY
+ * {@code ResultSet.CONCUR_READ_ONLY}
*/
public void updateArray(int columnIndex, Array a) throws SQLException {
checkState();
@@ -3671,8 +3671,8 @@
/**
* Sets the designated column in either the current row or the insert
- * row of this JdbcRowSetImpl
object with the given
- * java.sql.Array
value.
+ * row of this {@code JdbcRowSetImpl} object with the given
+ * {@code java.sql.Array} value.
*
* This method updates a column value in either the current row or
* the insert row of this rowset, but it does not update the
@@ -3683,20 +3683,20 @@
* and the database. Both of these methods must be called before the
* cursor moves to another row.
*
- * @param columnName a String
object that must match the
+ * @param columnName a {@code String} object that must match the
* SQL name of a column in this rowset, ignoring case
- * @param a the new column Array
value
+ * @param a the new column {@code Array} value
* @throws SQLException if (1) the given column name does not match the
* name of a column in this rowset, (2) the cursor is not on
* one of this rowset's rows or its insert row, or (3) this
- * rowset is ResultSet.CONCUR_READ_ONLY
+ * rowset is {@code ResultSet.CONCUR_READ_ONLY}
*/
public void updateArray(String columnName, Array a) throws SQLException {
updateArray(findColumn(columnName), a);
}
/**
- * Provide interface coverage for getURL(int) in ResultSet->RowSet
+ * Provide interface coverage for getURL(int) in {@code ResultSet->RowSet}
*/
public java.net.URL getURL(int columnIndex) throws SQLException {
checkState();
@@ -3704,7 +3704,7 @@
}
/**
- * Provide interface coverage for getURL(String) in ResultSet->RowSet
+ * Provide interface coverage for getURL(String) in {@code ResultSet->RowSet}
*/
public java.net.URL getURL(String columnName) throws SQLException {
return getURL(findColumn(columnName));
@@ -3712,14 +3712,14 @@
/**
* Return the RowSetWarning object for the current row of a
- * JdbcRowSetImpl
+ * {@code JdbcRowSetImpl}
*/
public RowSetWarning getRowSetWarnings() throws SQLException {
return null;
}
/**
* Unsets the designated parameter to the given int array.
- * This was set using setMatchColumn
+ * This was set using {@code setMatchColumn}
* as the column which will form the basis of the join.
*
* The parameter value unset by this method should be same
@@ -3728,8 +3728,8 @@
* @param columnIdxes the index into this rowset
* object's internal representation of parameter values
* @throws SQLException if an error occurs or the
- * parameter index is out of bounds or if the columnIdx is
- * not the same as set using setMatchColumn(int [])
+ * parameter index is out of bounds or if the columnIdx is
+ * not the same as set using {@code setMatchColumn(int [])}
*/
public void unsetMatchColumn(int[] columnIdxes) throws SQLException {
@@ -3748,7 +3748,7 @@
/**
* Unsets the designated parameter to the given String array.
- * This was set using setMatchColumn
+ * This was set using {@code setMatchColumn}
* as the column which will form the basis of the join.
*
* The parameter value unset by this method should be same
@@ -3757,8 +3757,8 @@
* @param columnIdxes the index into this rowset
* object's internal representation of parameter values
* @throws SQLException if an error occurs or the
- * parameter index is out of bounds or if the columnName is
- * not the same as set using setMatchColumn(String [])
+ * parameter index is out of bounds or if the columnName is
+ * not the same as set using {@code setMatchColumn(String [])}
*/
public void unsetMatchColumn(String[] columnIdxes) throws SQLException {
@@ -3774,11 +3774,11 @@
}
/**
- * Retrieves the column name as String
array
- * that was set using setMatchColumn(String [])
+ * Retrieves the column name as {@code String} array
+ * that was set using {@code setMatchColumn(String [])}
* for this rowset.
*
- * @return a String
array object that contains the column names
+ * @return a {@code String} array object that contains the column names
* for the rowset which has this the match columns
*
* @throws SQLException if an error occurs or column name is not set
@@ -3796,10 +3796,10 @@
}
/**
- * Retrieves the column id as int
array that was set using
- * setMatchColumn(int [])
for this rowset.
+ * Retrieves the column id as {@code int} array that was set using
+ * {@code setMatchColumn(int [])} for this rowset.
*
- * @return a int
array object that contains the column ids
+ * @return a {@code int} array object that contains the column ids
* for the rowset which has this as the match columns.
*
* @throws SQLException if an error occurs or column index is not set
@@ -3829,19 +3829,19 @@
/**
* Sets the designated parameter to the given int array.
* This forms the basis of the join for the
- * JoinRowSet
as the column which will form the basis of the
+ * {@code JoinRowSet} as the column which will form the basis of the
* join.
*
* The parameter value set by this method is stored internally and
* will be supplied as the appropriate parameter in this rowset's
- * command when the method getMatchColumnIndexes
is called.
+ * command when the method {@code getMatchColumnIndexes} is called.
*
* @param columnIdxes the indexes into this rowset
* object's internal representation of parameter values; the
* first parameter is 0, the second is 1, and so on; must be
- * 0
or greater
+ * {@code 0} or greater
* @throws SQLException if an error occurs or the
- * parameter index is out of bounds
+ * parameter index is out of bounds
*/
public void setMatchColumn(int[] columnIdxes) throws SQLException {
@@ -3858,17 +3858,17 @@
/**
* Sets the designated parameter to the given String array.
* This forms the basis of the join for the
- * JoinRowSet
as the column which will form the basis of the
+ * {@code JoinRowSet} as the column which will form the basis of the
* join.
*
* The parameter value set by this method is stored internally and
* will be supplied as the appropriate parameter in this rowset's
- * command when the method getMatchColumn
is called.
+ * command when the method {@code getMatchColumn} is called.
*
* @param columnNames the name of the column into this rowset
* object's internal representation of parameter values
* @throws SQLException if an error occurs or the
- * parameter index is out of bounds
+ * parameter index is out of bounds
*/
public void setMatchColumn(String[] columnNames) throws SQLException {
@@ -3883,22 +3883,22 @@
}
- /**
- * Sets the designated parameter to the given int
+ /**
+ * Sets the designated parameter to the given {@code int}
* object. This forms the basis of the join for the
- * JoinRowSet
as the column which will form the basis of the
+ * {@code JoinRowSet} as the column which will form the basis of the
* join.
*
* The parameter value set by this method is stored internally and
* will be supplied as the appropriate parameter in this rowset's
- * command when the method getMatchColumn
is called.
+ * command when the method {@code getMatchColumn} is called.
*
* @param columnIdx the index into this rowset
* object's internal representation of parameter values; the
* first parameter is 0, the second is 1, and so on; must be
- * 0
or greater
+ * {@code 0} or greater
* @throws SQLException if an error occurs or the
- * parameter index is out of bounds
+ * parameter index is out of bounds
*/
public void setMatchColumn(int columnIdx) throws SQLException {
// validate, if col is ok to be set
@@ -3912,19 +3912,19 @@
}
/**
- * Sets the designated parameter to the given String
+ * Sets the designated parameter to the given {@code String}
* object. This forms the basis of the join for the
- * JoinRowSet
as the column which will form the basis of the
+ * {@code JoinRowSet} as the column which will form the basis of the
* join.
*
* The parameter value set by this method is stored internally and
* will be supplied as the appropriate parameter in this rowset's
- * command when the method getMatchColumn
is called.
+ * command when the method {@code getMatchColumn} is called.
*
* @param columnName the name of the column into this rowset
* object's internal representation of parameter values
* @throws SQLException if an error occurs or the
- * parameter index is out of bounds
+ * parameter index is out of bounds
*/
public void setMatchColumn(String columnName) throws SQLException {
// validate, if col is ok to be set
@@ -3938,8 +3938,8 @@
}
/**
- * Unsets the designated parameter to the given int
- * object. This was set using setMatchColumn
+ * Unsets the designated parameter to the given {@code int}
+ * object. This was set using {@code setMatchColumn}
* as the column which will form the basis of the join.
*
* The parameter value unset by this method should be same
@@ -3948,8 +3948,8 @@
* @param columnIdx the index into this rowset
* object's internal representation of parameter values
* @throws SQLException if an error occurs or the
- * parameter index is out of bounds or if the columnIdx is
- * not the same as set using setMatchColumn(int)
+ * parameter index is out of bounds or if the columnIdx is
+ * not the same as set using {@code setMatchColumn(int)}
*/
public void unsetMatchColumn(int columnIdx) throws SQLException {
// check if we are unsetting the SAME column
@@ -3964,8 +3964,8 @@
}
/**
- * Unsets the designated parameter to the given String
- * object. This was set using setMatchColumn
+ * Unsets the designated parameter to the given {@code String}
+ * object. This was set using {@code setMatchColumn}
* as the column which will form the basis of the join.
*
* The parameter value unset by this method should be same
@@ -3974,8 +3974,8 @@
* @param columnName the index into this rowset
* object's internal representation of parameter values
* @throws SQLException if an error occurs or the
- * parameter index is out of bounds or if the columnName is
- * not the same as set using setMatchColumn(String)
+ * parameter index is out of bounds or if the columnName is
+ * not the same as set using {@code setMatchColumn(String)}
*
*/
public void unsetMatchColumn(String columnName) throws SQLException {
@@ -3992,12 +3992,12 @@
}
/**
- * Retrieves the DatabaseMetaData
associated with
+ * Retrieves the {@code DatabaseMetaData} associated with
* the connection handle associated with this
- * JdbcRowSet
object.
+ * {@code JdbcRowSet} object.
*
- * @return the DatabaseMetadata
associated
- * with the rowset's connection.
+ * @return the {@code DatabaseMetadata} associated
+ * with the rowset's connection.
* @throws SQLException if a database access error occurs
*/
public DatabaseMetaData getDatabaseMetaData() throws SQLException {
@@ -4006,12 +4006,12 @@
}
/**
- * Retrieves the ParameterMetaData
associated with
+ * Retrieves the {@code ParameterMetaData} associated with
* the connection handle associated with this
- * JdbcRowSet
object.
+ * {@code JdbcRowSet} object.
*
- * @return the ParameterMetadata
associated
- * with the rowset's connection.
+ * @return the {@code ParameterMetadata} associated
+ * with the rowset's connection.
* @throws SQLException if a database access error occurs
*/
public ParameterMetaData getParameterMetaData() throws SQLException {
@@ -4020,18 +4020,18 @@
}
/**
- * Commits all updates in this JdbcRowSet
object by
- * wrapping the internal Connection
object and calling
- * its commit
method.
- * This method sets this JdbcRowSet
object's private field
- * rs
to null
after saving its value to another
- * object, but only if the ResultSet
- * constant HOLD_CURSORS_OVER_COMMIT
has not been set.
- * (The field rs
is this JdbcRowSet
object's
- * ResultSet
object.)
+ * Commits all updates in this {@code JdbcRowSet} object by
+ * wrapping the internal {@code Connection} object and calling
+ * its {@code commit} method.
+ * This method sets this {@code JdbcRowSet} object's private field
+ * {@code rs} to {@code null} after saving its value to another
+ * object, but only if the {@code ResultSet}
+ * constant {@code HOLD_CURSORS_OVER_COMMIT} has not been set.
+ * (The field {@code rs} is this {@code JdbcRowSet} object's
+ * {@code ResultSet} object.)
*
* @throws SQLException if autoCommit is set to true or if a database
- * access error occurs
+ * access error occurs
*/
public void commit() throws SQLException {
conn.commit();
@@ -4045,8 +4045,8 @@
}
/**
- * Sets auto-commit on the internal Connection
object with this
- * JdbcRowSet
+ * Sets auto-commit on the internal {@code Connection} object with this
+ * {@code JdbcRowSet}
*
* @throws SQLException if a database access error occurs
*/
@@ -4074,7 +4074,7 @@
}
/**
- * Returns the auto-commit status with this JdbcRowSet
.
+ * Returns the auto-commit status with this {@code JdbcRowSet}.
*
* @return true if auto commit is true; false otherwise
* @throws SQLException if a database access error occurs
@@ -4084,16 +4084,16 @@
}
/**
- * Rolls back all the updates in this JdbcRowSet
object by
- * wrapping the internal Connection
object and calling its
- * rollback
method.
- * This method sets this JdbcRowSet
object's private field
- * rs
to null
after saving its value to another object.
- * (The field rs
is this JdbcRowSet
object's
- * internal ResultSet
object.)
+ * Rolls back all the updates in this {@code JdbcRowSet} object by
+ * wrapping the internal {@code Connection} object and calling its
+ * {@code rollback} method.
+ * This method sets this {@code JdbcRowSet} object's private field
+ * {@code rs} to {@code null} after saving its value to another object.
+ * (The field {@code rs} is this {@code JdbcRowSet} object's
+ * internal {@code ResultSet} object.)
*
* @throws SQLException if autoCommit is set to true or a database
- * access error occurs
+ * access error occurs
*/
public void rollback() throws SQLException {
conn.rollback();
@@ -4106,14 +4106,14 @@
/**
- * Rollbacks all the updates in the JdbcRowSet
back to the
- * last Savepoint
transaction marker. Wraps the internal
- * Connection
object and call it's rollback method
+ * Rollbacks all the updates in the {@code JdbcRowSet} back to the
+ * last {@code Savepoint} transaction marker. Wraps the internal
+ * {@code Connection} object and call it's rollback method
*
- * @param s the Savepoint
transaction marker to roll the
- * transaction to.
+ * @param s the {@code Savepoint} transaction marker to roll the
+ * transaction to.
* @throws SQLException if autoCommit is set to true; or ia a database
- * access error occurs
+ * access error occurs
*/
public void rollback(Savepoint s) throws SQLException {
conn.rollback(s);
@@ -4144,10 +4144,10 @@
// Added as per Rave requirements
/**
- * Gets this JdbcRowSet
object's Connection property
+ * Gets this {@code JdbcRowSet} object's Connection property
*
*
- * @return the Connection
object associated with this rowset;
+ * @return the {@code Connection} object associated with this rowset;
*/
protected Connection getConnection() {
@@ -4158,10 +4158,10 @@
// Added as per rave requirements
/**
- * Sets this JdbcRowSet
object's connection property
- * to the given Connection
object.
+ * Sets this {@code JdbcRowSet} object's connection property
+ * to the given {@code Connection} object.
*
- * @param connection the Connection
object.
+ * @param connection the {@code Connection} object.
*/
protected void setConnection(Connection connection) {
@@ -4172,10 +4172,10 @@
// Added as per Rave requirements
/**
- * Gets this JdbcRowSet
object's PreparedStatement property
+ * Gets this {@code JdbcRowSet} object's PreparedStatement property
*
*
- * @return the PreparedStatement
object associated with this rowset;
+ * @return the {@code PreparedStatement} object associated with this rowset;
*/
protected PreparedStatement getPreparedStatement() {
@@ -4186,10 +4186,10 @@
// Added as per Rave requirements
/**
- * Sets this JdbcRowSet
object's preparedtsatement property
- * to the given PreparedStatemennt
object.
+ * Sets this {@code JdbcRowSet} object's preparedtsatement property
+ * to the given {@code PreparedStatemennt} object.
*
- * @param preparedStatement the PreparedStatement
object
+ * @param preparedStatement the {@code PreparedStatement} object
*
*/
protected void setPreparedStatement(PreparedStatement preparedStatement) {
@@ -4200,10 +4200,10 @@
// Added as per Rave requirements
/**
- * Gets this JdbcRowSet
object's ResultSet property
+ * Gets this {@code JdbcRowSet} object's ResultSet property
*
*
- * @return the ResultSet
object associated with this rowset;
+ * @return the {@code ResultSet} object associated with this rowset;
*/
protected ResultSet getResultSet() throws SQLException {
@@ -4217,10 +4217,10 @@
// Added as per Rave requirements
/**
- * Sets this JdbcRowSet
object's resultset property
- * to the given ResultSet
object.
+ * Sets this {@code JdbcRowSet} object's resultset property
+ * to the given {@code ResultSet} object.
*
- * @param resultSet the ResultSet
object
+ * @param resultSet the {@code ResultSet} object
*
*/
protected void setResultSet(ResultSet resultSet) {
@@ -4228,25 +4228,25 @@
}
/**
- * Sets this JdbcRowSet
object's command
property to
- * the given String
object and clears the parameters, if any,
+ * Sets this {@code JdbcRowSet} object's {@code command} property to
+ * the given {@code String} object and clears the parameters, if any,
* that were set for the previous command. In addition,
- * if the command
property has previously been set to a
+ * if the {@code command} property has previously been set to a
* non-null value and it is
- * different from the String
object supplied,
- * this method sets this JdbcRowSet
object's private fields
- * ps
and rs
to null
.
- * (The field ps
is its PreparedStatement
object, and
- * the field rs
is its ResultSet
object.)
+ * different from the {@code String} object supplied,
+ * this method sets this {@code JdbcRowSet} object's private fields
+ * {@code ps} and {@code rs} to {@code null}.
+ * (The field {@code ps} is its {@code PreparedStatement} object, and
+ * the field {@code rs} is its {@code ResultSet} object.)
*
- * The command
property may not be needed if the RowSet
+ * The {@code command} property may not be needed if the {@code RowSet}
* object gets its data from a source that does not support commands,
* such as a spreadsheet or other tabular file.
- * Thus, this property is optional and may be null
.
+ * Thus, this property is optional and may be {@code null}.
*
- * @param command a String
object containing an SQL query
- * that will be set as this RowSet
object's command
- * property; may be null
but may not be an empty string
+ * @param command a {@code String} object containing an SQL query
+ * that will be set as this {@code RowSet} object's command
+ * property; may be {@code null} but may not be an empty string
* @throws SQLException if an empty string is provided as the command value
* @see #getCommand
*/
@@ -4265,32 +4265,32 @@
}
/**
- * Sets the dataSourceName
property for this JdbcRowSet
- * object to the given logical name and sets this JdbcRowSet
object's
- * Url property to null
. In addition, if the dataSourceName
+ * Sets the {@code dataSourceName} property for this {@code JdbcRowSet}
+ * object to the given logical name and sets this {@code JdbcRowSet} object's
+ * Url property to {@code null}. In addition, if the {@code dataSourceName}
* property has previously been set and is different from the one supplied,
- * this method sets this JdbcRowSet
object's private fields
- * ps
, rs
, and conn
to null
.
- * (The field ps
is its PreparedStatement
object,
- * the field rs
is its ResultSet
object, and
- * the field conn
is its Connection
object.)
+ * this method sets this {@code JdbcRowSet} object's private fields
+ * {@code ps}, {@code rs}, and {@code conn} to {@code null}.
+ * (The field {@code ps} is its {@code PreparedStatement} object,
+ * the field {@code rs} is its {@code ResultSet} object, and
+ * the field {@code conn} is its {@code Connection} object.)
*
* The name supplied to this method must have been bound to a
- * DataSource
object in a JNDI naming service so that an
+ * {@code DataSource} object in a JNDI naming service so that an
* application can do a lookup using that name to retrieve the
- * DataSource
object bound to it. The DataSource
+ * {@code DataSource} object bound to it. The {@code DataSource}
* object can then be used to establish a connection to the data source it
* represents.
*
* Users should set either the Url property or the dataSourceName property.
* If both properties are set, the driver will use the property set most recently.
*
- * @param dsName a String
object with the name that can be supplied
+ * @param dsName a {@code String} object with the name that can be supplied
* to a naming service based on JNDI technology to retrieve the
- * DataSource
object that can be used to get a connection;
- * may be null
+ * {@code DataSource} object that can be used to get a connection;
+ * may be {@code null}
* @throws SQLException if there is a problem setting the
- * dataSourceName
property
+ * {@code dataSourceName} property
* @see #getDataSourceName
*/
public void setDataSourceName(String dsName) throws SQLException{
@@ -4310,42 +4310,42 @@
/**
- * Sets the Url property for this JdbcRowSet
object
- * to the given String
object and sets the dataSource name
- * property to null
. In addition, if the Url property has
- * previously been set to a non null
value and its value
+ * Sets the Url property for this {@code JdbcRowSet} object
+ * to the given {@code String} object and sets the dataSource name
+ * property to {@code null}. In addition, if the Url property has
+ * previously been set to a non {@code null} value and its value
* is different from the value to be set,
- * this method sets this JdbcRowSet
object's private fields
- * ps
, rs
, and conn
to null
.
- * (The field ps
is its PreparedStatement
object,
- * the field rs
is its ResultSet
object, and
- * the field conn
is its Connection
object.)
+ * this method sets this {@code JdbcRowSet} object's private fields
+ * {@code ps}, {@code rs}, and {@code conn} to {@code null}.
+ * (The field {@code ps} is its {@code PreparedStatement} object,
+ * the field {@code rs} is its {@code ResultSet} object, and
+ * the field {@code conn} is its {@code Connection} object.)
*
* The Url property is a JDBC URL that is used when
* the connection is created using a JDBC technology-enabled driver
- * ("JDBC driver") and the DriverManager
.
+ * ("JDBC driver") and the {@code DriverManager}.
* The correct JDBC URL for the specific driver to be used can be found
* in the driver documentation. Although there are guidelines for how
* a JDBC URL is formed,
- * a driver vendor can specify any String
object except
- * one with a length of 0
(an empty string).
+ * a driver vendor can specify any {@code String} object except
+ * one with a length of {@code 0} (an empty string).
*
* Setting the Url property is optional if connections are established using
- * a Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- *
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the Note: Consult your JDBC driver documentation to determine if
+ * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- *
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- *
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
- * Note: Consult your JDBC driver documentation to determine if
+ * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- *
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the Note: This stream object can either be a standard
* Java stream object or your own subclass that implements the
* standard interface.
- * Note: Consult your JDBC driver documentation to determine if
+ * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- *
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- *
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- *
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
- * it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
+ * it might be more efficient to use a version of
+ * {@code setNClob} which takes a length parameter.
+ *
+ * @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.
+ * @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
+ */
public void setNClob(int parameterIndex, Reader reader)
throws SQLException{
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to a Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * 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
* Note that this method may be used to pass datatabase-
@@ -6365,17 +6387,17 @@
* @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 scale for java.sql.Types.DECIMAL or java.sql.Types.NUMERIC types,
- * this is the number of digits after the decimal point. For all other
- * types, this value will be ignored.
+ * this is the number of digits after the decimal point. For all other
+ * types, this value will be ignored.
* @exception SQLException if a database access error occurs or
- * this method is called on a closed The JDBC specification specifies a standard mapping from
- * Java
* This method throws an exception if there is an ambiguity, for example, if the
@@ -6440,10 +6462,10 @@
* @param parameterName the name of the parameter
* @param x the object containing the input parameter value
* @exception SQLException if a database access error occurs,
- * this method is called on a closed Note: This stream object can either be a standard
@@ -6495,9 +6517,9 @@
* @param x the java input stream which contains the binary parameter value
* @param length the number of bytes in the stream
* @exception SQLException if a database access error occurs or
- * this method is called on a closed Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: This stream object can either be a standard
@@ -6574,12 +6596,12 @@
* standard interface.
* Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: Consult your JDBC driver documentation to determine if
* it might be more efficient to use a version of
- * Note: You must specify the parameter's SQL type.
*
* @param parameterName the name of the parameter
- * @param sqlType the SQL type code defined in DataSource
object instead of the DriverManager
.
+ * a {@code DataSource} object instead of the {@code DriverManager}.
* The driver will use either the URL property or the
* dataSourceName property to create a connection, whichever was
* specified most recently. If an application uses a JDBC URL, it
* must load a JDBC driver that accepts the JDBC URL before it uses the
- * RowSet
object to connect to a database. The RowSet
+ * {@code RowSet} object to connect to a database. The {@code RowSet}
* object will use the URL internally to create a database connection in order
* to read or write data.
*
- * @param url a String
object that contains the JDBC URL
+ * @param url a {@code String} object that contains the JDBC URL
* that will be used to establish the connection to a database for this
- * RowSet
object; may be null
but must not
+ * {@code RowSet} object; may be {@code null} but must not
* be an empty string
* @throws SQLException if an error occurs setting the Url property or the
- * parameter supplied is a string with a length of 0
(an
+ * parameter supplied is a string with a length of {@code 0} (an
* empty string)
* @see #getUrl
*/
@@ -4365,24 +4365,24 @@
}
}
- /**
- * Sets the username property for this JdbcRowSet
object
+ /**
+ * Sets the username property for this {@code JdbcRowSet} object
* to the given user name. Because it
* is not serialized, the username property is set at run time before
- * calling the method execute
. In addition,
- * if the username
property is already set with a
- * non-null value and that value is different from the String
+ * calling the method {@code execute}. In addition,
+ * if the {@code username} property is already set with a
+ * non-null value and that value is different from the {@code String}
* object to be set,
- * this method sets this JdbcRowSet
object's private fields
- * ps
, rs
, and conn
to null
.
- * (The field ps
is its PreparedStatement
object,
- * rs
is its ResultSet
object, and
- * conn
is its Connection
object.)
- * Setting these fields to null
ensures that only current
+ * this method sets this {@code JdbcRowSet} object's private fields
+ * {@code ps}, {@code rs}, and {@code conn} to {@code null}.
+ * (The field {@code ps} is its {@code PreparedStatement} object,
+ * {@code rs} is its {@code ResultSet} object, and
+ * {@code conn} is its {@code Connection} object.)
+ * Setting these fields to {@code null} ensures that only current
* values will be used.
*
- * @param uname the String
object containing the user name that
- * is supplied to the data source to create a connection. It may be null.
+ * @param uname the {@code String} object containing the user name that
+ * is supplied to the data source to create a connection. It may be null.
* @see #getUsername
*/
public void setUsername(String uname) {
@@ -4401,23 +4401,23 @@
}
/**
- * Sets the password property for this JdbcRowSet
object
- * to the given String
object. Because it
+ * Sets the password property for this {@code JdbcRowSet} object
+ * to the given {@code String} object. Because it
* is not serialized, the password property is set at run time before
- * calling the method execute
. Its default valus is
- * null
. In addition,
- * if the password
property is already set with a
+ * calling the method {@code execute}. Its default valus is
+ * {@code null}. In addition,
+ * if the {@code password} property is already set with a
* non-null value and that value is different from the one being set,
- * this method sets this JdbcRowSet
object's private fields
- * ps
, rs
, and conn
to null
.
- * (The field ps
is its PreparedStatement
object,
- * rs
is its ResultSet
object, and
- * conn
is its Connection
object.)
- * Setting these fields to null
ensures that only current
+ * this method sets this {@code JdbcRowSet} object's private fields
+ * {@code ps}, {@code rs}, and {@code conn} to {@code null}.
+ * (The field {@code ps} is its {@code PreparedStatement} object,
+ * {@code rs} is its {@code ResultSet} object, and
+ * {@code conn} is its {@code Connection} object.)
+ * Setting these fields to {@code null} ensures that only current
* values will be used.
*
- * @param password the String
object that represents the password
- * that must be supplied to the database to create a connection
+ * @param password the {@code String} object that represents the password
+ * that must be supplied to the database to create a connection
*/
public void setPassword(String password) {
@@ -4435,18 +4435,18 @@
}
/**
- * Sets the type for this RowSet
object to the specified type.
- * The default type is ResultSet.TYPE_SCROLL_INSENSITIVE
.
+ * Sets the type for this {@code RowSet} object to the specified type.
+ * The default type is {@code ResultSet.TYPE_SCROLL_INSENSITIVE}.
*
* @param type one of the following constants:
- * ResultSet.TYPE_FORWARD_ONLY
,
- * ResultSet.TYPE_SCROLL_INSENSITIVE
, or
- * ResultSet.TYPE_SCROLL_SENSITIVE
+ * {@code ResultSet.TYPE_FORWARD_ONLY},
+ * {@code ResultSet.TYPE_SCROLL_INSENSITIVE}, or
+ * {@code ResultSet.TYPE_SCROLL_SENSITIVE}
* @throws SQLException if the parameter supplied is not one of the
* following constants:
- * ResultSet.TYPE_FORWARD_ONLY
or
- * ResultSet.TYPE_SCROLL_INSENSITIVE
- * ResultSet.TYPE_SCROLL_SENSITIVE
+ * {@code ResultSet.TYPE_FORWARD_ONLY} or
+ * {@code ResultSet.TYPE_SCROLL_INSENSITIVE}
+ * {@code ResultSet.TYPE_SCROLL_SENSITIVE}
* @see #getConcurrency
* @see #getType
*/
@@ -4468,18 +4468,18 @@
}
/**
- * Sets the concurrency for this RowSet
object to
- * the specified concurrency. The default concurrency for any RowSet
- * object (connected or disconnected) is ResultSet.CONCUR_UPDATABLE
,
+ * Sets the concurrency for this {@code RowSet} object to
+ * the specified concurrency. The default concurrency for any {@code RowSet}
+ * object (connected or disconnected) is {@code ResultSet.CONCUR_UPDATABLE},
* but this method may be called at any time to change the concurrency.
*
* @param concur one of the following constants:
- * ResultSet.CONCUR_READ_ONLY
or
- * ResultSet.CONCUR_UPDATABLE
+ * {@code ResultSet.CONCUR_READ_ONLY} or
+ * {@code ResultSet.CONCUR_UPDATABLE}
* @throws SQLException if the parameter supplied is not one of the
* following constants:
- * ResultSet.CONCUR_UPDATABLE
or
- * ResultSet.CONCUR_READ_ONLY
+ * {@code ResultSet.CONCUR_UPDATABLE} or
+ * {@code ResultSet.CONCUR_READ_ONLY}
* @see #getConcurrency
* @see #isReadOnly
*/
@@ -4500,8 +4500,8 @@
}
/**
- * Retrieves the value of the designated SQL XML
parameter as a
- * SQLXML
object in the Java programming language.
+ * Retrieves the value of the designated {@code SQL XML} parameter as a
+ * {@code SQLXML} object in the Java programming language.
* @param columnIndex the first column is 1, the second is 2, ...
* @return a SQLXML object that maps an SQL XML value
* @throws SQLException if a database access error occurs
@@ -4512,8 +4512,8 @@
}
/**
- * Retrieves the value of the designated SQL XML
parameter as a
- * SQLXML
object in the Java programming language.
+ * Retrieves the value of the designated {@code SQL XML} parameter as a
+ * {@code SQLXML} object in the Java programming language.
* @param colName the name of the column from which to retrieve the value
* @return a SQLXML object that maps an SQL XML value
* @throws SQLException if a database access error occurs
@@ -4524,12 +4524,12 @@
/**
* Retrieves the value of the designated column in the current row of this
- * ResultSet
object as a java.sql.RowId object in the Java
+ * {@code ResultSet} object as a java.sql.RowId object in the Java
* programming language.
*
* @param columnIndex the first column is 1, the second 2, ...
- * @return the column value if the value is a SQL NULL
the
- * value returned is null
+ * @return the column value if the value is a SQL {@code NULL} the
+ * value returned is {@code null}
* @throws SQLException if a database access error occurs
* @since 1.6
*/
@@ -4539,12 +4539,12 @@
/**
* Retrieves the value of the designated column in the current row of this
- * ResultSet
object as a java.sql.RowId object in the Java
+ * {@code ResultSet} object as a java.sql.RowId object in the Java
* programming language.
*
* @param columnName the name of the column
- * @return the column value if the value is a SQL NULL
the
- * value returned is null
+ * @return the column value if the value is a SQL {@code NULL} the
+ * value returned is {@code null}
* @throws SQLException if a database access error occurs
* @since 1.6
*/
@@ -4553,10 +4553,10 @@
}
/**
- * Updates the designated column with a RowId
value. The updater
+ * Updates the designated column with a {@code RowId} value. The updater
* methods are used to update column values in the current row or the insert
* row. The updater methods do not update the underlying database; instead
- * the updateRow
or
insertRow
methods are called
+ * the {@code updateRow} or {@code insertRow} methods are called
* to update the database.
*
* @param columnIndex the first column is 1, the second 2, ...
@@ -4569,10 +4569,10 @@
}
/**
- * Updates the designated column with a RowId
value. The updater
+ * Updates the designated column with a {@code RowId} value. The updater
* methods are used to update column values in the current row or the insert
* row. The updater methods do not update the underlying database; instead
- * the updateRow
or
insertRow
methods are called
+ * the {@code updateRow} or {@code insertRow} methods are called
* to update the database.
*
* @param columnName the name of the column
@@ -4631,8 +4631,8 @@
/*o
- * This method is used for updating SQL NCLOB
type that maps
- * to java.sql.Types.NCLOB
+ * This method is used for updating SQL {@code NCLOB} type that maps
+ * to {@code java.sql.Types.NCLOB}
* @param columnIndex the first column is 1, the second 2, ...
* @param nClob the value for the column to be updated
* @throws SQLException if a database access error occurs
@@ -4643,8 +4643,8 @@
}
/**
- * This method is used for updating SQL NCLOB
type that maps
- * to java.sql.Types.NCLOB
+ * This method is used for updating SQL {@code NCLOB} type that maps
+ * to {@code java.sql.Types.NCLOB}
* @param columnName name of the column
* @param nClob the value for the column to be updated
* @throws SQLException if a database access error occurs
@@ -4656,12 +4656,12 @@
/**
* Retrieves the value of the designated column in the current row
- * of this ResultSet
object as a NClob
object
+ * of this {@code ResultSet} object as a {@code NClob} object
* in the Java programming language.
*
* @param i the first column is 1, the second is 2, ...
- * @return a NClob
object representing the SQL
- * NCLOB
value in the specified column
+ * @return a {@code NClob} object representing the SQL
+ * {@code NCLOB} value in the specified column
* @exception SQLException if a database access error occurs
* @since 1.6
*/
@@ -4672,11 +4672,11 @@
/**
* Retrieves the value of the designated column in the current row
- * of this ResultSet
object as a NClob
object
+ * of this {@code ResultSet} object as a {@code NClob} object
* in the Java programming language.
*
* @param colName the name of the column from which to retrieve the value
- * @return a NClob
object representing the SQL NCLOB
+ * @return a {@code NClob} object representing the SQL {@code NCLOB}
* value in the specified column
* @exception SQLException if a database access error occurs
* @since 1.6
@@ -4694,10 +4694,10 @@
}
/**
- * Sets the designated parameter to the given java.sql.SQLXML
object. The driver converts this to an
- * SQL XML
value when it sends it to the database.
+ * 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 SQLXML
object that maps an SQL XML
value
+ * @param xmlObject a {@code SQLXML} object that maps an SQL {@code XML} value
* @throws SQLException if a database access error occurs
* @since 1.6
*/
@@ -4706,10 +4706,10 @@
}
/**
- * Sets the designated parameter to the given java.sql.SQLXML
object. The driver converts this to an
- * SQL XML
value when it sends it to the database.
+ * Sets the designated parameter to the given {@code java.sql.SQLXML} object. The driver converts this to an
+ * {@code SQL XML} value when it sends it to the database.
* @param parameterName the name of the parameter
- * @param xmlObject a SQLXML
object that maps an SQL XML
value
+ * @param xmlObject a {@code SQLXML} object that maps an {@code SQL XML} value
* @throws SQLException if a database access error occurs
* @since 1.6
*/
@@ -4718,8 +4718,8 @@
}
/**
- * Sets the designated parameter to the given java.sql.RowId
object. The
- * driver converts this to a SQL ROWID
value when it sends it
+ * 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, ...
@@ -4732,9 +4732,9 @@
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to the given java.sql.RowId
object. The
- * driver converts this to a SQL ROWID
when it sends it to the
+ /**
+ * Sets the designated parameter to the given {@code java.sql.RowId} object. The
+ * driver converts this to a SQL {@code ROWID} when it sends it to the
* database.
*
* @param parameterName the name of the parameter
@@ -4748,18 +4748,18 @@
/**
- * Sets the designated parameter to the given String
object.
- * The driver converts this to a SQL NCHAR
or
- * NVARCHAR
or LONGNVARCHAR
value
+ * 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 NVARCHAR
values)
+ * 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 the driver does not support national
* character sets; if the driver can detect that a data conversion
- * error could occur ; or if a database access error occurs
+ * error could occur ; or if a database access error occurs
* @since 1.6
*/
public void setNString(int parameterIndex, String value) throws SQLException {
@@ -4768,9 +4768,9 @@
/**
- * Sets the designated parameter in this RowSet
object's command
- * to a Reader
object. The
- * Reader
reads the data till end-of-file is reached. The
+ * Sets the designated parameter in this {@code RowSet} object's command
+ * 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.
@@ -4779,14 +4779,14 @@
* standard interface.
* setNCharacterStream
which takes a length parameter.
+ * {@code setNCharacterStream} which takes a length parameter.
*
* @param parameterIndex of the first parameter is 1, the second is 2, ...
* @param value the parameter value
* @throws SQLException 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 PreparedStatement
+ * 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
*/
@@ -4795,14 +4795,14 @@
}
/**
- * Sets the designated parameter to a java.sql.NClob
object. The object
- * implements the java.sql.NClob
interface. This NClob
- * object maps to a SQL NCLOB
.
+ * Sets the designated parameter to a {@code java.sql.NClob} object. The object
+ * implements the {@code java.sql.NClob} interface. This {@code NClob}
+ * object maps to a SQL {@code NCLOB}.
* @param parameterName the name of the column to be set
* @param value the parameter value
* @throws SQLException if the driver does not support national
* character sets; if the driver can detect that a data conversion
- * error could occur; or if a database access error occurs
+ * error could occur; or if a database access error occurs
* @since 1.6
*/
public void setNClob(String parameterName, NClob value) throws SQLException {
@@ -4810,17 +4810,17 @@
}
- /**
+ /**
* Retrieves the value of the designated column in the current row
- * of this ResultSet
object as a
- * java.io.Reader
object.
+ * of this {@code ResultSet} object as a
+ * {@code java.io.Reader} object.
* It is intended for use when
- * accessing NCHAR
,NVARCHAR
- * and LONGNVARCHAR
columns.
+ * accessing {@code NCHAR},{@code NVARCHAR}
+ * and {@code LONGNVARCHAR} columns.
*
- * @return a java.io.Reader
object that contains the column
- * value; if the value is SQL NULL
, the value returned is
- * null
in the Java programming language.
+ * @return a {@code java.io.Reader} object that contains the column
+ * value; if the value is SQL {@code NULL}, the value returned is
+ * {@code null} in the Java programming language.
* @param columnIndex the first column is 1, the second is 2, ...
* @exception SQLException if a database access error occurs
* @since 1.6
@@ -4832,16 +4832,16 @@
/**
* Retrieves the value of the designated column in the current row
- * of this ResultSet
object as a
- * java.io.Reader
object.
+ * of this {@code ResultSet} object as a
+ * {@code java.io.Reader} object.
* It is intended for use when
- * accessing NCHAR
,NVARCHAR
- * and LONGNVARCHAR
columns.
+ * accessing {@code NCHAR},{@code NVARCHAR}
+ * and {@code LONGNVARCHAR} columns.
*
* @param columnName the name of the column
- * @return a java.io.Reader
object that contains the column
- * value; if the value is SQL NULL
, the value returned is
- * null
in the Java programming language
+ * @return a {@code java.io.Reader} object that contains the column
+ * value; if the value is SQL {@code NULL}, the value returned is
+ * {@code null} in the Java programming language
* @exception SQLException if a database access error occurs
* @since 1.6
*/
@@ -4850,11 +4850,11 @@
}
/**
- * Updates the designated column with a java.sql.SQLXML
value.
+ * Updates the designated column with a {@code java.sql.SQLXML} value.
* The updater
* methods are used to update column values in the current row or the insert
* row. The updater methods do not update the underlying database; instead
- * the updateRow
or insertRow
methods are called
+ * the {@code updateRow} or {@code insertRow} methods are called
* to update the database.
* @param columnIndex the first column is 1, the second 2, ...
* @param xmlObject the value for the column to be updated
@@ -4866,11 +4866,11 @@
}
/**
- * Updates the designated column with a java.sql.SQLXML
value.
+ * Updates the designated column with a {@code java.sql.SQLXML} value.
* The updater
* methods are used to update column values in the current row or the insert
* row. The updater methods do not update the underlying database; instead
- * the updateRow
or insertRow
methods are called
+ * the {@code updateRow} or {@code insertRow} methods are called
* to update the database.
*
* @param columnName the name of the column
@@ -4884,15 +4884,15 @@
/**
* Retrieves the value of the designated column in the current row
- * of this ResultSet
object as
- * a String
in the Java programming language.
+ * of this {@code ResultSet} object as
+ * a {@code String} in the Java programming language.
* It is intended for use when
- * accessing NCHAR
,NVARCHAR
- * and LONGNVARCHAR
columns.
+ * accessing {@code NCHAR},{@code NVARCHAR}
+ * and {@code LONGNVARCHAR} columns.
*
* @param columnIndex the first column is 1, the second is 2, ...
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @exception SQLException if a database access error occurs
* @since 1.6
*/
@@ -4902,15 +4902,15 @@
/**
* Retrieves the value of the designated column in the current row
- * of this ResultSet
object as
- * a String
in the Java programming language.
+ * of this {@code ResultSet} object as
+ * a {@code String} in the Java programming language.
* It is intended for use when
- * accessing NCHAR
,NVARCHAR
- * and LONGNVARCHAR
columns.
+ * accessing {@code NCHAR},{@code NVARCHAR}
+ * and {@code LONGNVARCHAR} columns.
*
* @param columnName the SQL name of the column
- * @return the column value; if the value is SQL NULL
, the
- * value returned is null
+ * @return the column value; if the value is SQL {@code NULL}, the
+ * value returned is {@code null}
* @exception SQLException if a database access error occurs
* @since 1.6
*/
@@ -4927,9 +4927,9 @@
* the insert row. The updater methods do not update the underlying database;
* instead the updateRow or insertRow methods are called to update the database.
*
- * @param columnIndex - the first column is 1, the second is 2, ...
- * @param x - the new column value
- * @param length - the length of the stream
+ * @param columnIndex the first column is 1, the second is 2, ...
+ * @param x the new column value
+ * @param length the length of the stream
* @exception SQLException if a database access error occurs
* @since 1.6
*/
@@ -4949,9 +4949,9 @@
* the insert row. The updater methods do not update the underlying database;
* instead the updateRow or insertRow methods are called to update the database.
*
- * @param columnName - name of the Column
- * @param x - the new column value
- * @param length - the length of the stream
+ * @param columnName name of the Column
+ * @param x the new column value
+ * @param length the length of the stream
* @exception SQLException if a database access error occurs
* @since 1.6
*/
@@ -4963,26 +4963,27 @@
}
/**
- * Updates the designated column with a character stream value. The
+ * Updates the designated column with a character stream value. The
* driver does the necessary conversion from Java character format to
* the national character set in the database.
* It is intended for use when
- * updating NCHAR
,NVARCHAR
- * and LONGNVARCHAR
columns.
+ * updating {@code NCHAR},{@code NVARCHAR}
+ * and {@code LONGNVARCHAR} columns.
*
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* updateNCharacterStream
which takes a length parameter.
+ * {@code updateNCharacterStream} which takes a length parameter.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY} or this
+ * method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
@@ -4997,26 +4998,27 @@
* driver does the necessary conversion from Java character format to
* the national character set in the database.
* It is intended for use when
- * updating NCHAR
,NVARCHAR
- * and LONGNVARCHAR
columns.
+ * updating {@code NCHAR},{@code NVARCHAR}
+ * and {@code LONGNVARCHAR} columns.
*
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* updateNCharacterStream
which takes a length parameter.
+ * {@code updateNCharacterStream} which takes a length parameter.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the la
-bel is the name of the column
- * @param reader the java.io.Reader
object containing
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then the label is the name of the column
+ * @param reader the {@code java.io.Reader} object containing
* the new column value
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
or this method is called on a closed result set
- * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * the result set concurrency is {@code CONCUR_READ_ONLY} or
+ * this method is called on a closed result set
+ * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
+ * this method
* @since 1.6
*/
public void updateNCharacterStream(String columnLabel,
@@ -5027,9 +5029,9 @@
/**
* Updates the designated column using the given input stream, which
* will have the specified number of bytes.
- * When a very large ASCII value is input to a LONGVARCHAR
+ * When a very large ASCII value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.InputStream
. Data will be read from the stream
+ * {@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.
*
@@ -5039,16 +5041,16 @@
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param inputStream An object that contains the data to set the parameter
- * value to.
+ * value to.
* @param length the number of bytes in the parameter data.
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
@@ -5060,9 +5062,9 @@
/**
* Updates the designated column using the given input stream, which
* will have the specified number of bytes.
- * When a very large ASCII value is input to a LONGVARCHAR
+ * When a very large ASCII value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.InputStream
. Data will be read from the stream
+ * {@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.
*
@@ -5072,18 +5074,20 @@
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified,
+ * then the label is the name of the column.
* @param inputStream An object that contains the data to set the parameter
- * value to.
+ * value to.
* @param length the number of bytes in the parameter data.
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateBlob(String columnLabel, InputStream inputStream, long length) throws SQLException {
@@ -5092,9 +5096,9 @@
/**
* Updates the designated column using the given input stream.
- * When a very large ASCII value is input to a LONGVARCHAR
+ * When a very large ASCII value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.InputStream
. Data will be read from the stream
+ * {@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.
*
@@ -5102,23 +5106,23 @@
* Java stream object or your own subclass that implements the
* standard interface.
*
- * updateBlob
which takes a length parameter.
+ * {@code updateBlob} which takes a length parameter.
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param inputStream An object that contains the data to set the parameter
- * value to.
+ * value to.
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateBlob(int columnIndex, InputStream inputStream) throws SQLException {
@@ -5127,9 +5131,9 @@
/**
* Updates the designated column using the given input stream.
- * When a very large ASCII value is input to a LONGVARCHAR
+ * When a very large ASCII value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.InputStream
. Data will be read from the stream
+ * {@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.
*
@@ -5138,22 +5142,23 @@
* standard interface.
* updateBlob
which takes a length parameter.
+ * {@code updateBlob} which takes a length parameter.
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the la
-bel is the name of the column
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then the label
+ * is the name of the column
* @param inputStream An object that contains the data to set the parameter
- * value to.
+ * value to.
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateBlob(String columnLabel, InputStream inputStream) throws SQLException {
@@ -5161,11 +5166,11 @@
}
/**
- * Updates the designated column using the given Reader
+ * Updates the designated column using the given {@code Reader}
* object, which is the given number of characters long.
- * When a very large UNICODE value is input to a LONGVARCHAR
+ * When a very large UNICODE value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.Reader
object. The data will be read from the stream
+ * {@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.
*
@@ -5175,17 +5180,17 @@
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column 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.
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateClob(int columnIndex, Reader reader, long length) throws SQLException {
@@ -5193,11 +5198,11 @@
}
/**
- * Updates the designated column using the given Reader
+ * Updates the designated column using the given {@code Reader}
* object, which is the given number of characters long.
- * When a very large UNICODE value is input to a LONGVARCHAR
+ * When a very large UNICODE value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.Reader
object. The data will be read from the stream
+ * {@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.
*
@@ -5207,17 +5212,18 @@
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then the label is the name of the column
* @param reader An object that contains the data to set the parameter value to.
* @param length the number of characters in the parameter data.
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateClob(String columnLabel, Reader reader, long length) throws SQLException {
@@ -5225,33 +5231,33 @@
}
/**
- * Updates the designated column using the given Reader
+ * Updates the designated column using the given {@code Reader}
* object.
- * When a very large UNICODE value is input to a LONGVARCHAR
+ * When a very large UNICODE value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.Reader
object. The data will be read from the stream
+ * {@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.
*
* updateClob
which takes a length parameter.
+ * {@code updateClob} which takes a length parameter.
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param reader An object that contains the data to set the parameter value to.
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateClob(int columnIndex, Reader reader) throws SQLException {
@@ -5259,34 +5265,35 @@
}
/**
- * Updates the designated column using the given Reader
+ * Updates the designated column using the given {@code Reader}
* object.
- * When a very large UNICODE value is input to a LONGVARCHAR
+ * When a very large UNICODE value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.Reader
object. The data will be read from the stream
+ * {@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.
*
* updateClob
which takes a length parameter.
+ * {@code updateClob} which takes a length parameter.
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the la
-bel is the name of the column
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then the label
+ * is the name of the column
* @param reader An object that contains the data to set the parameter value to.
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateClob(String columnLabel, Reader reader) throws SQLException {
@@ -5294,11 +5301,11 @@
}
/**
- * Updates the designated column using the given Reader
+ * Updates the designated column using the given {@code Reader}
* object, which is the given number of characters long.
- * When a very large UNICODE value is input to a LONGVARCHAR
+ * When a very large UNICODE value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.Reader
object. The data will be read from the stream
+ * {@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.
*
@@ -5308,19 +5315,19 @@
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second 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 the driver does not support national
* character sets; if the driver can detect that a data conversion
- * error could occur; this method is called on a closed result set,
- * if a database access error occurs or
- * the result set concurrency is CONCUR_READ_ONLY
+ * error could occur; this method is called on a closed result set,
+ * if a database access error occurs or
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateNClob(int columnIndex, Reader reader, long length) throws SQLException {
@@ -5328,11 +5335,11 @@
}
/**
- * Updates the designated column using the given Reader
+ * Updates the designated column using the given {@code Reader}
* object, which is the given number of characters long.
- * When a very large UNICODE value is input to a LONGVARCHAR
+ * When a very large UNICODE value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.Reader
object. The data will be read from the stream
+ * {@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.
*
@@ -5342,19 +5349,20 @@
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then the label is the name of the column
* @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 the driver does not support national
* character sets; if the driver can detect that a data conversion
- * error could occur; this method is called on a closed result set;
- * if a database access error occurs or
- * the result set concurrency is CONCUR_READ_ONLY
+ * error could occur; this method is called on a closed result set;
+ * if a database access error occurs or
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateNClob(String columnLabel, Reader reader, long length) throws SQLException {
@@ -5362,11 +5370,11 @@
}
/**
- * Updates the designated column using the given Reader
+ * Updates the designated column using the given {@code Reader}
* object.
- * When a very large UNICODE value is input to a LONGVARCHAR
+ * When a very large UNICODE value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.Reader
object. The data will be read from the stream
+ * {@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.
*
@@ -5375,22 +5383,22 @@
* standard interface.
* updateNClob
which takes a length parameter.
+ * {@code updateNClob} which takes a length parameter.
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second 2, ...
* @param reader An object that contains the data to set the parameter value to.
* @throws SQLException if the driver does not support national
* character sets; if the driver can detect that a data conversion
- * error could occur; this method is called on a closed result set,
- * if a database access error occurs or
- * the result set concurrency is CONCUR_READ_ONLY
+ * error could occur; this method is called on a closed result set,
+ * if a database access error occurs or
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateNClob(int columnIndex, Reader reader) throws SQLException {
@@ -5398,11 +5406,11 @@
}
/**
- * Updates the designated column using the given Reader
+ * Updates the designated column using the given {@code Reader}
* object.
- * When a very large UNICODE value is input to a LONGVARCHAR
+ * When a very large UNICODE value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.Reader
object. The data will be read from the stream
+ * {@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.
*
@@ -5411,23 +5419,24 @@
* standard interface.
* updateNClob
which takes a length parameter.
+ * {@code updateNClob} which takes a length parameter.
* updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the la
-bel is the name of the column
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then
+ * the label is the name of the column
* @param reader An object that contains the data to set the parameter value to.
* @throws SQLException if the driver does not support national
* character sets; if the driver can detect that a data conversion
- * error could occur; this method is called on a closed result set;
- * if a database access error occurs or
- * the result set concurrency is CONCUR_READ_ONLY
+ * error could occur; this method is called on a closed result set;
+ * if a database access error occurs or
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateNClob(String columnLabel, Reader reader) throws SQLException {
@@ -5435,22 +5444,22 @@
}
- /**
+ /**
* Updates the designated column with an ascii stream value, which will have
* the specified number of bytes.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateAsciiStream(int columnIndex,
@@ -5464,17 +5473,17 @@
* the specified number of bytes.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateBinaryStream(int columnIndex,
@@ -5488,17 +5497,17 @@
* the specified number of bytes.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateCharacterStream(int columnIndex,
@@ -5512,17 +5521,19 @@
* the specified number of bytes..
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then
+ * the label is the name of the column
* @param x the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateAsciiStream(String columnLabel,
@@ -5535,20 +5546,20 @@
* Updates the designated column with an ascii stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* updateAsciiStream
which takes a length parameter.
+ * {@code updateAsciiStream} which takes a length parameter.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateAsciiStream(int columnIndex,
@@ -5560,21 +5571,22 @@
* Updates the designated column with an ascii stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* updateAsciiStream
which takes a length parameter.
+ * {@code updateAsciiStream} which takes a length parameter.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the la
-bel is the name of the column
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then the label
+ * is the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateAsciiStream(String columnLabel,
@@ -5588,15 +5600,17 @@
* the specified number of bytes.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then
+ * the label is the name of the column
* @param x the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
@@ -5611,18 +5625,18 @@
* Updates the designated column with a binary stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* updateBinaryStream
which takes a length parameter.
+ * {@code updateBinaryStream} which takes a length parameter.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
@@ -5637,19 +5651,20 @@
* Updates the designated column with a binary stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* updateBinaryStream
which takes a length parameter.
+ * {@code updateBinaryStream} which takes a length parameter.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the la
-bel is the name of the column
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then
+ * the label is the name of the column
* @param x the new column value
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
* this method
* @since 1.6
@@ -5665,18 +5680,20 @@
* the specified number of bytes.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the label is the name of the column
- * @param reader the java.io.Reader
object containing
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then
+ * the label is the name of the column
+ * @param reader the {@code java.io.Reader} object containing
* the new column value
* @param length the length of the stream
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateCharacterStream(String columnLabel,
@@ -5689,20 +5706,20 @@
* Updates the designated column with a character stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* updateCharacterStream
which takes a length parameter.
+ * {@code updateCharacterStream} which takes a length parameter.
*
* @param columnIndex the first column is 1, the second is 2, ...
* @param x the new column value
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateCharacterStream(int columnIndex,
@@ -5714,22 +5731,23 @@
* Updates the designated column with a character stream value.
* The updater methods are used to update column values in the
* current row or the insert row. The updater methods do not
- * update the underlying database; instead the updateRow
or
- * insertRow
methods are called to update the database.
+ * update the underlying database; instead the {@code updateRow} or
+ * {@code insertRow} methods are called to update the database.
*
* updateCharacterStream
which takes a length parameter.
+ * {@code updateCharacterStream} which takes a length parameter.
*
- * @param columnLabel the label for the column specified with the SQL AS clause. If the SQL AS clause was not specified, then the la
-bel is the name of the column
- * @param reader the java.io.Reader
object containing
+ * @param columnLabel the label for the column specified with the SQL AS clause.
+ * If the SQL AS clause was not specified, then the label
+ * is the name of the column
+ * @param reader the {@code java.io.Reader} object containing
* the new column value
* @exception SQLException if a database access error occurs,
- * the result set concurrency is CONCUR_READ_ONLY
- * or this method is called on a closed result set
+ * the result set concurrency is {@code CONCUR_READ_ONLY}
+ * or this method is called on a closed result set
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void updateCharacterStream(String columnLabel,
@@ -5738,97 +5756,98 @@
}
- /**
- * Sets the designated parameter to the given java.net.URL
value.
- * The driver converts this to an SQL DATALINK
value
- * when it sends it to the database.
- *
- * @param parameterIndex the first parameter is 1, the second is 2, ...
- * @param x the java.net.URL
object to be set
- * @exception SQLException if a database access error occurs or
- * this method is called on a closed PreparedStatement
- * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
- * @since 1.4
- */
+ /**
+ * 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
+ * @exception 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.4
+ */
public void setURL(int parameterIndex, java.net.URL x) throws SQLException{
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to a Reader
object.
- * This method differs from the setCharacterStream (int, Reader)
method
- * because it informs the driver that the parameter value should be sent to
- * the server as a NCLOB
. When the 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 LONGNVARCHAR
or a NCLOB
- * setNClob
which takes a length parameter.
- *
- * @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.
- * @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 PreparedStatement
- * @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
- *
- * @since 1.6
- */
+ /**
+ * Sets the designated parameter to a {@code Reader} object.
+ * This method differs from the {@code setCharacterStream (int, Reader)} 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}
+ * Reader
object. The reader
must contain the number
- * of characters specified by length otherwise a SQLException
will be
- * generated when the CallableStatement
is executed.
- * This method differs from the setCharacterStream (int, Reader, int)
method
- * because it informs the driver that the parameter value should be sent to
- * the server as a NCLOB
. When the setCharacterStream
method is used, the
- * driver may have to do extra work to determine whether the parameter
- * data should be send to the server as a LONGNVARCHAR
or a NCLOB
- *
- * @param parameterName the name of the parameter to be set
- * @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 CallableStatement
- * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
- * @since 1.6
- */
- public void setNClob(String parameterName, Reader reader, long length)
+ /**
+ * Sets the designated parameter to a {@code Reader} object.
+ * The {@code reader} must contain the number
+ * of characters specified by length otherwise a {@code SQLException} will be
+ * generated when the {@code CallableStatement} 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 send to the server as a {@code LONGNVARCHAR} or a {@code NCLOB}
+ *
+ * @param parameterName the name of the parameter to be set
+ * @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 CallableStatement}
+ * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
+ * this method
+ * @since 1.6
+ */
+ public void setNClob(String parameterName, Reader reader, long length)
throws SQLException{
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
- }
+ }
/**
- * Sets the designated parameter to a Reader
object.
- * This method differs from the setCharacterStream (int, Reader)
method
+ * Sets the designated parameter to a {@code Reader} object.
+ * This method differs from the {@code setCharacterStream (int, Reader)} method
* because it informs the driver that the parameter value should be sent to
- * the server as a NCLOB
. When the setCharacterStream
method is used, the
+ * 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 send to the server as a LONGNVARCHAR
or a NCLOB
+ * data should be send to the server as a {@code LONGNVARCHAR} or a {@code NCLOB}
* setNClob
which takes a length parameter.
+ * {@code setNClob} which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param reader An object that contains the data to set the parameter value to.
* @throws SQLException 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 CallableStatement
+ * 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 CallableStatement}
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since 1.6
@@ -5839,23 +5858,25 @@
}
- /**
- ** of characters specified by length otherwise a SQLException
will becontain the number
- * generated when the PreparedStatement
is executed.
- * This method differs from the setCharacterStream (int, Reader, int)
method
+ /**
+ * 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 NCLOB
. When the setCharacterStream
method is used, the
+ * 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 LONGNVARCHAR
or a NCLOB
+ * 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 PreparedStatement
+ * 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
@@ -5867,14 +5888,14 @@
/**
- * Sets the designated parameter to a java.sql.NClob
object. The driver converts this to
-a
- * SQL NCLOB
value when it sends it to the database.
+ * Sets the designated parameter to a {@code java.sql.NClob} object.
+ * The driver converts this to an
+ * 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 the driver does not support national
* character sets; if the driver can detect that a data conversion
- * error could occur ; or if a database access error occurs
+ * error could occur; or if a database access error occurs
* @since 1.6
*/
public void setNClob(int parameterIndex, NClob value) throws SQLException{
@@ -5883,14 +5904,14 @@
/**
- * Sets the designated parameter to the given String
object.
- * The driver converts this to a SQL NCHAR
or
- * NVARCHAR
or LONGNVARCHAR
+ * 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}
* @param parameterName the name of the column to be set
* @param value the parameter value
* @throws SQLException if the driver does not support national
* character sets; if the driver can detect that a data conversion
- * error could occur; or if a database access error occurs
+ * error could occur; or if a database access error occurs
* @since 1.6
*/
public void setNString(String parameterName, String value)
@@ -5899,8 +5920,8 @@
}
/**
- * Sets the designated parameter to a Reader
object. The
- * Reader
reads the data till end-of-file is reached. The
+ * 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, ...
@@ -5908,7 +5929,7 @@
* @param length the number of characters in the parameter data.
* @throws SQLException if the driver does not support national
* character sets; if the driver can detect that a data conversion
- * error could occur ; or if a database access error occurs
+ * error could occur ; or if a database access error occurs
* @since 1.6
*/
public void setNCharacterStream(int parameterIndex, Reader value, long length) throws SQLException{
@@ -5918,8 +5939,8 @@
/**
- * Sets the designated parameter to a Reader
object. The
- * Reader
reads the data till end-of-file is reached. The
+ * 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 parameterName the name of the column to be set
@@ -5935,9 +5956,9 @@
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to a Reader
object. The
- * Reader
reads the data till end-of-file is reached. The
+ /**
+ * 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.
@@ -5946,14 +5967,14 @@
* standard interface.
* setNCharacterStream
which takes a length parameter.
+ * {@code setNCharacterStream} which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param value the parameter value
* @throws SQLException 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 CallableStatement
+ * error could occur ; if a database access error occurs; or
+ * this method is called on a closed {@code CallableStatement}
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
@@ -5962,23 +5983,23 @@
}
/**
- * Sets the designated parameter to the given java.sql.Timestamp
value,
- * using the given Calendar
object. The driver uses
- * the Calendar
object to construct an SQL TIMESTAMP
value,
+ * 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
- * a Calendar
object, the driver can calculate the timestamp
+ * a {@code Calendar} object, the driver can calculate the timestamp
* taking into account a custom timezone. If no
- * Calendar
object is specified, the driver uses the default
+ * {@code Calendar} object is specified, the driver uses the default
* timezone, which is that of the virtual machine running the application.
*
* @param parameterName the name of the parameter
* @param x the parameter value
- * @param cal the Calendar
object the driver will use
- * to construct the timestamp
+ * @param cal the {@code Calendar} object the driver will use
+ * to construct the timestamp
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getTimestamp
* @since 1.4
*/
@@ -5987,28 +6008,29 @@
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to a Reader
object. The reader
must contain the number
- * of characters specified by length otherwise a SQLException
will be
- * generated when the CallableStatement
is executed.
- * This method differs from the setCharacterStream (int, Reader, int)
method
- * because it informs the driver that the parameter value should be sent to
- * the server as a CLOB
. When the setCharacterStream
method is used, the
- * driver may have to do extra work to determine whether the parameter
- * data should be send to the server as a LONGVARCHAR
or a CLOB
- * @param parameterName the name of the parameter to be set
- * @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;
- * a database access error occurs or
- * this method is called on a closed CallableStatement
- * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
- *
- * @since 1.6
- */
- public void setClob(String parameterName, Reader reader, long length)
+ /**
+ * Sets the designated parameter to a {@code Reader} object. The {@code reader} must contain the number
+ * of characters specified by length otherwise a {@code SQLException} will be
+ * generated when the {@code CallableStatement} 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 send to the server as a {@code LONGVARCHAR} or a {@code CLOB}
+ *
+ * @param parameterName the name of the parameter to be set
+ * @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;
+ * a database access error occurs or
+ * this method is called on a closed {@code CallableStatement}
+ * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
+ * this method
+ *
+ * @since 1.6
+ */
+ public void setClob(String parameterName, Reader reader, long length)
throws SQLException{
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
@@ -6016,16 +6038,16 @@
/**
- * Sets the designated parameter to the given java.sql.Clob
object.
- * The driver converts this to an SQL CLOB
value when it
+ * 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 parameterName the name of the parameter
- * @param x a Clob
object that maps an SQL CLOB
value
+ * @param x a {@code Clob} object that maps an SQL {@code CLOB} value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void setClob (String parameterName, Clob x) throws SQLException{
@@ -6033,21 +6055,21 @@
}
/**
- * Sets the designated parameter to a Reader
object.
- * This method differs from the setCharacterStream (int, Reader)
method
+ * Sets the designated parameter to a {@code Reader} object.
+ * This method differs from the {@code setCharacterStream (int, Reader)} method
* because it informs the driver that the parameter value should be sent to
- * the server as a CLOB
. When the setCharacterStream
method is used, the
+ * 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 send to the server as a LONGVARCHAR
or a CLOB
+ * data should be send to the server as a {@code LONGVARCHAR} or a {@code CLOB}
*
* setClob
which takes a length parameter.
+ * {@code setClob} which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param reader An object that contains the data to set the parameter value to.
* @throws SQLException if a database access error occurs or this method is called on
- * a closed CallableStatement
+ * a closed {@code CallableStatement}
*
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
@@ -6058,19 +6080,19 @@
}
- /**
- * Sets the designated parameter to the given java.sql.Date
value
+ /**
+ * 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 DATE
value when it sends it to the database.
+ * to an SQL {@code DATE} value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getDate
* @since 1.4
*/
@@ -6080,23 +6102,23 @@
}
/**
- * Sets the designated parameter to the given java.sql.Date
value,
- * using the given Calendar
object. The driver uses
- * the Calendar
object to construct an SQL DATE
value,
+ * 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
- * a Calendar
object, the driver can calculate the date
+ * a {@code Calendar} object, the driver can calculate the date
* taking into account a custom timezone. If no
- * Calendar
object is specified, the driver uses the default
+ * {@code Calendar} object is specified, the driver uses the default
* timezone, which is that of the virtual machine running the application.
*
* @param parameterName the name of the parameter
* @param x the parameter value
- * @param cal the Calendar
object the driver will use
+ * @param cal the {@code Calendar} object the driver will use
* to construct the date
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getDate
* @since 1.4
*/
@@ -6107,16 +6129,16 @@
/**
- * Sets the designated parameter to the given java.sql.Time
value.
+ * Sets the designated parameter to the given {@code java.sql.Time} value.
* The driver converts this
- * to an SQL TIME
value when it sends it to the database.
+ * to an SQL {@code TIME} value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getTime
* @since 1.4
*/
@@ -6126,23 +6148,23 @@
}
/**
- * Sets the designated parameter to the given java.sql.Time
value,
- * using the given Calendar
object. The driver uses
- * the Calendar
object to construct an SQL TIME
value,
+ * 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
- * a Calendar
object, the driver can calculate the time
+ * a {@code Calendar} object, the driver can calculate the time
* taking into account a custom timezone. If no
- * Calendar
object is specified, the driver uses the default
+ * {@code Calendar} object is specified, the driver uses the default
* timezone, which is that of the virtual machine running the application.
*
* @param parameterName the name of the parameter
* @param x the parameter value
- * @param cal the Calendar
object the driver will use
+ * @param cal the {@code Calendar} object the driver will use
* to construct the time
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getTime
* @since 1.4
*/
@@ -6152,22 +6174,22 @@
}
/**
- * Sets the designated parameter to a Reader
object.
- * This method differs from the setCharacterStream (int, Reader)
method
+ * Sets the designated parameter to a {@code Reader} object.
+ * This method differs from the {@code setCharacterStream (int, Reader)} method
* because it informs the driver that the parameter value should be sent to
- * the server as a CLOB
. When the setCharacterStream
method is used, the
+ * 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 LONGVARCHAR
or a CLOB
+ * data should be sent to the server as a {@code LONGVARCHAR} or a {@code CLOB}
*
* setClob
which takes a length parameter.
+ * {@code setClob} which takes a length parameter.
*
* @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.
* @throws SQLException if a database access error occurs, this method is called on
- * a closed PreparedStatement
or if parameterIndex does not correspond to a parameter
- * marker in the SQL statement
+ * a closed {@code PreparedStatement}or if parameterIndex does not correspond to a parameter
+ * marker in the SQL statement
*
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
@@ -6178,20 +6200,20 @@
}
- /**
- * Sets the designated parameter to a Reader
object. The reader must contain the number
- * of characters specified by length otherwise a SQLException
will be
- * generated when the PreparedStatement
is executed.
- *This method differs from the setCharacterStream (int, Reader, int)
method
+ /**
+ * 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 CLOB
. When the setCharacterStream
method is used, the
+ * 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 LONGVARCHAR
or a CLOB
+ * 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 a database access error occurs, this method is called on
- * a closed PreparedStatement
, if parameterIndex does not correspond to a parameter
+ * a closed {@code PreparedStatement}, if parameterIndex does not correspond to a parameter
* marker in the SQL statement, or if the length specified is less than zero.
*
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
@@ -6203,26 +6225,27 @@
}
- /**
- * Sets the designated parameter to a InputStream
object. The inputstream must contain the number
- * of characters specified by length otherwise a SQLException
will be
- * generated when the PreparedStatement
is executed.
- * This method differs from the setBinaryStream (int, InputStream, int)
+ /**
+ * Sets the designated parameter to a {@code InputStream} object. The 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 BLOB
. When the setBinaryStream
method is used,
+ * 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 LONGVARBINARY
or a BLOB
+ * 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, ...
+ * the second is 2, ...
* @param inputStream An object that contains the data to set the parameter
- * value to.
+ * value to.
* @param length the number of bytes in the parameter data.
* @throws SQLException if a database access error occurs,
- * this method is called on a closed PreparedStatement
,
- * if parameterIndex does not correspond
- * to a parameter marker in the SQL statement, if the length specified
- * is less than zero or if the number of bytes in the inputstream does not match
- * the specified length.
+ * this method is called on a closed {@code PreparedStatement},
+ * if parameterIndex does not correspond
+ * to a parameter marker in the SQL statement, if the length specified
+ * is less than zero or if the number of bytes in the inputstream does not match
+ * the specified length.
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since 1.6
@@ -6233,28 +6256,27 @@
}
/**
- * Sets the designated parameter to a InputStream
object.
- * This method differs from the setBinaryStream (int, InputStream)
- * This method differs from the setBinaryStream (int, InputStream)
+ * Sets the designated parameter to a {@code InputStream} object.
+ * This method differs from the {@code setBinaryStream (int, InputStream)}
+ * This method differs from the {@code setBinaryStream (int, InputStream)}
* method because it informs the driver that the parameter value should be
- * sent to the server as a BLOB
. When the setBinaryStream
method is used,
+ * 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 LONGVARBINARY
or a BLOB
+ * data should be sent to the server as a {@code LONGVARBINARY} or a {@code BLOB}
*
* setBlob
which takes a length parameter.
+ * {@code setBlob} which takes a length parameter.
*
* @param parameterIndex index of the first parameter is 1,
- * the second is 2, ...
-
-
+ * the second is 2, ...
+ *
* @param inputStream An object that contains the data to set the parameter
- * value to.
+ * value to.
* @throws SQLException if a database access error occurs,
- * this method is called on a closed PreparedStatement
or
- * if parameterIndex does not correspond
- * to a parameter marker in the SQL statement,
+ * this method is called on a closed {@code PreparedStatement} or
+ * if parameterIndex does not correspond
+ * to a parameter marker in the SQL statement,
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since 1.6
@@ -6264,72 +6286,72 @@
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to a InputStream
object. The inputstream
must contain the number
- * of characters specified by length, otherwise a SQLException
will be
- * generated when the CallableStatement
is executed.
- * This method differs from the setBinaryStream (int, InputStream, int)
- * method because it informs the driver that the parameter value should be
- * sent to the server as a BLOB
. When the 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 LONGVARBINARY
or a BLOB
- *
- * @param parameterName the name of the parameter to be set
- * 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, or if the length specified
- * is less than zero; if the number of bytes in the inputstream does not match
- * the specified length; if a database access error occurs or
- * this method is called on a closed CallableStatement
- * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
- *
- * @since 1.6
- */
- public void setBlob(String parameterName, InputStream inputStream, long length)
+ /**
+ * 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 CallableStatement} 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 parameterName the name of the parameter to be set
+ * 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, or if the length specified
+ * is less than zero; if the number of bytes in the inputstream does not match
+ * the specified length; if a database access error occurs or
+ * this method is called on a closed {@code CallableStatement}
+ * @exception SQLFeatureNotSupportedException if the JDBC driver does not support
+ * this method
+ *
+ * @since 1.6
+ */
+ public void setBlob(String parameterName, InputStream inputStream, long length)
throws SQLException{
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to the given java.sql.Blob
object.
- * The driver converts this to an SQL BLOB
value when it
+ /**
+ * 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 parameterName the name of the parameter
- * @param x a Blob
object that maps an SQL BLOB
value
+ * @param x a {@code Blob} object that maps an SQL {@code BLOB} value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.6
*/
public void setBlob (String parameterName, Blob x) throws SQLException{
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to a InputStream
object.
- * This method differs from the setBinaryStream (int, InputStream)
+ /**
+ * Sets the designated parameter to a {@code InputStream} object.
+ * This method differs from the {@code setBinaryStream (int, InputStream)}
* method because it informs the driver that the parameter value should be
- * sent to the server as a BLOB
. When the setBinaryStream
method is used,
+ * 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 send to the server as a LONGVARBINARY
or a BLOB
+ * data should be send to the server as a {@code LONGVARBINARY} or a {@code BLOB}
*
* setBlob
which takes a length parameter.
+ * {@code setBlob} which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param inputStream An object that contains the data to set the parameter
- * value to.
+ * value to.
* @throws SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
*
* @since 1.6
@@ -6339,22 +6361,22 @@
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
+ /**
* Sets the value of the designated parameter with the given object. The second
* argument must be an object type; for integral values, the
- * java.lang
equivalent objects should be used.
+ * {@code java.lang} equivalent objects should be used.
*
* SQLData
),
- * the JDBC driver should call the method SQLData.writeSQL
to write it
+ * 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
- * Ref
, Blob
, Clob
, NClob
,
- * Struct
, java.net.URL
,
- * or Array
, the driver should pass it to the database as a
+ * {@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.
* CallableStatement
- * @exception SQLFeatureNotSupportedException if targetSqlType
is
- * a ARRAY
, BLOB
, CLOB
,
- * DATALINK
, JAVA_OBJECT
, NCHAR
,
- * NCLOB
, NVARCHAR
, LONGNVARCHAR
,
- * REF
, ROWID
, SQLXML
- * or STRUCT
data type and the JDBC driver does not support
- * this data type
+ * this method is called on a closed {@code CallableStatement}
+ * @exception SQLFeatureNotSupportedException if {@code targetSqlType} is
+ * an {@code ARRAY, BLOB, CLOB,
+ * DATALINK, JAVA_OBJECT, NCHAR,
+ * NCLOB, NVARCHAR, LONGNVARCHAR,
+ * REF, ROWID, SQLXML}
+ * or {@code STRUCT} data type and the JDBC driver does not support
+ * this data type
* @see Types
* @see #getObject
* @since 1.4
@@ -6387,7 +6409,7 @@
/**
* Sets the value of the designated parameter with the given object.
- * This method is like the method setObject
+ * This method is like the method {@code setObject}
* above, except that it assumes a scale of zero.
*
* @param parameterName the name of the parameter
@@ -6395,14 +6417,14 @@
* @param targetSqlType the SQL type (as defined in java.sql.Types) to be
* sent to the database
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
- * @exception SQLFeatureNotSupportedException if targetSqlType
is
- * a ARRAY
, BLOB
, CLOB
,
- * DATALINK
, JAVA_OBJECT
, NCHAR
,
- * NCLOB
, NVARCHAR
, LONGNVARCHAR
,
- * REF
, ROWID
, SQLXML
- * or STRUCT
data type and the JDBC driver does not support
- * this data type
+ * this method is called on a closed {@code CallableStatement}
+ * @exception SQLFeatureNotSupportedException if {@code targetSqlType} is
+ * an {@code ARRAY, BLOB, CLOB,
+ * DATALINK, JAVA_OBJECT, NCHAR,
+ * NCLOB, NVARCHAR, LONGNVARCHAR,
+ * REF, ROWID, SQLXML}
+ * or {@code STRUCT} data type and the JDBC driver does not support
+ * this data type
* @see #getObject
* @since 1.4
*/
@@ -6411,13 +6433,13 @@
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
+ /**
* Sets the value of the designated parameter with the given object.
- * The second parameter must be of type Object
; therefore, the
- * java.lang
equivalent objects should be used for built-in types.
+ * The second parameter must be of type {@code Object}; therefore, the
+ * {@code java.lang} equivalent objects should be used for built-in types.
*
* Object
types to SQL types. The given argument
+ * Java {@code Object} types to SQL types. The given argument
* will be converted to the corresponding SQL type before being
* sent to the database.
*
@@ -6425,13 +6447,13 @@
* specific abstract data types, by using a driver-specific Java
* type.
*
- * If the object is of a class implementing the interface SQLData
,
- * the JDBC driver should call the method SQLData.writeSQL
+ * 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
- * Ref
, Blob
, Clob
, NClob
,
- * Struct
, java.net.URL
,
- * or Array
, the driver should pass it to the database as a
+ * {@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.
* CallableStatement
or if the given
- * Object
parameter is ambiguous
+ * this method is called on a closed {@code CallableStatement} or if the given
+ * {@code Object} parameter is ambiguous
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getObject
* @since 1.4
*/
@@ -6454,9 +6476,9 @@
/**
* 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 LONGVARCHAR
+ * When a very large ASCII value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.InputStream
. Data will be read from the stream
+ * {@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.
*
@@ -6468,9 +6490,9 @@
* @param x the Java input stream that contains the ASCII parameter value
* @param length the number of bytes in the stream
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.4
*/
public void setAsciiStream(String parameterName, java.io.InputStream x, int length)
@@ -6482,9 +6504,9 @@
/**
* 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 LONGVARBINARY
+ * When a very large binary value is input to a {@code LONGVARBINARY}
* parameter, it may be more practical to send it via a
- * java.io.InputStream
object. The data will be read from the stream
+ * {@code java.io.InputStream} object. The data will be read from the stream
* as needed until end-of-file is reached.
*
* CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.4
*/
public void setBinaryStream(String parameterName, java.io.InputStream x,
@@ -6506,11 +6528,11 @@
}
/**
- * Sets the designated parameter to the given Reader
+ * 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 LONGVARCHAR
+ * When a very large UNICODE value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.Reader
object. The data will be read from the stream
+ * {@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.
*
@@ -6519,13 +6541,13 @@
* standard interface.
*
* @param parameterName the name of the parameter
- * @param reader the java.io.Reader
object that
+ * @param reader the {@code java.io.Reader} object that
* contains the UNICODE data used as the designated parameter
* @param length the number of characters in the stream
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.4
*/
public void setCharacterStream(String parameterName,
@@ -6536,9 +6558,9 @@
/**
* Sets the designated parameter to the given input stream.
- * When a very large ASCII value is input to a LONGVARCHAR
+ * When a very large ASCII value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.InputStream
. Data will be read from the stream
+ * {@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.
*
@@ -6547,15 +6569,15 @@
* standard interface.
* setAsciiStream
which takes a length parameter.
+ * {@code setAsciiStream} which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param x the Java input stream that contains the ASCII parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
- * @since 1.6
- */
+ * @since 1.6
+ */
public void setAsciiStream(String parameterName, java.io.InputStream x)
throws SQLException{
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
@@ -6564,9 +6586,9 @@
/**
* Sets the designated parameter to the given input stream.
- * When a very large binary value is input to a LONGVARBINARY
+ * When a very large binary value is input to a {@code LONGVARBINARY}
* parameter, it may be more practical to send it via a
- * java.io.InputStream
object. The data will be read from the
+ * {@code java.io.InputStream} object. The data will be read from the
* stream as needed until end-of-file is reached.
*
* setBinaryStream
which takes a length parameter.
+ * {@code setBinaryStream} which takes a length parameter.
*
* @param parameterName the name of the parameter
* @param x the java input stream which contains the binary parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
@@ -6589,11 +6611,11 @@
}
/**
- * Sets the designated parameter to the given Reader
+ * Sets the designated parameter to the given {@code Reader}
* object.
- * When a very large UNICODE value is input to a LONGVARCHAR
+ * When a very large UNICODE value is input to a {@code LONGVARCHAR}
* parameter, it may be more practical to send it via a
- * java.io.Reader
object. The data will be read from the stream
+ * {@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.
*
@@ -6602,13 +6624,13 @@
* standard interface.
* setCharacterStream
which takes a length parameter.
+ * {@code setCharacterStream} which takes a length parameter.
*
* @param parameterName the name of the parameter
- * @param reader the java.io.Reader
object that contains the
+ * @param reader the {@code java.io.Reader} object that contains the
* Unicode data
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @throws SQLFeatureNotSupportedException if the JDBC driver does not support this method
* @since 1.6
*/
@@ -6619,16 +6641,16 @@
/**
* Sets the designated parameter to the given
- * java.math.BigDecimal
value.
- * The driver converts this to an SQL NUMERIC
value when
+ * {@code java.math.BigDecimal} value.
+ * The driver converts this to an SQL {@code NUMERIC} value when
* it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getBigDecimal
* @since 1.4
*/
@@ -6636,20 +6658,20 @@
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to the given Java String
value.
+ /**
+ * Sets the designated parameter to the given Java {@code String} value.
* The driver converts this
- * to an SQL VARCHAR
or LONGVARCHAR
value
+ * to an SQL {@code VARCHAR} or {@code LONGVARCHAR} value
* (depending on the argument's
- * size relative to the driver's limits on VARCHAR
values)
+ * size relative to the driver's limits on {@code VARCHAR} values)
* when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getString
* @since 1.4
*/
@@ -6659,19 +6681,19 @@
- /**
+ /**
* Sets the designated parameter to the given Java array of bytes.
- * The driver converts this to an SQL VARBINARY
or
- * LONGVARBINARY
(depending on the argument's size relative
- * to the driver's limits on VARBINARY
values) when it sends
+ * 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 parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getBytes
* @since 1.4
*/
@@ -6680,17 +6702,17 @@
}
/**
- * Sets the designated parameter to the given java.sql.Timestamp
value.
+ * Sets the designated parameter to the given {@code java.sql.Timestamp} value.
* The driver
- * converts this to an SQL TIMESTAMP
value when it sends it to the
+ * converts this to an SQL {@code TIMESTAMP} value when it sends it to the
* database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getTimestamp
* @since 1.4
*/
@@ -6700,16 +6722,16 @@
}
/**
- * Sets the designated parameter to SQL NULL
.
+ * Sets the designated parameter to SQL {@code NULL}.
*
* java.sql.Types
+ * @param sqlType the SQL type code defined in {@code java.sql.Types}
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.4
*/
public void setNull(String parameterName, int sqlType) throws SQLException {
@@ -6717,8 +6739,8 @@
}
/**
- * Sets the designated parameter to SQL NULL
.
- * This version of the method setNull
should
+ * 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.
@@ -6738,14 +6760,14 @@
*
*
* @param parameterName the name of the parameter
- * @param sqlType a value from java.sql.Types
+ * @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
- * SQL REF
value
+ * SQL {@code REF} value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.4
*/
public void setNull (String parameterName, int sqlType, String typeName)
@@ -6754,17 +6776,17 @@
}
/**
- * Sets the designated parameter to the given Java boolean
value.
+ * Sets the designated parameter to the given Java {@code boolean} value.
* The driver converts this
- * to an SQL BIT
or BOOLEAN
value when it sends it to the database.
+ * to an SQL {@code BIT} or {@code BOOLEAN} value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @see #getBoolean
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @since 1.4
*/
public void setBoolean(String parameterName, boolean x) throws SQLException{
@@ -6774,16 +6796,16 @@
/**
- * Sets the designated parameter to the given Java byte
value.
+ * Sets the designated parameter to the given Java {@code byte} value.
* The driver converts this
- * to an SQL TINYINT
value when it sends it to the database.
+ * to an SQL {@code TINYINT} value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getByte
* @since 1.4
*/
@@ -6793,16 +6815,16 @@
/**
- * Sets the designated parameter to the given Java short
value.
+ * Sets the designated parameter to the given Java {@code short} value.
* The driver converts this
- * to an SQL SMALLINT
value when it sends it to the database.
+ * to an SQL {@code SMALLINT} value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getShort
* @since 1.4
*/
@@ -6812,16 +6834,16 @@
/**
- * Sets the designated parameter to the given Java int
value.
+ * Sets the designated parameter to the given Java {@code int} value.
* The driver converts this
- * to an SQL INTEGER
value when it sends it to the database.
+ * to an SQL {@code INTEGER} value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getInt
* @since 1.4
*/
@@ -6829,17 +6851,17 @@
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to the given Java long
value.
+ /**
+ * Sets the designated parameter to the given Java {@code long} value.
* The driver converts this
- * to an SQL BIGINT
value when it sends it to the database.
+ * to an SQL {@code BIGINT} value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getLong
* @since 1.4
*/
@@ -6848,17 +6870,17 @@
}
- /**
- * Sets the designated parameter to the given Java float
value.
+ /**
+ * Sets the designated parameter to the given Java {@code float} value.
* The driver converts this
- * to an SQL FLOAT
value when it sends it to the database.
+ * to an SQL {@code FLOAT} value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getFloat
* @since 1.4
*/
@@ -6866,17 +6888,17 @@
throw new SQLFeatureNotSupportedException(resBundle.handleGetObject("jdbcrowsetimpl.featnotsupp").toString());
}
- /**
- * Sets the designated parameter to the given Java double
value.
+ /**
+ * Sets the designated parameter to the given Java {@code double} value.
* The driver converts this
- * to an SQL DOUBLE
value when it sends it to the database.
+ * to an SQL {@code DOUBLE} value when it sends it to the database.
*
* @param parameterName the name of the parameter
* @param x the parameter value
* @exception SQLException if a database access error occurs or
- * this method is called on a closed CallableStatement
+ * this method is called on a closed {@code CallableStatement}
* @exception SQLFeatureNotSupportedException if the JDBC driver does not support
- * this method
+ * this method
* @see #getDouble
* @since 1.4
*/
@@ -6887,7 +6909,6 @@
/**
* This method re populates the resBundle
* during the deserialization process
- *
*/
private void readObject(ObjectInputStream ois) throws IOException, ClassNotFoundException {
// Default state initialization happens here