Integrated: 8329745: Update the documentation of ServerSocket and Socket to refer to StandardSocketOptions instead of legacy SocketOptions

Jaikiran Pai jpai at openjdk.org
Tue Apr 9 13:07:12 UTC 2024


On Fri, 5 Apr 2024 07:31:47 GMT, Jaikiran Pai <jpai at openjdk.org> wrote:

> Can I please get a review of this doc-only changes to java.net.ServerSocket and java.net.Socket classes?
> 
> As noted in https://bugs.openjdk.org/browse/JDK-8329745, these classes currently refer to the legacy `java.net.SocketOptions` interface and instead should be refering to the newer `java.net.StandardSocketOptions` class. The commit in this PR updates such references. This change intentionally doesn't do any code changes to use the `StandardSocketOptions` class - that can be done separately if desired at a later point (after testing for any compatibility issues). Finally, there are a few places in ServerSocket and Socket documentation which will continue to refer to java.net.SocketOptions legacy interface because few of the options aren't available in StandardSocketOptions class (for example, `SO_TIMEOUT`).
> 
> I ran `make docs-image` locally with this change and the generated doc looks OK to me.

This pull request has now been integrated.

Changeset: 635cb3c9
Author:    Jaikiran Pai <jpai at openjdk.org>
URL:       https://git.openjdk.org/jdk/commit/635cb3c9762aeaec6c8dd2c21b8323d187236b4f
Stats:     112 lines in 2 files changed: 7 ins; 18 del; 87 mod

8329745: Update the documentation of ServerSocket and Socket to refer to StandardSocketOptions instead of legacy SocketOptions

Reviewed-by: alanb, dfuchs

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

PR: https://git.openjdk.org/jdk/pull/18646


More information about the net-dev mailing list