8251208: Add missing javadoc comments to java.sql and java.sql.rowsets

Reviewed-by: joehw

src/java.sql.rowset/share/classes/javax/sql/rowset/RowSetMetaDataImpl.java

@@ -949,6 +949,11 @@ public class RowSetMetaDataImpl implements RowSetMetaData,  Serializable {
 
     static final long serialVersionUID = 6893806403181801867L;
 
+    /**
+     * {@code ColInfo} objects are used to store information
+     * about each column in the {@code RowSet} object for which
+     * this {@code RowSetMetaDataImpl} object was created.
+     */
     private class ColInfo implements Serializable {
         /**
          * The field that indicates whether the value in this column is a number

src/java.sql.rowset/share/classes/javax/sql/rowset/serial/SerialArray.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -608,6 +608,11 @@ public class SerialArray implements Array, Serializable, Cloneable {
     /**
      * readObject is called to restore the state of the {@code SerialArray} from
      * a stream.
+     * @param s the {@code ObjectInputStream} to read from.
+     *
+     * @throws  ClassNotFoundException if the class of a serialized object
+     *          could not be found.
+     * @throws  IOException if an I/O error occurs.
      */
     private void readObject(ObjectInputStream s)
             throws IOException, ClassNotFoundException {
@@ -628,6 +633,8 @@ public class SerialArray implements Array, Serializable, Cloneable {
     /**
      * writeObject is called to save the state of the {@code SerialArray}
      * to a stream.
+     * @param s the {@code ObjectOutputStream} to write to.
+     * @throws  IOException if an I/O error occurs.
      */
     private void writeObject(ObjectOutputStream s)
             throws IOException {

src/java.sql.rowset/share/classes/javax/sql/rowset/serial/SerialBlob.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -550,6 +550,11 @@ public class SerialBlob implements Blob, Serializable, Cloneable {
     /**
      * readObject is called to restore the state of the SerialBlob from
      * a stream.
+     * @param s the {@code ObjectInputStream} to read from.
+     *
+     * @throws  ClassNotFoundException if the class of a serialized object
+     *          could not be found.
+     * @throws  IOException if an I/O error occurs.
      */
     private void readObject(ObjectInputStream s)
             throws IOException, ClassNotFoundException {
@@ -569,6 +574,8 @@ public class SerialBlob implements Blob, Serializable, Cloneable {
     /**
      * writeObject is called to save the state of the SerialBlob
      * to a stream.
+     * @param s the {@code ObjectOutputStream} to write to.
+     * @throws  IOException if an I/O error occurs.
      */
     private void writeObject(ObjectOutputStream s)
             throws IOException {

src/java.sql.rowset/share/classes/javax/sql/rowset/serial/SerialClob.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -643,6 +643,11 @@ public class SerialClob implements Clob, Serializable, Cloneable {
     /**
      * readObject is called to restore the state of the SerialClob from
      * a stream.
+     * @param s the {@code ObjectInputStream} to read from.
+     *
+     * @throws  ClassNotFoundException if the class of a serialized object
+     *          could not be found.
+     * @throws  IOException if an I/O error occurs.
      */
     private void readObject(ObjectInputStream s)
             throws IOException, ClassNotFoundException {
@@ -662,6 +667,8 @@ public class SerialClob implements Clob, Serializable, Cloneable {
     /**
      * writeObject is called to save the state of the SerialClob
      * to a stream.
+     * @param s the {@code ObjectOutputStream} to write to.
+     * @throws  IOException if an I/O error occurs.
      */
     private void writeObject(ObjectOutputStream s)
             throws IOException {

src/java.sql.rowset/share/classes/javax/sql/rowset/serial/SerialJavaObject.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -234,6 +234,11 @@ public class SerialJavaObject implements Serializable, Cloneable {
     /**
      * readObject is called to restore the state of the {@code SerialJavaObject}
      * from a stream.
+     * @param s the {@code ObjectInputStream} to read from.
+     *
+     * @throws  ClassNotFoundException if the class of a serialized object
+     *          could not be found.
+     * @throws  IOException if an I/O error occurs.
      */
     private void readObject(ObjectInputStream s)
             throws IOException, ClassNotFoundException {
@@ -259,6 +264,8 @@ public class SerialJavaObject implements Serializable, Cloneable {
     /**
      * writeObject is called to save the state of the {@code SerialJavaObject}
      * to a stream.
+     * @param s the {@code ObjectOutputStream} to write to.
+     * @throws  IOException if an I/O error occurs.
      */
     private void writeObject(ObjectOutputStream s)
             throws IOException {

src/java.sql.rowset/share/classes/javax/sql/rowset/serial/SerialRef.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -225,6 +225,11 @@ public class SerialRef implements Ref, Serializable, Cloneable {
     /**
      * readObject is called to restore the state of the SerialRef from
      * a stream.
+     * @param s the {@code ObjectInputStream} to read from.
+     *
+     * @throws  ClassNotFoundException if the class of a serialized object
+     *          could not be found.
+     * @throws  IOException if an I/O error occurs.
      */
     private void readObject(ObjectInputStream s)
             throws IOException, ClassNotFoundException {
@@ -237,6 +242,8 @@ public class SerialRef implements Ref, Serializable, Cloneable {
     /**
      * writeObject is called to save the state of the SerialRef
      * to a stream.
+     * @param s the {@code ObjectOutputStream} to write to.
+     * @throws  IOException if an I/O error occurs.
      */
     private void writeObject(ObjectOutputStream s)
             throws IOException {

src/java.sql.rowset/share/classes/javax/sql/rowset/serial/SerialStruct.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2003, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -318,6 +318,11 @@ public class SerialStruct implements Struct, Serializable, Cloneable {
     /**
      * readObject is called to restore the state of the {@code SerialStruct} from
      * a stream.
+     * @param s the {@code ObjectInputStream} to read from.
+     *
+     * @throws  ClassNotFoundException if the class of a serialized object
+     *          could not be found.
+     * @throws  IOException if an I/O error occurs.
      */
     private void readObject(ObjectInputStream s)
             throws IOException, ClassNotFoundException {
@@ -331,6 +336,8 @@ public class SerialStruct implements Struct, Serializable, Cloneable {
     /**
      * writeObject is called to save the state of the {@code SerialStruct}
      * to a stream.
+     * @param s the {@code ObjectOutputStream} to write to.
+     * @throws  IOException if an I/O error occurs.
      */
     private void writeObject(ObjectOutputStream s)
             throws IOException {

src/java.sql/share/classes/java/sql/BatchUpdateException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1998, 2014, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1998, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -528,6 +528,11 @@ public class BatchUpdateException extends SQLException {
     /**
      * readObject is called to restore the state of the
      * {@code BatchUpdateException} from a stream.
+     * @param s the {@code ObjectInputStream} to read from.
+     *
+     * @throws  ClassNotFoundException if the class of a serialized object
+     *          could not be found.
+     * @throws  IOException if an I/O error occurs.
      */
     private void readObject(ObjectInputStream s)
             throws IOException, ClassNotFoundException {
@@ -551,6 +556,8 @@ public class BatchUpdateException extends SQLException {
     /**
      * writeObject is called to save the state of the {@code BatchUpdateException}
      * to a stream.
+     * @param s the {@code ObjectOutputStream} to write to.
+     * @throws  IOException if an I/O error occurs.
      */
     private void writeObject(ObjectOutputStream s)
             throws IOException {

src/java.sql/share/classes/java/sql/SQLClientInfoException.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2006, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2006, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -47,8 +47,9 @@ import java.util.Map;
  */
 public class SQLClientInfoException extends SQLException {
 
-
+        /**
-
+         * A {@code Map} containing the client info properties that could not be set.
+         */
         @SuppressWarnings("serial") // Not statically typed as Serializable
         private Map<String, ClientInfoStatus>   failedProperties;
 

src/java.sql/share/classes/javax/sql/StatementEvent.java

@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2005, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2005, 2020, Oracle and/or its affiliates. All rights reserved.
  * DO NOT ALTER OR REMOVE COPYRIGHT NOTICES OR THIS FILE HEADER.
  *
  * This code is free software; you can redistribute it and/or modify it
@@ -43,7 +43,14 @@ import java.util.EventObject;
 public class StatementEvent extends EventObject {
 
         static final long serialVersionUID = -8089573731826608315L;
+        /**
+         * The {@code SQLException} the driver is about to throw to the application.
+         */
         private SQLException            exception;
+
+        /**
+         * The {@code PreparedStatement} that is being closed or is invalid.
+         */
         @SuppressWarnings("serial") // Not statically typed as Serializable
         private PreparedStatement       statement;