RFR [15] 8241014: Miscellaneous typos in documentation comments

Pavel Rappo pavel.rappo at oracle.com
Fri Mar 13 15:42:03 UTC 2020


Hello,

Please review the change for https://bugs.openjdk.java.net/browse/JDK-8241014:

  http://cr.openjdk.java.net/~prappo/8241014/webrev.00/

This is a documentation cleanup. There are no code changes involved,
and the changes in documentation are mostly trivial.

The following packages are affected:

    java.lang,
    java.nio.file,
    java.nio.file.attribute,
    java.security,
    java.time.chrono,
    java.time.temporal,
    java.util,
    java.util.regex,
    java.util.stream,
    javax.crypto,
    javax.security.cert,
    javax.tools

That said, there are two changes that I'd prefer to be carefully reviewed by
the experts in the corresponding areas.

The first one is for a suspected typo in the javax.crypto.CryptoPolicyParser
class, "AlgrithomParameterSpec". It is not unheard-of for typos to be kept and
supported for the sake of backward compatibility. Sadly, we have a number of
those in OpenJDK. Even though I performed reasonable checks, the proposed fix
should better be verified by the security folk.

The second one is for the doc comment for the java.util.stream.Stream.collect method.

     @apiNote
     The following will accumulate strings into an ArrayList:

         List<String> asList = stringStream.collect(Collectors.toList());

Given that the spec for Collectors.toList() clearly says that

    ...There are no guarantees on the type, mutability, serializability, or
    thread-safety of the List returned;...

I'd assume that @apiNote should be fixed as proposed.

-Pavel

P.S. Apologies for spamming multiple mailing lists. 



More information about the security-dev mailing list