RFR: 8054555, javadoc clean-up in java.sql, javax.sql.*

Joe Darcy joe.darcy at oracle.com
Thu Aug 7 23:49:41 UTC 2014


On 08/07/2014 03:44 PM, Lance Andersen wrote:
> Hi,
>
> Looking for a reviewer for corrections to various javadoc typos
>
> The webrev can be found at http://cr.openjdk.java.net/~lancea/8054555/webrev.00/
>
> Best,
> Lance
>
>
> Lance Andersen| Principal Member of Technical Staff | +1.781.442.2037
> Oracle Java Engineering
> 1 Network Drive
> Burlington, MA 01803
> Lance.Andersen at oracle.com
>
>
>

Hi Lance,

In src/share/classes/java/sql/CallableStatement.java

@@ -1899,7 +1900,7 @@
       * @param length the number of bytes in the parameter data.
       * @throws SQLException  if parameterName does not correspond to a 
named
       * parameter; if the length specified
-     * is less than zero; if the number of bytes in the inputstream 
does not match
+     * 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</code>
       * @exception SQLFeatureNotSupportedException if the JDBC driver 
does not support

I think the new line would be better using either "input stream" or 
"{@code InputStream}".

Similar comment in src/share/classes/javax/sql/RowSet.java

@@ -1420,7 +1420,7 @@
    void setBlob (int i, Blob x) throws SQLException;

    /**
-     * Sets the designated parameter to a <code>InputStream</code> 
object.  The inputstream must contain  the number
+     * Sets the designated parameter to a <code>InputStream</code> 
object.  The <code>InputStream</code> must contain  the number
       * of characters specified by length otherwise a 
<code>SQLException</code> will be
       * generated when the <code>PreparedStatement</code> is executed.
       * This method differs from the <code>setBinaryStream (int, 
InputStream, int)</code>

@@ -1474,7 +1474,8 @@
          throws SQLException;

    /**
-     * Sets the designated parameter to a <code>InputStream</code> 
object.  The <code>inputstream</code> must contain  the number
+     * Sets the designated parameter to a <code>InputStream</code> object.
+     * The <code>inputstream</code> must contain  the number
       * of characters specified by length, otherwise a 
<code>SQLException</code> will be
       * generated when the <code>CallableStatement</code> is executed.
       * This method differs from the <code>setBinaryStream (int, 
InputStream, int)</code>

Otherwise, the changes look okay.

Cheers,

-Joe



More information about the core-libs-dev mailing list