7113208: Incorrect javadoc on java.net.DatagramPacket.setLength() #10037

jaikiran · 2022-08-26T07:51:16Z

Can I please get a review of this javadoc only change for DatagramPacket#setLength() method? This addresses https://bugs.openjdk.org/browse/JDK-7113208.

I haven't create a CSR because the javadoc was already stating the correct behaviour in the @throws documentation as follows:

@throws IllegalArgumentException if the length is negative,
* or if the length plus the offset is greater than the
* length of the packet's data buffer.

This commit merely fixes the main part of the javadoc.

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

Issue

JDK-7113208: Incorrect javadoc on java.net.DatagramPacket.setLength()

Reviewers

Daniel Fuchs (@dfuch - Reviewer)

Reviewing

Using git

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

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

Using Skara CLI tools

Checkout this PR locally:
$ git pr checkout 10037

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

Using diff file

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

bridgekeeper · 2022-08-26T07:52:00Z

👋 Welcome back jpai! 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 · 2022-08-26T07:54:44Z

@jaikiran 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 · 2022-08-26T07:57:27Z

Webrevs

dfuch · 2022-08-26T08:55:27Z

src/java.base/share/classes/java/net/DatagramPacket.java

+     * will be used for receiving data. The {@code length} plus the
+     * {@link #getOffset() offset} must be lesser or equal to the
+     * length of the packet's data buffer.


The new text looks good to me. While you're at it I would suggest to rewrite the code that checks the length with something like:

Preconditions.checkFromIndexSize(offset, length, buf.length, Preconditions.outOfBoundsExceptionFormatter(IllegalArgumentException::new));

Then figure out if we have a unit test that already checks this, and if not, write one!

Hello Daniel, thank you for the review. I've updated the PR to implement the code change you suggested.

There's already test/jdk/java/net/DatagramPacket/Setters.java which has testSetLength to test this method. I've run the entire test/jdk/java/net/DatagramPacket tests with this change and they passed fine. I'll trigger a more comprehensive test run just to make sure nothing unexpected shows up.

dfuch · 2022-08-26T10:15:59Z

src/java.base/share/classes/java/net/DatagramPacket.java

+        Preconditions.checkFromIndexSize(offset, length, buf.length,
+                Preconditions.outOfBoundsExceptionFormatter(IllegalArgumentException::new));


Thanks for that. Maybe the bound checks in

public synchronized void setData(byte[] buf, int offset, int length) {

could be replaced in a similar way.

Hello Daniel,

I've now updated this method too to use Preconditions. Additionally, a NullPointerException check which was implicit in this method (and noted by a code comment) has now been made an explicit check (using Objects.requireNonNull) in this updated version. I hope that's OK.

The existing Setters.java test case covers this method as well and I've run it after these changes to make sure it continues to pass.

AlanBateman · 2022-08-30T11:39:04Z

src/java.base/share/classes/java/net/DatagramPacket.java

-     * equal to the offset plus the length of the packet's buffer.
+     * will be used for receiving data. The {@code length} plus the
+     * {@link #getOffset() offset} must be lesser or equal to the
+     * length of the packet's data buffer.


The javadoc update looks okay.

dfuch

Thanks Jaikiran! LGTM!

openjdk · 2022-09-02T14:57:53Z

@jaikiran This change now passes all automated pre-integration checks.

ℹ️ This project also has non-automated pre-integration requirements. Please see the file CONTRIBUTING.md for details.

After integration, the commit message for the final commit will be:

7113208: Incorrect javadoc on java.net.DatagramPacket.setLength()

Reviewed-by: dfuchs

You can use pull request commands such as /summary, /contributor and /issue to adjust it as needed.

At the time when this comment was updated there had been 88 new commits pushed to the master branch:

77e21c5: 8290529: C2: assert(BoolTest(btest).is_canonical()) failure
fcc0cf9: 8292375: Convert ProtectionDomainCacheTable to ResourceHashtable
6fc58b8: 8293207: Add assert to JVM_ReferenceRefersTo to clarify its API
ce06a3b: 8293023: Change CardTable::is_in_young signature
26cac08: 8293209: Parallel: Remove unused variables in PSParallelCompact::invoke
46523b8: 8293219: Microsoft toolchain selection picks 32-bit tools over 64-bit
bc5ffc8: 8293100: RISC-V: Need to save and restore callee-saved FloatRegisters in StubGenerator::generate_call_stub
98ce45f: 8292981: Unify and restructure integer printing format specifiers
3ac91b0: 8293003: Review running time of Warn5 regression test
e0168a0: 8288012: AArch64: unnecessary macro expansion in stubGenerator_aarch64
... and 78 more: https://git.openjdk.org/jdk/compare/3e187730162965981a5e6d238935e46d1015708e...master

As there are no conflicts, your changes will automatically be rebased on top of these commits when integrating. If you prefer to avoid this automatic rebasing, please check the documentation for the /integrate command for further details.

➡️ To integrate this PR with the above commit message to the master branch, type /integrate in a new comment.

jaikiran · 2022-09-03T05:46:38Z

Thank you Alan and Daniel for the reviews. tier1,tier2,tier3 testing went fine with these changes.

jaikiran · 2022-09-03T05:46:46Z

/integrate

openjdk · 2022-09-03T05:48:32Z

Going to push as commit a366e82.
Since your change was applied there have been 97 commits pushed to the master branch:

ac05bc8: 8293293: Move archive heap loading code out of heapShared.cpp
e1e6732: 8293319: [C2 cleanup] Remove unused other_path arg in Parse::adjust_map_after_if
5757e21: 8292385: assert(ctrl == kit.control()) failed: Control flow was added although the intrinsic bailed out
3993a1f: 8292067: Convert test/sun/management/jmxremote/bootstrap shell tests to java version
83a3408: 8293315: Add back logging for Placeholders
b6477fd: 8293288: bootcycle build failure after JDK-8173605
0c6094e: 8293188: x86_64: Introduce stubGenerator_x86_64.hpp
2baeebb: 8293006: sun/tools/jhsdb/JStackStressTest.java fails with "UnalignedAddressException: 8baadbabe"
da99e3e: 8289400: Improve com/sun/jdi/TestScaffold error reporting
77e21c5: 8290529: C2: assert(BoolTest(btest).is_canonical()) failure
... and 87 more: https://git.openjdk.org/jdk/compare/3e187730162965981a5e6d238935e46d1015708e...master

Your commit was automatically rebased without conflicts.

openjdk · 2022-09-03T05:48:46Z

@jaikiran Pushed as commit a366e82.

💡 You may see a message that your pull request was closed with unmerged commits. This can be safely ignored.

7113208: Incorrect javadoc on java.net.DatagramPacket.setLength()

9bfb59f

openjdk bot added the rfr Pull request is ready for review label Aug 26, 2022

openjdk bot added the net net-dev@openjdk.org label Aug 26, 2022

dfuch reviewed Aug 26, 2022

View reviewed changes

implement review comment

addffb2

dfuch reviewed Aug 26, 2022

View reviewed changes

AlanBateman reviewed Aug 30, 2022

View reviewed changes

review comment - use Preconditions

6c76201

dfuch approved these changes Sep 2, 2022

View reviewed changes

openjdk bot added the ready Pull request is ready to be integrated label Sep 2, 2022

openjdk bot added the integrated Pull request has been integrated label Sep 3, 2022

openjdk bot closed this Sep 3, 2022

openjdk bot removed ready Pull request is ready to be integrated rfr Pull request is ready for review labels Sep 3, 2022

jaikiran deleted the 7113208 branch September 3, 2022 05:54

Provide feedback

Saved searches

Use saved searches to filter your results more quickly

7113208: Incorrect javadoc on java.net.DatagramPacket.setLength() #10037

7113208: Incorrect javadoc on java.net.DatagramPacket.setLength() #10037

jaikiran commented Aug 26, 2022 •

edited by openjdk bot

bridgekeeper bot commented Aug 26, 2022

openjdk bot commented Aug 26, 2022

mlbridge bot commented Aug 26, 2022 •

edited

dfuch Aug 26, 2022

jaikiran Aug 26, 2022

dfuch Aug 26, 2022

jaikiran Sep 1, 2022

AlanBateman Aug 30, 2022

dfuch left a comment

openjdk bot commented Sep 2, 2022

jaikiran commented Sep 3, 2022

jaikiran commented Sep 3, 2022

openjdk bot commented Sep 3, 2022

openjdk bot commented Sep 3, 2022

		Preconditions.checkFromIndexSize(offset, length, buf.length,
		Preconditions.outOfBoundsExceptionFormatter(IllegalArgumentException::new));

7113208: Incorrect javadoc on java.net.DatagramPacket.setLength() #10037

7113208: Incorrect javadoc on java.net.DatagramPacket.setLength() #10037

Conversation

jaikiran commented Aug 26, 2022 • edited by openjdk bot

Progress

Issue

Reviewers

Reviewing

bridgekeeper bot commented Aug 26, 2022

openjdk bot commented Aug 26, 2022

mlbridge bot commented Aug 26, 2022 • edited

Webrevs

dfuch Aug 26, 2022

Choose a reason for hiding this comment

jaikiran Aug 26, 2022

Choose a reason for hiding this comment

dfuch Aug 26, 2022

Choose a reason for hiding this comment

jaikiran Sep 1, 2022

Choose a reason for hiding this comment

AlanBateman Aug 30, 2022

Choose a reason for hiding this comment

dfuch left a comment

Choose a reason for hiding this comment

openjdk bot commented Sep 2, 2022

jaikiran commented Sep 3, 2022

jaikiran commented Sep 3, 2022

openjdk bot commented Sep 3, 2022

openjdk bot commented Sep 3, 2022

jaikiran commented Aug 26, 2022 •

edited by openjdk bot

mlbridge bot commented Aug 26, 2022 •

edited