RFR: JDK-8323760 putIfAbsent documentation conflicts with itself [v2]

John Hendrikx jhendrikx at openjdk.org
Tue Feb 13 17:11:05 UTC 2024


> Update the documentation for `@return` tag of `putIfAbsent` to match the main description. `putIfAbsent` uses the same wording as `put` for its `@return` tag, but that is incorrect.  `putIfAbsent` never returns the **previous** value, as the whole point of the method is not the replace the value if it was present.  As such, if it returns a value, it is the **current** value, and in all other cases it will return `null`.

John Hendrikx has updated the pull request incrementally with four additional commits since the last revision:

 - Add code block around argument
 - Reword
 - Reword to use put's previous value wording
 - Reword more clearly

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

Changes:
  - all: https://git.openjdk.org/jdk/pull/17438/files
  - new: https://git.openjdk.org/jdk/pull/17438/files/81276376..3621be54

Webrevs:
 - full: https://webrevs.openjdk.org/?repo=jdk&pr=17438&range=01
 - incr: https://webrevs.openjdk.org/?repo=jdk&pr=17438&range=00-01

  Stats: 5 lines in 1 file changed: 1 ins; 0 del; 4 mod
  Patch: https://git.openjdk.org/jdk/pull/17438.diff
  Fetch: git fetch https://git.openjdk.org/jdk.git pull/17438/head:pull/17438

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


More information about the core-libs-dev mailing list