[OpenJDK 2D-Dev] RFR: 6206189: Graphics2D.clip specifies incorrectly that a 'null' is a valid value for this method [v6]

[Alexey Ivanov]

On Mon, 15 Feb 2021 12:48:01 GMT, Prasanta Sadhukhan <psadhukhan at openjdk.org> wrote:

>> The API doc for Graphics2D.clip(shape s) claims that passing a null argument would actually clear the existing clipping area, which is incorrect.
>> This statement is applicable only to G2D.setClip() and not for the clip() method. G2D.clip() would throw a NullPointerException when it encounters a null argument. 
>> Updated spec to rectify this.
>
> Prasanta Sadhukhan has updated the pull request incrementally with one additional commit since the last revision:
> 
>   javdoc tag for NPE

src/java.desktop/share/classes/java/awt/Graphics2D.java line 1205:

> 1203:      * user clip. Since this method intersects the specified shape
> 1204:      * with the current clip, it will throw {@code NullPointerException} for a null shape
> 1205:      * unless the user clip is also null.

Shall the text be re-wrapped?

I'm not sure if null should always be {@code null}, it's not used consistently. At the same time, two lines above it's “…with a {@code null} argument…”; it makes sense to make Javadoc consistent in this regard at least for one method.

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

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