harmony-commits mailing list archives

Site index · List index
Message view « Date » · « Thread »
Top « Date » · « Thread »
From telli...@apache.org
Subject svn commit: r770130 [1/10] - in /harmony/enhanced/classlib/trunk/modules/sql/src/main/java: java/sql/ javax/sql/
Date Thu, 30 Apr 2009 09:45:42 GMT
Author: tellison
Date: Thu Apr 30 09:45:40 2009
New Revision: 770130

URL: http://svn.apache.org/viewvc?rev=770130&view=rev
Log:
Apply slightly modified patch for HARMONY-6191 (Javadocs for java.sql.* and javax.sql.*)

Modified:
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Array.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/BatchUpdateException.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Blob.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/CallableStatement.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Clob.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Connection.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/DataTruncation.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/DatabaseMetaData.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Date.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Driver.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/DriverManager.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/DriverPropertyInfo.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/ParameterMetaData.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/PreparedStatement.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Ref.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/ResultSet.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/ResultSetMetaData.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/SQLData.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/SQLException.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/SQLInput.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/SQLOutput.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/SQLPermission.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/SQLWarning.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Savepoint.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Statement.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Struct.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Time.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Timestamp.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Types.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/ConnectionEvent.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/ConnectionEventListener.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/ConnectionPoolDataSource.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/DataSource.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/PooledConnection.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/RowSet.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/RowSetEvent.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/RowSetInternal.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/RowSetListener.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/RowSetMetaData.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/RowSetReader.java
    harmony/enhanced/classlib/trunk/modules/sql/src/main/java/javax/sql/RowSetWriter.java

Modified: harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Array.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Array.java?rev=770130&r1=770129&r2=770130&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Array.java (original)
+++ harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Array.java Thu Apr
30 09:45:40 2009
@@ -20,112 +20,145 @@
 import java.util.Map;
 
 /**
- * A Java representation of the SQL ARRAY type.
+ * A Java representation of the SQL {@code ARRAY} type.
  */
 public interface Array {
 
     /**
-     * Retrieves the contents of the SQL ARRAY value as a Java array object.
+     * Retrieves the contents of the SQL {@code ARRAY} value as a Java array
+     * object.
      * 
      * @return A Java array containing the elements of this Array
      * @throws SQLException
+     *             if there is a database error.
      */
     public Object getArray() throws SQLException;
 
     /**
-     * Returns part of the SQL ARRAY associated with this Array, starting at a
-     * particular index and comprising up to count successive elements of the
-     * SQL array.
+     * Returns part of the SQL {@code ARRAY} associated with this array,
+     * starting at a particular {@code index} and comprising up to {@code count}
+     * successive elements of the SQL array.
      * 
      * @param index
+     *            the start position in the array where the values are
+     *            retrieved.
      * @param count
-     * @return A Java array containing the subportion of elements of this Array
+     *            the number of elements to retrieve.
+     * @return A Java array containing the desired set of elements from this Array
      * @throws SQLException
+     *             if there is a database error.
      */
     public Object getArray(long index, int count) throws SQLException;
 
     /**
-     * Returns part of the SQL ARRAY associated with this Array, starting at a
-     * particular index and comprising up to count successive elements of the
-     * SQL array.
+     * Returns part of the SQL {@code ARRAY} associated with this array,
+     * starting at a particular {@code index} and comprising up to {@code count}
+     * successive elements of the SQL array.
      * 
      * @param index
+     *            the start position in the array where the values are
+     *            retrieved.
      * @param count
+     *            the number of elements to retrieve.
      * @param map
-     * @return A Java array containing the subportion of elements of this Array
+     *            the map defining the correspondence between SQL type names 
+     *            and Java types.
+     * @return A Java array containing the desired set of elements from this Array
      * @throws SQLException
+     *             if there is a database error.
      */
     public Object getArray(long index, int count, Map<String, Class<?>> map)
             throws SQLException;
 
     /**
-     * Returns the SQL ARRAY associated with this Array.
+     * Returns the data from the underlying SQL {@code ARRAY} as a Java array.
      * 
      * @param map
-     * @return A Java array containing the elements of this Array
+     *            the map defining the correspondence between SQL type names 
+     *            and Java types.
+     * @return A Java array containing the elements of this array
      * @throws SQLException
+     *             if there is a database error.
      */
     public Object getArray(Map<String, Class<?>> map) throws SQLException;
 
     /**
-     * Returns the JDBC type of the entries in this Array's associated array.
+     * Returns the JDBC type of the entries in this array's underlying 
+     * SQL array.
      * 
-     * @return An integer constant from the java.sql.Types class
+     * @return An integer constant from the {@code java.sql.Types} class
      * @throws SQLException
+     *             if there is a database error.
      */
     public int getBaseType() throws SQLException;
 
     /**
-     * Returns the SQL type name of the entries in the array associated with
-     * this Array.
+     * Returns the SQL type name of the entries in this array's underlying 
+     * SQL array.
      * 
      * @return The database specific name or a fully-qualified SQL type name.
      * @throws SQLException
+     *              if there is a database error.
      */
     public String getBaseTypeName() throws SQLException;
 
     /**
-     * Returns a ResultSet object which holds the entries of the SQL ARRAY
-     * associated with this Array.
+     * Returns a ResultSet object which holds the entries of the SQL {@code
+     * ARRAY} associated with this array.
      * 
-     * @return the ResultSet
+     * @return the elements of the array as a {@code ResultSet}.
      * @throws SQLException
+     *             if there is a database error.
      */
     public ResultSet getResultSet() throws SQLException;
 
     /**
-     * Returns a ResultSet object that holds the entries of a subarray,
-     * beginning at a particular index and comprising up to count successive
-     * entries.
+     * Returns a {@code ResultSet} object that holds the entries of a subarray,
+     * beginning at a particular index and comprising up to {@code count} 
+     * successive entries.
      * 
      * @param index
+     *            the start position in the array where the values are
+     *            retrieved.
      * @param count
-     * @return the ResultSet
+     *            the number of elements to retrieve.
+     * @return the elements of the array as a {@code ResultSet}.
      * @throws SQLException
+     *             if there is a database error.
      */
     public ResultSet getResultSet(long index, int count) throws SQLException;
 
     /**
-     * Returns a ResultSet object that holds the entries of a subarray,
-     * beginning at a particular index and comprising up to count successive
-     * entries.
+     * Returns a {@code ResultSet} object that holds the entries of a subarray,
+     * beginning at a particular index and comprising up to {@code count} 
+     * successive entries.
      * 
      * @param index
+     *            the start position in the array where the values are
+     *            retrieved.
      * @param count
+     *            the number of elements to retrieve.
      * @param map
-     * @return the ResultSet
+     *            the map defining the correspondence between SQL type names 
+     *            and Java types.
+     * @return the {@code ResultSet} the array's custom type values. if a
+     *         database error has occurred.
      * @throws SQLException
+     *             if there is a database error.
      */
     public ResultSet getResultSet(long index, int count,
             Map<String, Class<?>> map) throws SQLException;
 
     /**
-     * Returns a ResultSet object which holds the entries of the SQL ARRAY
-     * associated with this Array.
+     * Returns a {@code ResultSet} object which holds the entries of the SQL
+     * {@code ARRAY} associated with this array.
      * 
      * @param map
-     * @return the ResultSet
+     *            the map defining the correspondence between SQL type names 
+     *            and Java types.
+     * @return the array as a {@code ResultSet}.
      * @throws SQLException
+     *             if there is a database error.
      */
     public ResultSet getResultSet(Map<String, Class<?>> map)
             throws SQLException;

Modified: harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/BatchUpdateException.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/BatchUpdateException.java?rev=770130&r1=770129&r2=770130&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/BatchUpdateException.java
(original)
+++ harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/BatchUpdateException.java
Thu Apr 30 09:45:40 2009
@@ -20,23 +20,23 @@
 import java.io.Serializable;
 
 /**
- * An exception thrown if a problem occurs during a batch update operation.
+ * This exception is thrown if a problem occurs during a batch update operation.
  * <p>
- * A BatchUpdateException provides additional information about the problem that
- * occurred, compared with a standard SQLException. It supplies update counts
- * for successful commands that executed within the batch update, but before the
+ * A {@code BatchUpdateException} provides additional information about the
+ * problem that occurred, compared with a standard {@code SQLException}. It
+ * supplies update counts for successful commands which were executed before the
  * exception was encountered.
  * <p>
  * The element order in the array of update counts matches the order that the
  * commands were added to the batch operation.
  * <p>
- * Once a batch update command fails and a BatchUpdateException is thrown, the
- * JDBC driver may continue processing the remaining commands in the batch. If
- * the driver does process more commands after the problem occurs, the array
- * returned by BatchUpdateException.getUpdateCounts has an element for every
- * command in the batch, not only those that executed successfully. In this
- * case, the array element for any command which encountered a problem is set to
- * Statement.EXECUTE_FAILED.
+ * Once a batch update command fails and a {@code BatchUpdateException} is
+ * thrown, the JDBC driver may continue processing the remaining commands in the
+ * batch. If the driver does process more commands after the problem occurs, the
+ * array returned by {@code BatchUpdateException.getUpdateCounts} has an element
+ * for every command in the batch, not only those that executed successfully. In
+ * this case, the array element for any command which encountered a problem is
+ * set to {@code Statement.EXECUTE_FAILED}.
  */
 public class BatchUpdateException extends SQLException implements Serializable {
 
@@ -45,19 +45,23 @@
     private int[] updateCounts = null;
 
     /**
-     * Creates a BatchUpdateException with the Reason, SQLState, and Update
-     * Counts set to null and a Vendor Code of 0.
+     * Creates a default {@code BatchUpdateException} with the parameters
+     * <i>reason</i>, <i>SQLState</i>, and <i>update counts</i>
set to {@code
+     * null} and the <i>vendor code</i> set to 0.
      */
     public BatchUpdateException() {
         super();
     }
 
     /**
-     * Creates a BatchUpdateException with the Update Counts set to the supplied
-     * value and the Reason, SQLState set to null and a Vendor Code of 0.
+     * Creates a {@code BatchUpdateException} with the {@code updateCounts} set
+     * to the supplied value. All other fields are set to their
+     * default values.
      * 
      * @param updateCounts
-     *            the array of Update Counts to use in initialization
+     *            the array of {@code updateCounts} giving the number of
+     *            successful updates (or another status code) for each command
+     *            in the batch that was attempted.
      */
     public BatchUpdateException(int[] updateCounts) {
         super();
@@ -65,14 +69,17 @@
     }
 
     /**
-     * Creates a BatchUpdateException with the Update Counts set to the supplied
-     * value, the Reason set to the supplied value and SQLState set to null and
-     * a Vendor Code of 0.
+     * Creates a {@code BatchUpdateException} with the {@code updateCounts} and
+     * {@code reason} set to the supplied values. All other fields are set to their
+     * default values.
      * 
      * @param reason
-     *            the initialization value for Reason
+     *            the message providing information about the source of this
+     *            exception.
      * @param updateCounts
-     *            the array of Update Counts to set
+     *            the array of {@code updateCounts} giving the number of
+     *            successful updates (or another status code) for each command
+     *            in the batch that was attempted.
      */
     public BatchUpdateException(String reason, int[] updateCounts) {
         super(reason);
@@ -80,16 +87,19 @@
     }
 
     /**
-     * Creates a BatchUpdateException with the Update Counts set to the supplied
-     * value, the Reason set to the supplied value, the SQLState initialized to
-     * the supplied value and the Vendor Code initialized to 0.
+     * Creates a {@code BatchUpdateException} with the {@code reason}, {@code
+     * SQLState} and {@code updateCounts} set to the supplied values. All other
+     * fields are set to their default values.
      * 
      * @param reason
-     *            the value to use for the Reason
+     *            the message providing information about the source of this
+     *            exception.
      * @param SQLState
-     *            the X/OPEN value to use for the SQLState
+     *            the X/OPEN value to use for the {@code SQLState}
      * @param updateCounts
-     *            the array of Update Counts to set
+     *            the array of {@code updateCounts} giving the number of
+     *            successful updates (or another status code) for each command
+     *            in the batch that was attempted.
      */
     public BatchUpdateException(String reason, String SQLState,
             int[] updateCounts) {
@@ -98,18 +108,20 @@
     }
 
     /**
-     * Creates a BatchUpdateException with the Update Counts set to the supplied
-     * value, the Reason set to the supplied value, the SQLState initialized to
-     * the supplied value and the Vendor Code set to the supplied value.
+     * Creates a {@code BatchUpdateException} for the case where all relevant
+     * information is provided.
      * 
      * @param reason
-     *            the value to use for the Reason
+     *            the message providing information about the source of this
+     *            exception.
      * @param SQLState
-     *            the X/OPEN value to use for the SQLState
+     *            the X/OPEN value to use for the {@code SQLState}.
      * @param vendorCode
-     *            the value to use for the vendor error code
+     *            the value to use for the vendor error code.
      * @param updateCounts
-     *            the array of Update Counts to set
+     *            the array of {@code updateCounts} giving the number of
+     *            successful updates (or another status code) for each command
+     *            in the batch that was attempted.
      */
     public BatchUpdateException(String reason, String SQLState, int vendorCode,
             int[] updateCounts) {
@@ -118,27 +130,28 @@
     }
 
     /**
-     * Gets the Update Counts array.
+     * Gets the <i>update count</i> array giving status information for every

+     * command that was attempted in the batch.
      * <p>
-     * If a batch update command fails and a BatchUpdateException is thrown, the
-     * JDBC driver may continue processing the remaining commands in the batch.
-     * If the driver does process more commands after the problem occurs, the
-     * array returned by <code>BatchUpdateException.getUpdateCounts</code> has
-     * an element for every command in the batch, not only those that executed
-     * successfully. In this case, the array element for any command which
-     * encountered a problem is set to Statement.EXECUTE_FAILED.
+     * If a batch update command fails and a {@code BatchUpdateException} is
+     * thrown, the JDBC driver may continue processing the remaining commands in
+     * the batch. If the driver does so, the array returned by {@code
+     * BatchUpdateException.getUpdateCounts} has an element for every command in
+     * the batch, not only those that executed successfully. In this case, the
+     * array element for any command which encountered a problem is set to
+     * {@code Statement.EXECUTE_FAILED}.
      * 
      * @return an array that contains the successful update counts, before this
-     *         exception. Alternatively, if the driver continues to process
-     *         commands following an error, one of these listed items for every
-     *         command the batch contains:
+     *         exception was thrown. Alternatively, if the driver continues to
+     *         process commands following an error, for each successive command
+     *         there is a corresponding element in the array giving one of the 
+     *         following status values:
      *         <ol>
-     *         <li>an count of the updates</li>
-     *         <li><code>Statement.SUCCESS_NO_INFO</code> indicating that
the
-     *         command completed successfully, but the amount of altered rows is
-     *         not known.</li>
-     *         <li><code>Statement.EXECUTE_FAILED</code> indicating that
the
-     *         command was unsuccessful.
+     *         <li>the number of successful updates</li> <li>{@code
+     *         Statement.SUCCESS_NO_INFO} indicating that the command completed
+     *         successfully, but the amount of altered rows is unknown.</li> 
+     *         <li>{@code Statement.EXECUTE_FAILED} indicating that the command
+     *         was unsuccessful.</li>
      *         </ol>
      */
     public int[] getUpdateCounts() {

Modified: harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Blob.java
URL: http://svn.apache.org/viewvc/harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Blob.java?rev=770130&r1=770129&r2=770130&view=diff
==============================================================================
--- harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Blob.java (original)
+++ harmony/enhanced/classlib/trunk/modules/sql/src/main/java/java/sql/Blob.java Thu Apr 30
09:45:40 2009
@@ -21,140 +21,151 @@
 import java.io.InputStream;
 
 /**
- * A Java interface mapping for the SQL BLOB type.
+ * A Java interface representing the SQL {@code BLOB} type.
  * <p>
- * An SQL CLOB type stores a large array of bytes (binary data) as the value in
- * a column of a database.
+ * An SQL {@code BLOB} type stores a large array of binary data (bytes) as the
+ * value in a column of a database.
  * <p>
- * The java.sql.Blob interface provides methods for setting and retrieving data
- * in the Blob, for querying Clob data length, for searching for data within the
- * Blob.
+ * The {@code java.sql.Blob} interface provides methods for setting and
+ * retrieving data in the {@code Blob}, for querying {@code Blob} data length,
+ * and for searching for data within the {@code Blob}.
  */
 public interface Blob {
 
     /**
-     * Retrieves this Blob object as a binary stream.
+     * Retrieves this {@code Blob} object as a binary stream.
      * 
-     * @return a binary InputStream giving access to the Blob data
+     * @return a binary {@code InputStream} giving access to the {@code Blob}
+     *         data.
      * @throws SQLException
-     *             if an error occurs accessing the Blob
+     *             if an error occurs accessing the {@code Blob}.
      */
     public InputStream getBinaryStream() throws SQLException;
 
     /**
-     * Gets a portion of the value of this Blob as an array of bytes.
+     * Gets a portion of the value of this {@code Blob} as an array of bytes.
      * 
      * @param pos
-     *            the position of the first byte in the Blob to get, where the
-     *            first byte in the Blob has position = 1
+     *            the position of the first byte in the {@code Blob} to get,
+     *            where the first byte in the {@code Blob} has position 1.
      * @param length
-     *            the number of bytes to get
-     * @return a byte array containing the data from the Blob, starting at pos
-     *         and of length up to <code>length</code> bytes long
+     *            the number of bytes to get.
+     * @return a byte array containing the data from the {@code Blob}, starting
+     *         at {@code pos} and is up to {@code length} bytes long.
      * @throws SQLException
-     *             if an error occurs accessing the Blob
+     *             if an error occurs accessing the {@code Blob}.
      */
     public byte[] getBytes(long pos, int length) throws SQLException;
 
     /**
-     * Gets the number of bytes in this Blob object.
+     * Gets the number of bytes in this {@code Blob} object.
      * 
-     * @return an long value with the length of the Blob in bytes
+     * @return a {@code long} value with the length of the {@code Blob} in
+     *         bytes.
      * @throws SQLException
-     *             if an error occurs accessing the Blob
+     *             if an error occurs accessing the {@code Blob}.
      */
     public long length() throws SQLException;
 
     /**
-     * Search for the position in this Blob at which a specified pattern begins,
-     * starting at a specified position within the Blob.
+     * Search for the position in this {@code Blob} at which a specified pattern
+     * begins, starting at a specified position within the {@code Blob}.
      * 
      * @param pattern
-     *            a Blob containing the pattern of data to search for in this
-     *            Blob
+     *            a {@code Blob} containing the pattern of data to search for in
+     *            this {@code Blob}.
      * @param start
-     *            the position within this Blob to start the search, where the
-     *            first position in the Blob is 1
-     * @return a long value with the position at which the pattern begins. -1 if
-     *         the pattern is not found in this Blob.
+     *            the position within this {@code Blob} to start the search,
+     *            where the first position in the {@code Blob} is {@code 1}.
+     * @return a {@code long} value with the position at which the pattern
+     *         begins. Returns {@code -1} if the pattern is not found in this
+     *         {@code Blob}.
      * @throws SQLException
-     *             if an error occurs accessing the Blob
+     *             if an error occurs accessing the {@code Blob}.
      */
     public long position(Blob pattern, long start) throws SQLException;
 
     /**
-     * Search for the position in this Blob at which the specified pattern
-     * begins, starting at a specified position within the Blob.
+     * Search for the position in this {@code Blob} at which the specified
+     * pattern begins, starting at a specified position within the {@code Blob}.
      * 
      * @param pattern
      *            a byte array containing the pattern of data to search for in
-     *            this Blob
+     *            this {@code Blob}.
      * @param start
-     *            the position within this Blob to start the search, where the
-     *            first position in the Blob is 1
-     * @return a long value with the position at which the pattern begins. -1 if
-     *         the pattern is not found in this Blob.
+     *            the position within this {@code Blob} to start the search,
+     *            where the first position in the {@code Blob} is {@code 1}.
+     * @return a {@code long} value with the position at which the pattern
+     *         begins. Returns {@code -1} if the pattern is not found in this
+     *         {@code Blob}.
      * @throws SQLException
-     *             if an error occurs accessing the Blob
+     *             if an error occurs accessing the {@code Blob}.
      */
     public long position(byte[] pattern, long start) throws SQLException;
 
     /**
-     * Gets a stream that can be used to write binary data to this Blob.
+     * Gets a stream that can be used to write binary data to this {@code Blob}.
      * 
      * @param pos
-     *            the position within this Blob at which to start writing, where
-     *            the first position in the Blob is 1
-     * @return a binary InputStream which can be used to write data into the
-     *         Blob starting at the specified position.
+     *            the position within this {@code Blob} at which to start
+     *            writing, where the first position in the {@code Blob} is
+     *            {@code 1}.
+     * @return a binary {@code InputStream} which can be used to write data into
+     *         the {@code Blob} starting at the specified position.
      * @throws SQLException
-     *             if an error occurs accessing the Blob
+     *             if an error occurs accessing the {@code Blob}.
      */
     public OutputStream setBinaryStream(long pos) throws SQLException;
 
     /**
-     * Writes a specified array of bytes to this Blob. object, starting at a
-     * specified position. Returns the number of bytes written.
+     * Writes a specified array of bytes to this {@code Blob} object, starting
+     * at a specified position. Returns the number of bytes written.
      * 
      * @param pos
-     *            the position within this Blob at which to start writing, where
-     *            the first position in the Blob is 1
+     *            the position within this {@code Blob} at which to start
+     *            writing, where the first position in the {@code Blob} is
+     *            {@code 1}.
      * @param theBytes
-     *            an array of bytes to write into the Blob
-     * @return an integer containing the number of bytes written to the Blob
+     *            an array of bytes to write into the {@code Blob}.
+     * @return an integer containing the number of bytes written to the {@code
+     *         Blob}.
      * @throws SQLException
-     *             if an error occurs accessing the Blob
+     *             if an error occurs accessing the {@code Blob}.
      */
     public int setBytes(long pos, byte[] theBytes) throws SQLException;
 
     /**
-     * Writes a portion of a specified byte array to this Blob. Returns the
-     * number of bytes written.
+     * Writes a portion of a specified byte array to this {@code Blob}. Returns
+     * the number of bytes written.
      * 
      * @param pos
-     *            the position within this Blob at which to start writing, where
-     *            the first position in the Blob is 1
+     *            the position within this {@code Blob} at which to start
+     *            writing, where the first position in the {@code Blob} is
+     *            {@code 1}.
      * @param theBytes
-     *            an array of bytes to write into the Blob
+     *            an array of bytes to write into the {@code Blob}.
      * @param offset
      *            the offset into the byte array from which to start writing
-     *            data - the first byte in the array has offset 0.
+     *            data - the first byte in the array has offset {@code 0}.
      * @param len
-     *            the length of data to write, as the number of bytes
-     * @return an integer containing the number of bytes written to the Blob
+     *            the length of data to write in number of bytes.
+     * @return an integer containing the number of bytes written to the {@code
+     *         Blob}.
      * @throws SQLException
-     *             if an error occurs accessing the Blob
+     *             if an error occurs accessing the {@code Blob}.
      */
     public int setBytes(long pos, byte[] theBytes, int offset, int len)
             throws SQLException;
 
     /**
-     * Truncate the value of this Blob object to a specified length in bytes.
+     * Truncate the value of this {@code Blob} object to a specified length in
+     * bytes.
      * 
      * @param len
-     *            the length of data in bytes to truncate the value of this Blob
+     *            the length of data in bytes after which this {@code Blob}
+     *            is to be truncated.
      * @throws SQLException
-     *             if an error occurs accessing the Blob
+     *             if an error occurs accessing the {@code Blob}.
      */
     public void truncate(long len) throws SQLException;
 }



Mime
View raw message