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

Jaikiran Pai jpai at openjdk.org
Fri Apr 5 07:36:31 UTC 2024


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.

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

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

Changes: https://git.openjdk.org/jdk/pull/18646/files
  Webrev: https://webrevs.openjdk.org/?repo=jdk&pr=18646&range=00
  Issue: https://bugs.openjdk.org/browse/JDK-8329745
  Stats: 45 lines in 2 files changed: 0 ins; 0 del; 45 mod
  Patch: https://git.openjdk.org/jdk/pull/18646.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/18646/head:pull/18646

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


More information about the net-dev mailing list