Skip to content

8356395: Spec needs to be clarified for InterfaceAddress class level API documentation and getBroadcast() method #25095

New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

Sign up for GitHub

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

Closed
wants to merge 3 commits into from
Closed

8356395: Spec needs to be clarified for InterfaceAddress class level API documentation and getBroadcast() method #25095

Changes from all commits
Commits
Show all changes
3 commits
Select commit Hold shift + click to select a range
f6bc412
update inetaddress javadoc
kieran-farrell May 7, 2025
c3915e2
Update src/java.base/share/classes/java/net/InterfaceAddress.java
kieran-farrell May 9, 2025
83beab7
Update InterfaceAddress.java
kieran-farrell May 13, 2025
File filter

Filter by extension

Filter by extension
Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
11 changes: 7 additions & 4 deletions src/java.base/share/classes/java/net/InterfaceAddress.java
View file
Open in desktop
Original file line number Diff line number Diff line change
Expand Up @@ -28,10 +28,10 @@
import java.util.Objects;

/**
* This class represents a Network Interface address. In short it's an
* IP address, a subnet mask and a broadcast address when the address is
* an IPv4 one. An IP address and a network prefix length in the case
* of IPv6 address.
* This class represents a Network Interface address. In the case of
* IPv4, this comprises the IP address, a subnet mask, and a broadcast
* address if the interface supports broadcast. In the case of IPv6,
* it comprises the IP address and a network prefix length.
*
* @see java.net.NetworkInterface
* @since 1.6
Expand Down Expand Up @@ -62,6 +62,9 @@ public InetAddress getAddress() {
* <p>
* Only IPv4 networks have broadcast address therefore, in the case
* of an IPv6 network, {@code null} will be returned.
* <p>
* Certain network interfaces, such as the loopback interface, do not support
* broadcasting and will also return {@code null}.
*
* @return the {@code InetAddress} representing the broadcast
* address or {@code null} if there is no broadcast address.
Expand Down