RFR: 8283779: Clarify API documentation of NetworkInterface with respect to configuration changes [v3]

Alan Bateman alanb at openjdk.org
Mon Sep 2 18:50:18 UTC 2024


On Mon, 2 Sep 2024 17:44:31 GMT, Daniel Fuchs <dfuchs at openjdk.org> wrote:

>> Please find here a change that adds a few `@apiNote` and `@implNote` to `NetworkInterface` to clarify user expectation and implementation.
>
> Daniel Fuchs has updated the pull request incrementally with one additional commit since the last revision:
> 
>   Improve class level description again

src/java.base/share/classes/java/net/NetworkInterface.java line 314:

> 312:      * The returned interface instance may reflect a snapshot of the
> 313:      * configuration taken at the time the instance is created.
> 314:      * To see updates to the configuration may, or may not, require

The sentence "To see updates ..." is hard to read. How about "The network configuration may change at any time, this method may need to be invoked to obtain a more up to date view of the network interface".

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

PR Review Comment: https://git.openjdk.org/jdk/pull/20822#discussion_r1741199965


More information about the net-dev mailing list