jspecify / jspecify/jdk

`Map.replace(K, V, V)`: Make `oldValue` `@Nullable`

Open
#118 1 comment 0 reactions 0 assignees View on GitHub

Nobody has claimed this yet.

Dominant language
Java
Stars
7
Forks
3
Avg merge
15h 17m
Merged PRs (30d)
8

Description

We have it as parametric nullness in Map itself and in ConcurrentMap and presumably other subtypes:

Android has it as @Nullable: https://cs.android.com/android/platform/superproject/main/+/main:libcore/ojluni/annotations/sdk/nullability/java/util/Map.annotated.java;l=72;drc=31fc4306a5baa196245ae16f79009b632ccbe667

As a result of that difference, an Android nullness check in Google's depot gets upset.

It seems like @Nullable would make sense, given the concept of the method and the default implementation: You can't hurt anything by passing null.

But that might be trouble for Kotlin? https://github.com/JetBrains/kotlin/blob/e32761ba660d67e60ddcd3cd1e798331b9f6d9d3/core/compiler.common.jvm/src/org/jetbrains/kotlin/load/java/typeEnhancement/predefinedEnhancementInfo.kt#L169-L174

And we'd want to see if at least some implementations would reject null, similar to contains. (That likely wouldn't change our direction for the interface, but we'd want to keep the type with parametric nullness (or make it non-null) for any such implementations.)

Contributor guide

Open the contributing guide

First steps

  1. Read the whole issue, then the project's contributing guide.
  2. Comment on the issue to say you are picking it up — it saves two people doing the same work.
  3. Fork the repository and make your change on a branch.
  4. Open a pull request that references the issue number.

Research direction

Start with the referenced Map.java and ConcurrentMap.java declarations, then compare Android's annotated Map.annotated.java and Kotlin's predefinedEnhancementInfo.kt. Check relevant implementations for null rejection and determine whether the interface annotation is compatible with Kotlin. Done means the interface and affected implementations have consistent nullness annotations without breaking the compatibility concerns described.

Written by the indexing model from the issue text.

Assessment

Tech stack
java
Domain
api
Issue type
Bug
Difficulty
4/5
Estimated time
3-5 days
Activity status
Stale
Clarity
Mostly clear
Newbie friendliness
35/100

Get new issues in your inbox

A short digest of beginner-friendly GitHub issues.