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

Ivan Gerasimov ivan.gerasimov at oracle.com
Fri Aug 8 00:09:44 UTC 2014


Hi Lance!

I like to grep for the word duplicates :)
Under jdk/src/share/classes/javax/sql grep found:

./rowset/spi/SyncFactory.java:     * Adds*the the* given synchronization 
provider to the factory register. Guidelines
./rowset/spi/SyncFactory.java:     * ROWSET properties and stores lazy 
references into*the the* internal registry.
./rowset/spi/SyncProvider.java: * degrees *of of *care. The first group 
of constants indicate how synchronization
./rowset/spi/package.html:For *the the* next level up, the
./rowset/BaseRowSet.java:     * in the driver documentation. Although 
there are guidelines*for for *how
./rowset/RowSetProvider.java:     * in jars available to the runtime. 
For example, to have*the the* RowSetFactory
./rowset/JoinRowSet.java: * A match column can *be be *set in two ways:
./rowset/JoinRowSet.java:     * An ANSI-style <code>JOIN</code> 
providing *a a* full JOIN. Specifies that all
./rowset/serial/package.html:that *the the* originating data source 
manages. <br>
./rowset/serial/package.html:<code>wasNull</code> is used to determine 
whether *the the* last value read was SQL NULL.
./rowset/CachedRowSet.java:    * until*all all *components reading this 
<code>CachedRowSet</code> object
./rowset/CachedRowSet.java:    *     row *in in* this 
<code>CachedRowSet</code> object
./rowset/CachedRowSet.java:    * on *the the* rowset reader 
(<code>RowSetReader</code> object) from the
./rowset/CachedRowSet.java:    *      was instantiated, or if none *was 
was* set, the default provider
./rowset/FilteredRowSet.java: * <code>FilteredRowSet</code> object are 
detected. A new filter*has has* an
./rowset/RowSetMetaDataImpl.java:     * Retrieves*the the* suggested 
column title for the designated
./rowset/RowSetMetaDataImpl.java:         * The field that holds *the 
the* type name used by this particular data source
./rowset/package.html:standard interfaces specified in this package *and 
and* <b>may</b> extend the

Would you please include these typo fixes in your patch?

Sincerely yours,
Ivan

On 08.08.2014 3:57, Lance @ Oracle wrote:
> Hi joe,
>
> Thank you for the quick review.
>
> I will change those to {@code Inputstream}
>
> 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
> Sent from my iPad
>
>> On Aug 7, 2014, at 7:49 PM, Joe Darcy <joe.darcy at oracle.com> wrote:
>>
>>> 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