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

[Daniel Jeliński]

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 44:

> 42:  * A Network Interface can be physical or logical.
> 43:  * A network interface has a name, an index, zero or more assigned
> 44:  * {@inkplain InetAddress IP addresses}, and zero or more {@linkplain

Suggestion:

 * {@linkplain InetAddress IP addresses}, and zero or more {@linkplain

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

> 47:  * it may not be unique. The index is a highly platform
> 48:  * specific number that identifies the interface. The network
> 49:  * configuration may change during the life-time of the JVM:

Suggestion:

 * configuration may change during the lifetime of the JVM:

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

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