Add @Nullable to the parameter of equals(Object) (#2093)

Motivation:

`Object.equals(Object)` accepts `null`, but many of our `equals()`
implementations do not have `@Nullable` annotation on their parameters.

Modifications:

- Add `@Nullable` to the parameter of `equals(Object)`

Result:

- Better `null`-related inference

Author: trustin

CONTRIBUTING.md

@@ -212,7 +212,7 @@ public final class MyClass {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         ... usual type check ...
         // OK
         return name.equals(((MyClass) obj).name);

core/src/main/java/com/linecorp/armeria/client/ClientDecoration.java

@@ -20,6 +20,8 @@
 import java.util.List;
 import java.util.function.Function;
 
+import javax.annotation.Nullable;
+
 import com.linecorp.armeria.common.Request;
 import com.linecorp.armeria.common.Response;
 
@@ -113,7 +115,7 @@ Function<Client<I, O>, Client<I, O>> decorator() {
         }
 
         @Override
-        public boolean equals(Object o) {
+        public boolean equals(@Nullable Object o) {
             if (this == o) {
                 return true;
             }

core/src/main/java/com/linecorp/armeria/client/DefaultEventLoopScheduler.java

@@ -29,6 +29,8 @@
 import java.util.concurrent.atomic.AtomicLongFieldUpdater;
 import java.util.function.ToIntFunction;
 
+import javax.annotation.Nullable;
+
 import org.slf4j.Logger;
 import org.slf4j.LoggerFactory;
 
@@ -262,7 +264,7 @@ public int hashCode() {
         }
 
         @Override
-        public boolean equals(Object obj) {
+        public boolean equals(@Nullable Object obj) {
             if (this == obj) {
                 return true;
             }

core/src/main/java/com/linecorp/armeria/client/Endpoint.java

@@ -643,7 +643,7 @@ private static void validateWeight(int weight) {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

core/src/main/java/com/linecorp/armeria/client/HttpChannelPool.java

@@ -551,7 +551,7 @@ static final class PoolKey {
         }
 
         @Override
-        public boolean equals(Object o) {
+        public boolean equals(@Nullable Object o) {
             if (this == o) {
                 return true;
             }

core/src/main/java/com/linecorp/armeria/client/circuitbreaker/EventCount.java

@@ -16,6 +16,8 @@
 
 package com.linecorp.armeria.client.circuitbreaker;
 
+import javax.annotation.Nullable;
+
 /**
  * An immutable object that stores the count of events.
  */
@@ -99,7 +101,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         if (this == o) {
             return true;
         }

core/src/main/java/com/linecorp/armeria/client/endpoint/dns/DnsQuestionWithoutTrailingDot.java

@@ -19,6 +19,8 @@
 
 import java.net.IDN;
 
+import javax.annotation.Nullable;
+
 import io.netty.handler.codec.dns.DnsQuestion;
 import io.netty.handler.codec.dns.DnsRecordType;
 
@@ -56,7 +58,7 @@ public long timeToLive() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         if (this == o) {
             return true;
         }

core/src/main/java/com/linecorp/armeria/common/AbstractHttpData.java

@@ -16,6 +16,8 @@
 
 package com.linecorp.armeria.common;
 
+import javax.annotation.Nullable;
+
 /**
  * Support APIs for creating well-behaved {@link HttpData} objects. {@link HttpData} generally should extend
  * {@link AbstractHttpData} to interact with other {@link HttpData} implementations, via, e.g., {@code equals}.
@@ -37,7 +39,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (!(obj instanceof AbstractHttpData)) {
             return false;
         }

core/src/main/java/com/linecorp/armeria/common/AbstractRequestContext.java

@@ -26,6 +26,8 @@
 import java.util.function.Consumer;
 import java.util.function.Function;
 
+import javax.annotation.Nullable;
+
 import com.linecorp.armeria.common.util.SafeCloseable;
 import com.linecorp.armeria.server.DefaultServiceRequestContext;
 
@@ -195,7 +197,7 @@ public final int hashCode() {
     }
 
     @Override
-    public final boolean equals(Object obj) {
+    public final boolean equals(@Nullable Object obj) {
         return super.equals(obj);
     }
 }

core/src/main/java/com/linecorp/armeria/common/CacheControl.java

@@ -15,6 +15,8 @@
  */
 package com.linecorp.armeria.common;
 
+import javax.annotation.Nullable;
+
 /**
  * Directives for HTTP caching mechanisms in requests or responses. Use {@link ServerCacheControl} for
  * response-side and {@link ClientCacheControl} for request-side.
@@ -115,7 +117,7 @@ final StringBuilder newHeaderValueBuffer() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         if (this == o) {
             return true;
         }

core/src/main/java/com/linecorp/armeria/common/ClientCacheControl.java

@@ -244,7 +244,7 @@ public String asHeaderValue() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         if (!super.equals(o)) {
             return false;
         }

core/src/main/java/com/linecorp/armeria/common/DefaultAggregatedHttpRequest.java

@@ -16,6 +16,8 @@
 
 package com.linecorp.armeria.common;
 
+import javax.annotation.Nullable;
+
 import com.google.common.base.MoreObjects;
 import com.google.common.base.MoreObjects.ToStringHelper;
 
@@ -64,7 +66,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

core/src/main/java/com/linecorp/armeria/common/DefaultAggregatedHttpResponse.java

@@ -18,6 +18,8 @@
 
 import java.util.List;
 
+import javax.annotation.Nullable;
+
 import com.google.common.base.MoreObjects;
 import com.google.common.base.MoreObjects.ToStringHelper;
 
@@ -59,7 +61,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

core/src/main/java/com/linecorp/armeria/common/DefaultHttpHeaders.java

@@ -71,7 +71,7 @@ public HttpHeadersBuilder toBuilder() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         return o instanceof HttpHeaders && super.equals(o);
     }
 }

core/src/main/java/com/linecorp/armeria/common/DefaultRequestHeaders.java

@@ -64,7 +64,7 @@ public RequestHeadersBuilder toBuilder() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         return o instanceof RequestHeaders && super.equals(o);
     }
 }

core/src/main/java/com/linecorp/armeria/common/DefaultResponseHeaders.java

@@ -47,7 +47,7 @@ public ResponseHeadersBuilder toBuilder() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         return o instanceof ResponseHeaders && super.equals(o);
     }
 }

core/src/main/java/com/linecorp/armeria/common/DefaultRpcRequest.java

@@ -115,7 +115,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

core/src/main/java/com/linecorp/armeria/common/HttpHeadersBase.java

@@ -960,7 +960,7 @@ public final int hashCode() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         if (this == o) {
             return true;
         }
@@ -1142,7 +1142,7 @@ public int hashCode() {
         }
 
         @Override
-        public boolean equals(Object o) {
+        public boolean equals(@Nullable Object o) {
             if (this == o) {
                 return true;
             }

core/src/main/java/com/linecorp/armeria/common/ImmutableHttpParameters.java

@@ -23,6 +23,8 @@
 import java.util.Map.Entry;
 import java.util.Set;
 
+import javax.annotation.Nullable;
+
 import io.netty.handler.codec.Headers;
 
 final class ImmutableHttpParameters implements HttpParameters {
@@ -510,7 +512,7 @@ public int hashCode() {
 
     @Override
     @SuppressWarnings("EqualsWhichDoesntCheckParameterClass")
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         return delegate.equals(obj);
     }
 

core/src/main/java/com/linecorp/armeria/common/Scheme.java

@@ -145,7 +145,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         return this == obj;
     }
 

core/src/main/java/com/linecorp/armeria/common/SerializationFormat.java

@@ -324,7 +324,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         return this == obj;
     }
 

core/src/main/java/com/linecorp/armeria/common/SerializationFormatProvider.java

@@ -20,6 +20,8 @@
 
 import java.util.Set;
 
+import javax.annotation.Nullable;
+
 import com.google.common.base.Ascii;
 import com.google.common.base.MoreObjects;
 import com.google.common.collect.ImmutableList;
@@ -55,7 +57,7 @@ public Entry(String uriText, MediaType primaryMediaType, MediaType... alternativ
         }
 
         @Override
-        public boolean equals(Object obj) {
+        public boolean equals(@Nullable Object obj) {
             if (this == obj) {
                 return true;
             }

core/src/main/java/com/linecorp/armeria/common/ServerCacheControl.java

@@ -226,7 +226,7 @@ public String asHeaderValue() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         if (!super.equals(o)) {
             return false;
         }

core/src/main/java/com/linecorp/armeria/common/logging/RequestLogAvailabilitySet.java

@@ -23,6 +23,8 @@
 import java.util.List;
 import java.util.Set;
 
+import javax.annotation.Nullable;
+
 import com.google.common.collect.Iterators;
 import com.google.common.math.IntMath;
 
@@ -103,7 +105,7 @@ public boolean contains(Object e) {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         return this == o;
     }
 

core/src/main/java/com/linecorp/armeria/common/metric/MeterIdPrefix.java

@@ -24,6 +24,8 @@
 import java.util.Collection;
 import java.util.List;
 
+import javax.annotation.Nullable;
+
 import com.google.common.collect.ImmutableList;
 import com.google.common.collect.Lists;
 
@@ -207,7 +209,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

core/src/main/java/com/linecorp/armeria/common/sse/DefaultServerSentEvent.java

@@ -91,7 +91,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

core/src/main/java/com/linecorp/armeria/internal/PathAndQuery.java

@@ -157,7 +157,7 @@ public String query() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         if (this == o) {
             return true;
         }

core/src/main/java/com/linecorp/armeria/internal/annotation/AnnotatedBeanFactoryRegistry.java

@@ -300,7 +300,7 @@ Class<?> type() {
         }
 
         @Override
-        public boolean equals(Object o) {
+        public boolean equals(@Nullable Object o) {
             if (this == o) {
                 return true;
             }

core/src/main/java/com/linecorp/armeria/server/ClientAddressSource.java

@@ -20,6 +20,8 @@
 
 import java.util.List;
 
+import javax.annotation.Nullable;
+
 import com.google.common.base.MoreObjects;
 import com.google.common.collect.ImmutableList;
 
@@ -89,7 +91,7 @@ boolean isProxyProtocol() {
     }
 
     @Override
-    public boolean equals(Object o) {
+    public boolean equals(@Nullable Object o) {
         if (this == o) {
             return true;
         }