Skip to content

Commit

Permalink
Improve class-level API documentation
Browse files Browse the repository at this point in the history
  • Loading branch information
dfuch committed Sep 2, 2024
1 parent 7ae62f7 commit 5ce21bc
Showing 1 changed file with 22 additions and 5 deletions.
27 changes: 22 additions & 5 deletions src/java.base/share/classes/java/net/NetworkInterface.java
Original file line number Diff line number Diff line change
Expand Up @@ -35,12 +35,29 @@
import java.util.stream.StreamSupport;

/**
* This class represents a Network Interface made up of a name,
* and a list of IP addresses assigned to this interface.
* It is used to identify the local interface on which a multicast group
* is joined.
* This class represents a Network Interface.
* <p>
* A Network Interface is the point of interconnection
* between a computer and a private or public network.
* A Network Interface can be physical or logical.
* Network Interfaces are normally known by names such as "le0",
* have an index, a (possibly empty) set of {@linkplain InterfaceAddress
* MAC addresses}, and a (possibly empty) set of {@linkplain
* InetAddress IP addresses} bound to that interface.
* Network Interfaces, and in particular their list of assigned IP addresses,
* can be reconfigured dynamically by the underlying system at any
* time during the life of the JVM.
* <p>
* When obtaining a {@code NetworkInterface} instance, part of its
* configuration (such as its name and the list of assigned IP addresses),
* may be snapshot at creation time.
* Obtaining an updated view of the network configuration may require
* looking up a network interface again in order to obtain a new instance.
* <p>
* Network interface instances are typically used to identify the local
* interface on which a multicast group is joined.
*
*
* Interfaces are normally known by names such as "le0".
*
* @since 1.4
*/
Expand Down

0 comments on commit 5ce21bc

Please sign in to comment.