JDK 9 RFR of 8154183: (spec) {Data, }InputStream.read(byte[], int, int) - spec of offset argument confusing

Brian Burkhalter brian.burkhalter at oracle.com
Mon Apr 18 20:53:27 UTC 2016


A new patch generated using the latest version of webrev is here:

http://cr.openjdk.java.net/~bpb/8154183/webrev.01/

I have addressed the various editorial comments except with respect to capitalizing the first word after the exception name and ending the @throws description with a period: I have made the new @throws clauses consistent with other such clauses already present in the same method. In some case this means starting with lower case, in others upper case; likewise in some cases there are periods at the end, in other cases not.

Thanks,

Brian

On Apr 18, 2016, at 12:45 PM, Roger Riggs <Roger.Riggs at Oracle.com> wrote:

> - In the new @throws NullPointerException and IndexOutOfBoundExceptions,
>   the first word after the exception should not be capitalized.
>   For example  "if" instead of "If"  makes it consistent with the existing doc
> 
> ObjectInputStream.java:  line 1012+
> - usually the @throws description is not a complete sentence and does not deserve a "."
>  per-file-consistency...
>  for example,
> +     * @throws  NullPointerException If {@code buf} is {@code null}*.




More information about the core-libs-dev mailing list