Skip to content

Commit 418e4a2

Browse files
author
Roger Riggs
committed
8252830: Correct missing javadoc comments in java.rmi module
Reviewed-by: dfuchs, lancea, smarks, chegar
1 parent 41d29b7 commit 418e4a2

File tree

4 files changed

+38
-1
lines changed

4 files changed

+38
-1
lines changed

src/java.rmi/share/classes/java/rmi/activation/ActivationGroupDesc.java

+8-1
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ public final class ActivationGroupDesc implements Serializable {
9090
private Properties props;
9191

9292
/** indicate compatibility with the Java 2 SDK v1.2 version of class */
93+
@java.io.Serial
9394
private static final long serialVersionUID = -4936225423168276595L;
9495

9596
/**
@@ -204,6 +205,7 @@ public CommandEnvironment getCommandEnvironment() {
204205
* @since 1.2
205206
*/
206207
public static class CommandEnvironment implements Serializable {
208+
@java.io.Serial
207209
private static final long serialVersionUID = 6165754737887770191L;
208210

209211
/**
@@ -308,12 +310,17 @@ public int hashCode()
308310
*
309311
* <p>This method reads this object's serialized form for this
310312
* class as follows:
311-
*
312313
* <p>This method first invokes <code>defaultReadObject</code> on
313314
* the specified object input stream, and if <code>options</code>
314315
* is <code>null</code>, then <code>options</code> is set to a
315316
* zero-length array of <code>String</code>.
317+
*
318+
* @param in the {@code ObjectInputStream} from which data is read
319+
* @throws IOException if an I/O error occurs
320+
* @throws ClassNotFoundException if a serialized class cannot be loaded
321+
*
316322
*/
323+
@java.io.Serial
317324
private void readObject(ObjectInputStream in)
318325
throws IOException, ClassNotFoundException
319326
{

src/java.rmi/share/classes/java/rmi/activation/ActivationID.java

+11
Original file line numberDiff line numberDiff line change
@@ -90,6 +90,7 @@ public class ActivationID implements Serializable {
9090
private transient UID uid = new UID();
9191

9292
/** indicate compatibility with the Java 2 SDK v1.2 version of class */
93+
@java.io.Serial
9394
private static final long serialVersionUID = -4608673054848209235L;
9495

9596
/** an AccessControlContext with no permissions */
@@ -228,7 +229,11 @@ public boolean equals(Object obj) {
228229
* java.rmi.server.RemoteObject RemoteObject}
229230
* <code>writeObject</code> method <b>serialData</b>
230231
* specification.
232+
*
233+
* @param out the {@code ObjectOutputStream} to which data is written
234+
* @throws IOException if an I/O error occurs
231235
**/
236+
@java.io.Serial
232237
private void writeObject(ObjectOutputStream out)
233238
throws IOException
234239
{
@@ -287,7 +292,13 @@ private void writeObject(ObjectOutputStream out)
287292
* class corresponding to that external ref type name, in which
288293
* case the <code>RemoteRef</code> will be an instance of
289294
* that implementation-specific class.
295+
*
296+
* @param in the {@code ObjectInputStream} from which data is read
297+
* @throws IOException if an I/O error occurs
298+
* @throws ClassNotFoundException if a serialized class cannot be loaded
299+
*
290300
*/
301+
@java.io.Serial
291302
private void readObject(ObjectInputStream in)
292303
throws IOException, ClassNotFoundException
293304
{

src/java.rmi/share/classes/java/rmi/server/RemoteObject.java

+11
Original file line numberDiff line numberDiff line change
@@ -25,6 +25,7 @@
2525

2626
package java.rmi.server;
2727

28+
import java.io.IOException;
2829
import java.rmi.Remote;
2930
import java.rmi.NoSuchObjectException;
3031
import java.lang.reflect.Proxy;
@@ -47,6 +48,7 @@ public abstract class RemoteObject implements Remote, java.io.Serializable {
4748
transient protected RemoteRef ref;
4849

4950
/** indicate compatibility with JDK 1.1.x version of class */
51+
@java.io.Serial
5052
private static final long serialVersionUID = -3215090123894869218L;
5153

5254
/**
@@ -357,7 +359,11 @@ public String toString() {
357359
* <code>"UnicastServerRef2"</code>, no data is written by the
358360
* <code>writeExternal</code> method or read by the
359361
* <code>readExternal</code> method.
362+
*
363+
* @param out the {@code ObjectOutputStream} to which data is written
364+
* @throws IOException if an I/O error occurs
360365
*/
366+
@java.io.Serial
361367
private void writeObject(java.io.ObjectOutputStream out)
362368
throws java.io.IOException
363369
{
@@ -418,7 +424,12 @@ private void writeObject(java.io.ObjectOutputStream out)
418424
* class corresponding to that external ref type name, in which
419425
* case this object's <code>ref</code> field will be set to an
420426
* instance of that implementation-specific class.
427+
*
428+
* @param in the {@code ObjectInputStream} from which data is read
429+
* @throws IOException if an I/O error occurs
430+
* @throws ClassNotFoundException if a serialized class cannot be loaded
421431
*/
432+
@java.io.Serial
422433
private void readObject(java.io.ObjectInputStream in)
423434
throws java.io.IOException, java.lang.ClassNotFoundException
424435
{

src/java.rmi/share/classes/java/rmi/server/UnicastRemoteObject.java

+8
Original file line numberDiff line numberDiff line change
@@ -24,6 +24,7 @@
2424
*/
2525
package java.rmi.server;
2626

27+
import java.io.IOException;
2728
import java.io.ObjectInputFilter;
2829
import java.rmi.*;
2930
import sun.rmi.server.UnicastServerRef;
@@ -195,6 +196,7 @@ public class UnicastRemoteObject extends RemoteServer {
195196
private RMIServerSocketFactory ssf = null;
196197

197198
/* indicate compatibility with JDK 1.1.x version of class */
199+
@java.io.Serial
198200
private static final long serialVersionUID = 4974527148936298033L;
199201

200202
/**
@@ -259,7 +261,13 @@ protected UnicastRemoteObject(int port,
259261

260262
/**
261263
* Re-export the remote object when it is deserialized.
264+
*
265+
* @param in the {@code ObjectInputStream} from which data is read
266+
* @throws IOException if an I/O error occurs
267+
* @throws ClassNotFoundException if a serialized class cannot be loaded
268+
*
262269
*/
270+
@java.io.Serial
263271
private void readObject(java.io.ObjectInputStream in)
264272
throws java.io.IOException, java.lang.ClassNotFoundException
265273
{

0 commit comments

Comments
 (0)