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 19:57:00 UTC 2016


Hi Roger,

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

> Editorial cleanup.
> - 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

I noticed that but it was inconsistent throughout the files. Will Change.

> DataInputStream:
> - "the start offset in*to* the"  ;  "in" preferred over "into" consistent with previous descriptions
> 
> 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}*.
> 
> *RandomAccessFile: 433+
> 
> - keep the alignment of the @param lines
> - @throws NPE; remvoe the training “."

Will update those also.

> p.s.  There is a new version of webrev that generates convenient next and prev file links.

I noticed that in, I believe, Claes’s webrevs but had not updated mine yet; thanks for mentioning: it is convenient.

Thanks,

Brian


More information about the core-libs-dev mailing list