RFR: 8247918: Clarify Reader.skip behavior for end of stream [v2]

[Brian Burkhalter]

On Fri, 12 Feb 2021 16:03:09 GMT, Roger Riggs <rriggs at openjdk.org> wrote:

>> Brian Burkhalter has updated the pull request incrementally with one additional commit since the last revision:
>> 
>>   8247918: Change'ns' to 'n' in the skip doc
>
> src/java.base/share/classes/java/io/LineNumberReader.java line 270:
> 
>> 268: 
>> 269:     /**
>> 270:      * {@inheritDoc}
> 
> This appears to make the skip method disappear from the LineNumberReader javadoc
> and only show up as a method declared in Reader.

Right. This is intended and expected.

> src/java.base/share/classes/java/io/CharArrayReader.java line 149:
> 
>> 147: 
>> 148:     /**
>> 149:      * {@inheritDoc}
> 
> Using inheritDoc for the exceptions adds several new and irrelevant impossible causes to the javadoc.
> " This method will block until some characters are available", etc.
> It also drops the existing "If the stream is closed" condition on @ throws IOException.

As above for `StringReader`.

> src/java.base/share/classes/java/io/PushbackReader.java line 257:
> 
>> 255: 
>> 256:     /**
>> 257:      * {@inheritDoc}
> 
> This appears to make the skip method disappear from the PushbackReader javadoc
> and only show up as a method declared in FilterReader.

This is intended and expected.

> src/java.base/share/classes/java/io/BufferedReader.java line 400:
> 
>> 398: 
>> 399:     /**
>> 400:      * {@inheritDoc}
> 
> This appears to make the skip method disappear from the BufferedReader javadoc
> and only show up as a method declared in Reader.

This is intended and expected.

-------------

PR: https://git.openjdk.java.net/jdk/pull/2274