Minor improvements to Map.merge usage of @PolyNull and @NonNull. (

typetools#41)
Ao-senXiong · Jun 11, 2023 · 7e9c413 · 7e9c413
1 parent c414784
commit 7e9c413
Show file tree

Hide file tree

Showing 9 changed files with 15 additions and 17 deletions.
diff --git a/src/java.base/share/classes/java/util/Collections.java b/src/java.base/share/classes/java/util/Collections.java
@@ -1637,7 +1637,7 @@ public V replace(K key, V value) {
 
         @Override
         public @PolyNull V merge(K key, @NonNull V value,
-                BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+                BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
             throw new UnsupportedOperationException();
         }
 
@@ -2839,7 +2839,7 @@ public V replace(K key, V value) {
         }
         @Override
         public @PolyNull V merge(K key, @NonNull V value,
-                BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+                BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
             synchronized (mutex) {return m.merge(key, value, remappingFunction);}
         }
 
@@ -3923,7 +3923,7 @@ public V replace(K key, V value) {
 
         @Override
         public @PolyNull V merge(K key, @NonNull V value,
-                BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+                BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
             Objects.requireNonNull(remappingFunction);
             return m.merge(key, value, (v1, v2) -> {
                 V newValue = remappingFunction.apply(v1, v2);
@@ -4924,7 +4924,7 @@ public V replace(K key, V value) {
 
         @Override
         public @PolyNull V merge(K key, @NonNull V value,
-                BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+                BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
             throw new UnsupportedOperationException();
         }
 
@@ -5270,7 +5270,7 @@ public V replace(K key, V value) {
 
         @Override
         public @PolyNull V merge(K key, @NonNull V value,
-                BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+                BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
             throw new UnsupportedOperationException();
         }
 

diff --git a/src/java.base/share/classes/java/util/HashMap.java b/src/java.base/share/classes/java/util/HashMap.java
@@ -1389,7 +1389,7 @@ else if (v != null) {
      */
     @Override
     public @PolyNull V merge(K key, @NonNull V value,
-                   BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+                   BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
         if (value == null || remappingFunction == null)
             throw new NullPointerException();
         int hash = hash(key);

diff --git a/src/java.base/share/classes/java/util/Hashtable.java b/src/java.base/share/classes/java/util/Hashtable.java
@@ -1193,7 +1193,7 @@ public synchronized V replace(K key, V value) {
      * remapping function modified this map
      */
     @Override
-    public synchronized @PolyNull V merge(K key, @NonNull V value, BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+    public synchronized @PolyNull V merge(K key, @NonNull V value, BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
         Objects.requireNonNull(remappingFunction);
 
         Entry<?,?> tab[] = table;

diff --git a/src/java.base/share/classes/java/util/ImmutableCollections.java b/src/java.base/share/classes/java/util/ImmutableCollections.java
@@ -1084,7 +1084,7 @@ abstract static class AbstractImmutableMap<K,V> extends AbstractMap<K,V> impleme
         @Override public @PolyNull V compute(K key, BiFunction<? super K,? super V,? extends @PolyNull V> rf) { throw uoe(); }
         @Override public @PolyNull V computeIfAbsent(K key, Function<? super K,? extends @PolyNull V> mf) { throw uoe(); }
         @Override public @PolyNull V computeIfPresent(K key, BiFunction<? super K,? super V,? extends @PolyNull V> rf) { throw uoe(); }
-        @Override public @PolyNull V merge(K key, @NonNull V value, BiFunction<? super V,? super V,? extends @PolyNull V> rf) { throw uoe(); }
+        @Override public @PolyNull V merge(K key, @NonNull V value, BiFunction<? super @NonNull V,? super @NonNull V,? extends @PolyNull V> rf) { throw uoe(); }
         @Override public V put(K key, V value) { throw uoe(); }
         @Override public void putAll(Map<? extends K,? extends V> m) { throw uoe(); }
         @Override public V putIfAbsent(K key, V value) { throw uoe(); }

diff --git a/src/java.base/share/classes/java/util/Map.java b/src/java.base/share/classes/java/util/Map.java
@@ -1349,12 +1349,8 @@ default boolean replace(K key, V oldValue, V newValue) {
      *         null
      * @since 1.8
      */
-    @CFComment({
-        "It would be more flexible to make the return type of remappingFunction be `@Nullable V`.  A",
-        "remappingFunction that returns null is is probably rare, and these annotations accommodate",
-        "the majority of uses that don't return null."})
     default @PolyNull V merge(K key, @NonNull V value,
-            BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+            BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
         Objects.requireNonNull(remappingFunction);
         Objects.requireNonNull(value);
         V oldValue = get(key);

diff --git a/src/java.base/share/classes/java/util/TreeMap.java b/src/java.base/share/classes/java/util/TreeMap.java
@@ -30,7 +30,9 @@
 import org.checkerframework.checker.nullness.qual.EnsuresKeyFor;
 import org.checkerframework.checker.nullness.qual.EnsuresKeyForIf;
 import org.checkerframework.checker.nullness.qual.KeyFor;
+import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
+import org.checkerframework.checker.nullness.qual.PolyNull;
 import org.checkerframework.checker.signedness.qual.UnknownSignedness;
 import org.checkerframework.dataflow.qual.Pure;
 import org.checkerframework.dataflow.qual.SideEffectFree;
@@ -723,7 +725,7 @@ else if (cmp > 0)
      * remapping function modified this map
      */
     @Override
-    public V merge(K key, V value, BiFunction<? super V, ? super V, ? extends V> remappingFunction) {
+    public @PolyNull V merge(K key, @NonNull V value, BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
         Objects.requireNonNull(remappingFunction);
         Objects.requireNonNull(value);
         Entry<K,V> t = root;

diff --git a/src/java.base/share/classes/java/util/concurrent/ConcurrentHashMap.java b/src/java.base/share/classes/java/util/concurrent/ConcurrentHashMap.java
@@ -2052,7 +2052,7 @@ else if (f instanceof ReservationNode)
      * @throws RuntimeException or Error if the remappingFunction does so,
      *         in which case the mapping is unchanged
      */
-    public @PolyNull V merge(K key, @NonNull V value, BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+    public @PolyNull V merge(K key, @NonNull V value, BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
         if (key == null || value == null || remappingFunction == null)
             throw new NullPointerException();
         int h = spread(key.hashCode());

diff --git a/src/java.base/share/classes/java/util/concurrent/ConcurrentMap.java b/src/java.base/share/classes/java/util/concurrent/ConcurrentMap.java
@@ -484,7 +484,7 @@ else if ((oldValue = putIfAbsent(key, newValue)) == null)
      */
     @Override
     default @PolyNull V merge(K key, @NonNull V value,
-            BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+            BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
         Objects.requireNonNull(remappingFunction);
         Objects.requireNonNull(value);
         retry: for (;;) {

diff --git a/src/java.base/share/classes/java/util/concurrent/ConcurrentSkipListMap.java b/src/java.base/share/classes/java/util/concurrent/ConcurrentSkipListMap.java
@@ -1564,7 +1564,7 @@ else if (doRemove(key, v) != null)
      * @since 1.8
      */
     public @PolyNull V merge(K key, @NonNull V value,
-                   BiFunction<? super V, ? super V, ? extends @PolyNull V> remappingFunction) {
+                   BiFunction<? super @NonNull V, ? super @NonNull V, ? extends @PolyNull V> remappingFunction) {
         if (key == null || value == null || remappingFunction == null)
             throw new NullPointerException();
         for (;;) {