8356395: Spec needs to be clarified for InterfaceAddress.getBroadcast() method

[kieran-farrell]

Spec currently suggests that only IPv6 addresses can return null for InterfaceAddress.getBroadcast(). Clarifying spec to state that certain IPv4 address such as the loopback address do not support broadcasting and can therefore also return null.

---

Progress

• Change must be properly reviewed (1 review required, with at least 1 Reviewer)
• Change must not contain extraneous whitespace
• Commit message must refer to an issue
• Change requires a CSR request matching fixVersion 25 to be approved (needs to be created)

Issue

• JDK-8356395: Spec needs to be clarified for InterfaceAddress.getBroadcast() method (Bug - P4)

Reviewing

Using git

Checkout this PR locally:
$ git fetch https://git.openjdk.org/jdk.git pull/25095/head:pull/25095
$ git checkout pull/25095

Update a local copy of the PR:
$ git checkout pull/25095
$ git pull https://git.openjdk.org/jdk.git pull/25095/head

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 25095

View PR using the GUI difftool:
$ git pr show -t 25095

Using diff file

Download this PR as a diff file:
https://git.openjdk.org/jdk/pull/25095.diff

Using Webrev

Link to Webrev Comment

[bridgekeeper]

👋 Welcome back kieran-farrell! A progress list of the required criteria for merging this PR into master will be added to the body of your pull request. There are additional pull request commands available for use with this pull request.

[openjdk]

❗ This change is not yet ready to be integrated.
See the Progress checklist in the description for automated requirements.

[openjdk]

@kieran-farrell The following label will be automatically applied to this pull request:

• net

When this pull request is ready to be reviewed, an "RFR" email will be sent to the corresponding mailing list. If you would like to change these labels, use the /label pull request command.

[mlbridge]

Webrevs

• 00: Full (f6bc4122)

[dfuch]

Suggested change

	* Certain IPv4 addresses, such as the loopback address, do not support
	* broadcasting and will also result in {@code null} being returned.
	* Certain network interfaces, such as the loopback interface, do not support
	* broadcasting and will also return {@code null}.

Maybe the class level API documentation should also be updated something like:

 * This class represents a Network Interface address. In short it's an
 * IP address, a subnet mask as well as a broadcast address when the address is
 * IPv4 and the interface supports broadcasting.
 * An IP address and a network prefix length in the case
 * of IPv6 address.

It would be good to have @Michael-Mc-Mahon approve the wording.

[dfuch]

/csr needed

[openjdk]

@dfuch has indicated that a compatibility and specification (CSR) request is needed for this pull request.

@kieran-farrell please create a CSR request for issue JDK-8356395 with the correct fix version. This pull request cannot be integrated until the CSR request is approved.