jmx-dev RFR: 8335625: Update Javadoc for GetCpuLoad [v3]

Alan Bateman alanb at openjdk.org
Mon Aug 26 13:54:37 UTC 2024


On Mon, 26 Aug 2024 13:46:41 GMT, Joakim Nordström <jnordstrom at openjdk.org> wrote:

>> src/jdk.management/share/classes/com/sun/management/OperatingSystemMXBean.java line 154:
>> 
>>> 152:      * affecting the observation period and the result.
>>> 153:      *
>>> 154:      * @implNote There is only one observation period for the entire JVM
>> 
>> This version looks good, I'm just wondering about the implNote, is the statement true for all implementations (Linux, macOS, Windows, ...)?
>
> Reviewing the current implementation this seems to be the case. 
> 
> The `@implNote` was more meant as an explanation to why the result could be affected by other callers. Since the `@apiNote` also states that the "observation period and result" can be affected, I think its an unnecessary implementation note to have.

Okay, if this is the case for all implementations then it would be okay to use "In the JDK implementation, there is only one ...".

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

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


More information about the jmx-dev mailing list