RFR: 8343125: Correct the documentation for TreeMap's getFloorEntry and getCeilingEntry

Naman Nigam duke at openjdk.org
Wed Nov 13 17:00:59 UTC 2024


On Sun, 27 Oct 2024 02:30:33 GMT, Chen Liang <liach at openjdk.org> wrote:

> To get a JBS issue, please open a bug report about this typo in https://bugs.java.com/bugdatabase/. Also follow https://openjdk.org/guide for the rest of the steps for contributions.

Thank you for your response @liach, I have
- [x] filed the bug and referenced its ID
- [x] signed the [OCA](https://oca.opensource.oracle.com/) and waiting for its approval

Please help me understand whom to add as a reviewer (and how) for such changes.

> src/java.base/share/classes/java/util/TreeMap.java line 424:
> 
>> 422:     /**
>> 423:      * Gets the entry corresponding to the specified key; returns the entry for
>> 424:      * the least key greater than the specified key; if no such entry exists
> 
> What about: (same for the floor one)
> 
> Returns the entry for the least key greater than or equal to the specified key;
> if no such entry exists (i.e. the specified key is greater than any key in the tree),
> returns {@code null}.
> 
> What do you think of my version?

Looks good to me and is similar to other methods of the form `get*` such as `getHigherEntry`. I could make that change and ensure documentation is similar for methods.

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

PR Comment: https://git.openjdk.org/jdk/pull/21729#issuecomment-2440628625
PR Review Comment: https://git.openjdk.org/jdk/pull/21729#discussion_r1821302920


More information about the core-libs-dev mailing list