jmx-dev RFR: 8335625: Update Javadoc for GetCpuLoad

[Kevin Walls]

On Wed, 21 Aug 2024 11:35:26 GMT, Alan Bateman <alanb at openjdk.org> wrote:

>> src/jdk.management/share/classes/com/sun/management/OperatingSystemMXBean.java line 142:
>> 
>>> 140:      * negative value.
>>> 141:      *
>>> 142:      * <p> This method is not idempotent. The recent period of observation
>> 
>> I would not expect this method to be "idempotent" so it seems very odd to me to state this. Overall this sounds like you are now specifying an implementation limitation as the only way this can be done. Maybe this should be an `@ImplNote` ?
>
> You beat me to it. We specify some methods (close, dispose, ...) as idempotent. Specifying a getter as non-idempotent looks very strange here.
> 
> I can't tell if you are looking to specify implementation behavior (as David asks) or whether you want to provide advice for users of this API, in which case an apiNote may be the tag you need.

Ok yes maybe "not idempotent" isn't a great term here.
Just removing that phrase, "This method is not idempotent.", this would still be a helpful update.

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

PR Review Comment: https://git.openjdk.org/jdk/pull/20546#discussion_r1724962676