Sound treatment of collection Object parameters

Author: mernst

src/java.base/share/classes/java/lang/reflect/Field.java

@@ -430,7 +430,7 @@ public String toGenericString(@GuardSatisfied Field this) {
     @SideEffectFree
     @CallerSensitive
     @ForceInline // to ensure Reflection.getCallerClass optimization
-    public @Nullable Object get(@GuardSatisfied Field this, @UnknownInitialization @GuardSatisfied @Nullable Object obj)
+    public @Nullable Object get(@GuardSatisfied Field this, @UnknownInitialization @GuardSatisfied Object obj)
         throws IllegalArgumentException, IllegalAccessException
     {
         if (!override) {

src/java.base/share/classes/java/util/AbstractCollection.java

@@ -116,7 +116,7 @@ public boolean isEmpty(@GuardSatisfied AbstractCollection<E> this) {
      */
     @Override
     @Pure
-    public boolean contains(@GuardSatisfied AbstractCollection<E> this, @GuardSatisfied @Nullable Object o) {
+    public boolean contains(@GuardSatisfied AbstractCollection<E> this, @GuardSatisfied Object o) {
         Iterator<E> it = iterator();
         if (o==null) {
             while (it.hasNext())
@@ -309,7 +309,7 @@ public boolean add(@GuardSatisfied AbstractCollection<E> this, E e) {
      * @throws NullPointerException          {@inheritDoc}
      */
     @Override
-    public boolean remove(@GuardSatisfied AbstractCollection<E> this, @Nullable Object o) {
+    public boolean remove(@GuardSatisfied AbstractCollection<E> this, Object o) {
         Iterator<E> it = iterator();
         if (o==null) {
             while (it.hasNext()) {

src/java.base/share/classes/java/util/AbstractList.java

@@ -195,7 +195,7 @@ public E remove(@GuardSatisfied AbstractList<E> this, @IndexFor({"this"}) int in
      * @throws NullPointerException {@inheritDoc}
      */
     @Pure
-    public @GTENegativeOne int indexOf(@GuardSatisfied AbstractList<E> this, @GuardSatisfied @Nullable Object o) {
+    public @GTENegativeOne int indexOf(@GuardSatisfied AbstractList<E> this, @GuardSatisfied Object o) {
         ListIterator<E> it = listIterator();
         if (o==null) {
             while (it.hasNext())
@@ -222,7 +222,7 @@ public E remove(@GuardSatisfied AbstractList<E> this, @IndexFor({"this"}) int in
      * @throws NullPointerException {@inheritDoc}
      */
     @Pure
-    public @GTENegativeOne int lastIndexOf(@GuardSatisfied AbstractList<E> this, @GuardSatisfied @Nullable Object o) {
+    public @GTENegativeOne int lastIndexOf(@GuardSatisfied AbstractList<E> this, @GuardSatisfied Object o) {
         ListIterator<E> it = listIterator(size());
         if (o==null) {
             while (it.hasPrevious())

src/java.base/share/classes/java/util/AbstractMap.java

@@ -126,7 +126,7 @@ public boolean isEmpty(@GuardSatisfied AbstractMap<K, V> this) {
      * @throws NullPointerException {@inheritDoc}
      */
     @Pure
-    public boolean containsValue(@GuardSatisfied AbstractMap<K, V> this, @GuardSatisfied @Nullable Object value) {
+    public boolean containsValue(@GuardSatisfied AbstractMap<K, V> this, @GuardSatisfied Object value) {
         Iterator<Entry<K,V>> i = entrySet().iterator();
         if (value==null) {
             while (i.hasNext()) {
@@ -160,7 +160,7 @@ public boolean containsValue(@GuardSatisfied AbstractMap<K, V> this, @GuardSatis
      */
     @EnsuresKeyForIf(expression={"#1"}, result=true, map={"this"})
     @Pure
-    public boolean containsKey(@GuardSatisfied AbstractMap<K, V> this, @GuardSatisfied @Nullable Object key) {
+    public boolean containsKey(@GuardSatisfied AbstractMap<K, V> this, @GuardSatisfied Object key) {
         Iterator<Map.Entry<K,V>> i = entrySet().iterator();
         if (key==null) {
             while (i.hasNext()) {
@@ -193,7 +193,7 @@ public boolean containsKey(@GuardSatisfied AbstractMap<K, V> this, @GuardSatisfi
      * @throws NullPointerException          {@inheritDoc}
      */
     @Pure
-    public @Nullable V get(@GuardSatisfied AbstractMap<K, V> this, @GuardSatisfied @Nullable Object key) {
+    public @Nullable V get(@GuardSatisfied AbstractMap<K, V> this, @GuardSatisfied Object key) {
         Iterator<Entry<K,V>> i = entrySet().iterator();
         if (key==null) {
             while (i.hasNext()) {
@@ -254,7 +254,7 @@ public boolean containsKey(@GuardSatisfied AbstractMap<K, V> this, @GuardSatisfi
      * @throws ClassCastException            {@inheritDoc}
      * @throws NullPointerException          {@inheritDoc}
      */
-    public @Nullable V remove(@GuardSatisfied AbstractMap<K, V> this, @Nullable Object key) {
+    public @Nullable V remove(@GuardSatisfied AbstractMap<K, V> this, Object key) {
         Iterator<Entry<K,V>> i = entrySet().iterator();
         Entry<K,V> correctEntry = null;
         if (key==null) {

src/java.base/share/classes/java/util/ArrayDeque.java

@@ -447,7 +447,7 @@ public E getLast(@GuardSatisfied ArrayDeque<E> this) {
      * @param o element to be removed from this deque, if present
      * @return {@code true} if the deque contained the specified element
      */
-    public boolean removeFirstOccurrence(@GuardSatisfied ArrayDeque<E> this, Object o) {
+    public boolean removeFirstOccurrence(@GuardSatisfied ArrayDeque<E> this, @Nullable Object o) {
         if (o != null) {
             final Object[] es = elements;
             for (int i = head, end = tail, to = (i <= end) ? end : es.length;
@@ -475,7 +475,7 @@ public boolean removeFirstOccurrence(@GuardSatisfied ArrayDeque<E> this, Object
      * @param o element to be removed from this deque, if present
      * @return {@code true} if the deque contained the specified element
      */
-    public boolean removeLastOccurrence(@GuardSatisfied ArrayDeque<E> this, Object o) {
+    public boolean removeLastOccurrence(@GuardSatisfied ArrayDeque<E> this, @Nullable Object o) {
         if (o != null) {
             final Object[] es = elements;
             for (int i = tail, end = head, to = (i >= end) ? end : 0;

src/java.base/share/classes/java/util/ArrayList.java

@@ -335,7 +335,7 @@ public boolean contains(@GuardSatisfied ArrayList<E> this, @GuardSatisfied @Null
         return indexOfRange(o, 0, size);
     }
 
-    int indexOfRange(Object o, int start, int end) {
+    int indexOfRange(@Nullable Object o, int start, int end) {
         Object[] es = elementData;
         if (o == null) {
             for (int i = start; i < end; i++) {
@@ -365,7 +365,7 @@ int indexOfRange(Object o, int start, int end) {
         return lastIndexOfRange(o, 0, size);
     }
 
-    int lastIndexOfRange(Object o, int start, int end) {
+    int lastIndexOfRange(@Nullable Object o, int start, int end) {
         Object[] es = elementData;
         if (o == null) {
             for (int i = end - 1; i >= start; i--) {
@@ -1297,7 +1297,7 @@ public <T> T[] toArray(T[] a) {
             return a;
         }
 
-        public boolean equals(Object o) {
+        public boolean equals(@Nullable Object o) {
             if (o == this) {
                 return true;
             }
@@ -1317,19 +1317,19 @@ public int hashCode() {
             return hash;
         }
 
-        public int indexOf(Object o) {
+        public int indexOf(@Nullable Object o) {
             int index = root.indexOfRange(o, offset, offset + size);
             checkForComodification();
             return index >= 0 ? index - offset : -1;
         }
 
-        public int lastIndexOf(Object o) {
+        public int lastIndexOf(@Nullable Object o) {
             int index = root.lastIndexOfRange(o, offset, offset + size);
             checkForComodification();
             return index >= 0 ? index - offset : -1;
         }
 
-        public boolean contains(Object o) {
+        public boolean contains(@Nullable Object o) {
             return indexOf(o) >= 0;
         }
 

src/java.base/share/classes/java/util/Collection.java

@@ -268,7 +268,7 @@ public interface Collection<E> extends Iterable<E> {
      */
     @CFComment({"lock: not true, because map could contain nulls:  AssertParametersNonNull(\"get(#1)\")"})
     @Pure
-    boolean contains(@GuardSatisfied Collection<E> this, @GuardSatisfied @Nullable Object o);
+    boolean contains(@GuardSatisfied Collection<E> this, @GuardSatisfied Object o);
 
     /**
      * Returns an iterator over the elements in this collection.  There are no
@@ -460,7 +460,7 @@ default <T> T[] toArray(IntFunction<T[]> generator) {
      * @throws UnsupportedOperationException if the {@code remove} operation
      *         is not supported by this collection
      */
-    boolean remove(@GuardSatisfied Collection<E> this, @Nullable Object o);
+    boolean remove(@GuardSatisfied Collection<E> this, Object o);
 
 
     // Bulk Operations

src/java.base/share/classes/java/util/Deque.java

@@ -580,7 +580,7 @@ public interface Deque<E> extends Queue<E> {
      *         deque does not permit null elements
      * (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
      */
-    boolean remove(@GuardSatisfied Deque<E> this, @Nullable Object o);
+    boolean remove(@GuardSatisfied Deque<E> this, Object o);
 
     /**
      * Returns {@code true} if this deque contains the specified element.
@@ -597,7 +597,7 @@ public interface Deque<E> extends Queue<E> {
      * (<a href="{@docRoot}/java.base/java/util/Collection.html#optional-restrictions">optional</a>)
      */
     @Pure
-    boolean contains(@GuardSatisfied Deque<E> this, @Nullable Object o);
+    boolean contains(@GuardSatisfied Deque<E> this, Object o);
 
     /**
      * Returns the number of elements in this deque.

src/java.base/share/classes/java/util/Dictionary.java

@@ -122,7 +122,7 @@ public Dictionary() {
      * @see     java.util.Dictionary#put(java.lang.Object, java.lang.Object)
      */
     @Pure
-    public abstract @Nullable V get(@GuardSatisfied Dictionary<K, V> this, @Nullable Object key);
+    public abstract @Nullable V get(@GuardSatisfied Dictionary<K, V> this, Object key);
 
     /**
      * Maps the specified {@code key} to the specified

src/java.base/share/classes/java/util/EnumMap.java

@@ -212,7 +212,7 @@ public EnumMap(Map<K, ? extends V> m) {
      * @return {@code true} if this map maps one or more keys to this value
      */
     @Pure
-    public boolean containsValue(@Nullable Object value) {
+    public boolean containsValue(Object value) {
         value = maskNull(value);
 
         for (Object val : vals)
@@ -232,7 +232,7 @@ public boolean containsValue(@Nullable Object value) {
      */
     @EnsuresKeyForIf(expression={"#1"}, result=true, map={"this"})
     @Pure
-    public boolean containsKey(@Nullable Object key) {
+    public boolean containsKey(Object key) {
         return isValidKey(key) && vals[((Enum<?>)key).ordinal()] != null;
     }
 
@@ -256,7 +256,7 @@ private boolean containsMapping(@Nullable Object key, @Nullable Object value) {
      * The {@link #containsKey containsKey} operation may be used to
      * distinguish these two cases.
      */
-    public @Nullable V get(@Nullable Object key) {
+    public @Nullable V get(Object key) {
         return (isValidKey(key) ?
                 unmaskNull(vals[((Enum<?>)key).ordinal()]) : null);
     }