Fix for Javadoc errors in java.base

Vipin Sharma vipinsharma85 at gmail.com
Fri Aug 14 18:46:40 UTC 2020


Hi Sean,

All 3 instances of @exception in DHPrivateKey are now replaced with @throws, added ProviderException similar to other constructor of DHPrivateKey.

Updated patch:

--- old/src/java.base/share/classes/com/sun/crypto/provider/DHPrivateKey.java	2020-08-14 23:55:40.921599987 +0530
+++ new/src/java.base/share/classes/com/sun/crypto/provider/DHPrivateKey.java	2020-08-14 23:55:40.417581423 +0530
@@ -80,7 +80,7 @@
      * @param p the prime modulus
      * @param g the base generator
      *
-     * @exception ProviderException if the key cannot be encoded
+     * @throws ProviderException if the key cannot be encoded
      */
     DHPrivateKey(BigInteger x, BigInteger p, BigInteger g)
         throws InvalidKeyException {
@@ -97,7 +97,7 @@
      * @param g the base generator
      * @param l the private-value length
      *
-     * @exception InvalidKeyException if the key cannot be encoded
+     * @throws ProviderException if the key cannot be encoded
      */
     DHPrivateKey(BigInteger x, BigInteger p, BigInteger g, int l) {
         this.x = x;
@@ -118,7 +118,7 @@
      *
      * @param encodedKey the encoded key
      *
-     * @exception InvalidKeyException if the encoded key does not represent
+     * @throws InvalidKeyException if the encoded key does not represent
      * a Diffie-Hellman private key
      */
     DHPrivateKey(byte[] encodedKey) throws InvalidKeyException {
--- old/src/java.base/share/classes/java/lang/invoke/AbstractValidatingLambdaMetafactory.java	2020-08-14 23:55:41.953638446 +0530
+++ new/src/java.base/share/classes/java/lang/invoke/AbstractValidatingLambdaMetafactory.java	2020-08-14 23:55:41.445619497 +0530
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2012, 2013, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 2012, 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
@@ -208,7 +208,7 @@
      *
      * @return a CallSite, which, when invoked, will return an instance of the
      * functional interface
-     * @throws ReflectiveOperationException
+     * @throws LambdaConversionException
      */
     abstract CallSite buildCallSite()
             throws LambdaConversionException;
--- old/src/java.base/share/classes/java/lang/invoke/InnerClassLambdaMetafactory.java	2020-08-14 23:55:42.977677096 +0530
+++ new/src/java.base/share/classes/java/lang/invoke/InnerClassLambdaMetafactory.java	2020-08-14 23:55:42.473658062 +0530
@@ -200,7 +200,6 @@
      *
      * @return a CallSite, which, when invoked, will return an instance of the
      * functional interface
-     * @throws ReflectiveOperationException
      * @throws LambdaConversionException If properly formed functional interface
      * is not found
      */
--- old/src/java.base/share/classes/java/math/BigDecimal.java	2020-08-14 23:55:44.409731999 +0530
+++ new/src/java.base/share/classes/java/math/BigDecimal.java	2020-08-14 23:55:43.889711942 +0530
@@ -5403,7 +5403,7 @@
      *
      * @param n the numerator; must be negative
      * @param d the denominator; must not be unity
-     * @return a two-element {@long} array with the remainder and quotient in
+     * @return a two-element {@code long} array with the remainder and quotient in
      *         the initial and final elements, respectively
      */
     private static long[] divRemNegativeLong(long n, long d) {
--- old/src/java.base/share/classes/java/math/MutableBigInteger.java	2020-08-14 23:55:45.905790246 +0530
+++ new/src/java.base/share/classes/java/math/MutableBigInteger.java	2020-08-14 23:55:45.397770378 +0530
@@ -145,7 +145,6 @@
      * Makes this number an {@code n}-int number all of whose bits are ones.
      * Used by Burnikel-Ziegler division.
      * @param n number of ints in the {@code value} array
-     * @return a number equal to {@code ((1<<(32*n)))-1}
      */
     private void ones(int n) {
         if (n > value.length)
--- old/src/java.base/share/classes/java/net/ServerSocket.java	2020-08-14 23:55:46.961831962 +0530
+++ new/src/java.base/share/classes/java/net/ServerSocket.java	2020-08-14 23:55:46.449811716 +0530
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 1995, 2019, Oracle and/or its affiliates. All rights reserved.
+ * Copyright (c) 1995, 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
@@ -315,7 +315,7 @@
     /**
      * Creates the socket implementation.
      *
-     * @throws IOException if creation fails
+     * @throws SocketException if creation fails
      * @since 1.4
      */
     void createImpl() throws SocketException {
--- old/src/java.base/share/classes/java/net/Socket.java	2020-08-14 23:55:48.001873514 +0530
+++ new/src/java.base/share/classes/java/net/Socket.java	2020-08-14 23:55:47.493853209 +0530
@@ -533,7 +533,7 @@
      *
      * @param stream a {@code boolean} value : {@code true} for a TCP socket,
      *               {@code false} for UDP.
-     * @throws IOException if creation fails
+     * @throws SocketException if creation fails
      * @since 1.4
      */
      void createImpl(boolean stream) throws SocketException {
--- old/src/java.base/share/classes/sun/reflect/annotation/AnnotationParser.java	2020-08-14 23:55:49.061916354 +0530
+++ new/src/java.base/share/classes/sun/reflect/annotation/AnnotationParser.java	2020-08-14 23:55:48.549895649 +0530
@@ -1,5 +1,5 @@
 /*
- * Copyright (c) 2003, 2013, 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
@@ -773,7 +773,7 @@
      * an "annotation structure" OR two bytes into an annotation
      * structure (i.e., after the type index).
      *
-     * @parameter complete true if the byte buffer points to the beginning
+     * @param complete true if the byte buffer points to the beginning
      *     of an annotation structure (rather than two bytes in).
      */
     private static void skipAnnotation(ByteBuffer buf, boolean complete) {


Regards,
Vipin

> On Aug 13, 2020, at 10:55 PM, Sean Mullan <sean.mullan at oracle.com> wrote:
> 
> On 8/13/20 1:21 PM, Jonathan Gibbons wrote:
>>>>> --- old/src/java.base/share/classes/com/sun/crypto/provider/DHPrivateKey.java 
>>>>> 2020-07-25 23:46:21.233726447 +0530
>>>>> +++ new/src/java.base/share/classes/com/sun/crypto/provider/DHPrivateKey.java 
>>>>> 2020-07-25 23:46:20.721720857 +0530
>>>>> @@ -96,8 +96,6 @@
>>>>>        * @param p the prime modulus
>>>>>        * @param g the base generator
>>>>>        * @param l the private-value length
>>>>> -     *
>>>>> -     * @exception InvalidKeyException if the key cannot be encoded
>>> 
>>> This should actually remain, but it should be ProviderException which is a RuntimeException. See the other DHPrivateKey ctor as that specifies it correctly.
>>> 
>>> --Sean
>> I note the use of `@exception`, as compared to `@throws`, which is more common.
>> Stats:
>> `@exception` 7322 occurrences
>> `@throws` 21173 occurrences
>> That's probably too many `@exception` to clean up. :-(
> 
> Right, that's probably a separate cleanup activity. However, if you want to change the 3 instances of @exception to @throws in DHPrivateKey, I'm fine with that.
> 
> --Sean

-------------- next part --------------
An HTML attachment was scrubbed...
URL: <https://mail.openjdk.java.net/pipermail/security-dev/attachments/20200815/152f85d3/attachment-0001.htm>


More information about the security-dev mailing list