<AWT Dev> RFR: 8264125: Specification of Taskbar::getIconImage doesn't mention that the returned image might not be equal to the Taskbar::setIconImage one. (eg on Mac OS) [v4]

[Phil Race]

On Thu, 17 Jun 2021 17:33:48 GMT, Alexander Zvegintsev <azvegint at openjdk.org> wrote:

>> This fix is to explicitly specify that `Taskbar::getIconImage` may return an object different from passed to `Taskbar::setIconImage`.
>> 
>> Actually it is always returns a different object on macOS(the only OS which supports this feature), but I want to save some options if we decide to rework this.
>
> Alexander Zvegintsev has updated the pull request incrementally with one additional commit since the last revision:
> 
>   header fix

src/java.desktop/share/classes/java/awt/Taskbar.java line 325:

> 323: 
> 324:     /**
> 325:      * Suggests the system to change this application's icon to the provided {@code image}.

Suggests -> Requests

src/java.desktop/share/classes/java/awt/Taskbar.java line 341:

> 339:     /**
> 340:      * Obtains an image of this application's icon.
> 341:      * <p>

As discussed off-line, preface this with "@apiNote"

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

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