Improve Kotlin interoperability by marking equals parameters as Nullable

Author: rubengees

library/config/findbugs/findbugs-filter.xml

@@ -28,4 +28,10 @@
         <Bug pattern="RCN_REDUNDANT_NULLCHECK_OF_NONNULL_VALUE"/>
     </Match>
 
+    <!-- Suppress nullness warnings concerning the equals method. -->
+    <Match>
+        <Method name="equals" params="java.lang.Object"/>
+        <Bug pattern="NP_METHOD_PARAMETER_TIGHTENS_ANNOTATION"/>
+    </Match>
+
 </FindBugsFilter>

library/src/main/java/me/proxer/library/api/ProxerResponse.java

@@ -10,7 +10,7 @@
  */
 @SuppressWarnings("TypeParameterUnusedInFormals")
 @ToString
-@EqualsAndHashCode
+@EqualsAndHashCode(onParam = @__({@Nullable}))
 @NoArgsConstructor(access = AccessLevel.PRIVATE)
 final class ProxerResponse<T> {
 

library/src/main/java/me/proxer/library/entity/anime/Stream.java

@@ -1,6 +1,7 @@
 package me.proxer.library.entity.anime;
 
 import com.squareup.moshi.Json;
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.Value;
 import me.proxer.library.entity.ProxerDateItem;
@@ -16,6 +17,7 @@
  * @author Ruben Gees
  */
 @Value
+@EqualsAndHashCode(onParam = @__({@Nullable}))
 public class Stream implements ProxerIdItem, ProxerImageItem, ProxerDateItem {
 
     /**

library/src/main/java/me/proxer/library/entity/info/Comment.java

@@ -1,13 +1,15 @@
 package me.proxer.library.entity.info;
 
 import com.squareup.moshi.Json;
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.Value;
 import me.proxer.library.entity.ProxerDateItem;
 import me.proxer.library.entity.ProxerIdItem;
 import me.proxer.library.entity.ProxerImageItem;
 import me.proxer.library.enums.UserMediaProgress;
 
+import javax.annotation.Nullable;
 import java.util.Date;
 
 /**
@@ -16,6 +18,7 @@
  * @author Desnoo
  */
 @Value
+@EqualsAndHashCode(onParam = @__({@Nullable}))
 public class Comment implements ProxerIdItem, ProxerImageItem, ProxerDateItem {
 
     /**

library/src/main/java/me/proxer/library/entity/info/Entry.java

@@ -1,12 +1,14 @@
 package me.proxer.library.entity.info;
 
 import com.squareup.moshi.Json;
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.Value;
 import me.proxer.library.entity.ProxerIdItem;
 import me.proxer.library.entity.list.IndustryCore;
 import me.proxer.library.enums.*;
 
+import javax.annotation.Nullable;
 import java.util.List;
 import java.util.Set;
 
@@ -17,6 +19,7 @@
  * @author Ruben Gees
  */
 @Value
+@EqualsAndHashCode(onParam = @__({@Nullable}))
 public class Entry implements ProxerIdItem {
 
     /**

library/src/main/java/me/proxer/library/entity/info/EntryCore.java

@@ -1,11 +1,13 @@
 package me.proxer.library.entity.info;
 
 import com.squareup.moshi.Json;
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.Value;
 import me.proxer.library.entity.ProxerIdItem;
 import me.proxer.library.enums.*;
 
+import javax.annotation.Nullable;
 import java.util.Set;
 
 /**
@@ -15,6 +17,7 @@
  * @author Desnoo
  */
 @Value
+@EqualsAndHashCode(onParam = @__({@Nullable}))
 public class EntryCore implements ProxerIdItem {
 
     /**

library/src/main/java/me/proxer/library/entity/info/EntrySeasonInfo.java

@@ -1,17 +1,21 @@
 package me.proxer.library.entity.info;
 
 import com.squareup.moshi.Json;
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.Value;
 import me.proxer.library.entity.ProxerIdItem;
 import me.proxer.library.enums.Season;
 
+import javax.annotation.Nullable;
+
 /**
  * Entity holding the season of an entry.
  *
  * @author Ruben Gees
  */
 @Value
+@EqualsAndHashCode(onParam = @__({@Nullable}))
 public class EntrySeasonInfo implements ProxerIdItem {
 
     /**

library/src/main/java/me/proxer/library/entity/info/EntryTranslatorGroup.java

@@ -1,17 +1,21 @@
 package me.proxer.library.entity.info;
 
 import com.squareup.moshi.Json;
+import lombok.EqualsAndHashCode;
 import lombok.Getter;
 import lombok.Value;
 import me.proxer.library.entity.ProxerIdItem;
 import me.proxer.library.enums.Country;
 
+import javax.annotation.Nullable;
+
 /**
  * Entity containing the relevant info of a translator group, associated with an {@link Entry}.
  *
  * @author Ruben Gees
  */
 @Value
+@EqualsAndHashCode(onParam = @__({@Nullable}))
 public class EntryTranslatorGroup implements ProxerIdItem {
 
     /**

library/src/main/java/me/proxer/library/entity/info/Episode.java

@@ -2,10 +2,13 @@
 
 import com.squareup.moshi.Json;
 import lombok.AllArgsConstructor;
+import lombok.EqualsAndHashCode;
 import lombok.Value;
 import lombok.experimental.NonFinal;
 import me.proxer.library.enums.MediaLanguage;
 
+import javax.annotation.Nullable;
+
 /**
  * Base entity holding the common data of an {@link AnimeEpisode} and {@link MangaEpisode}.
  *
@@ -14,6 +17,7 @@
 @Value
 @NonFinal
 @AllArgsConstructor()
+@EqualsAndHashCode(onParam = @__({@Nullable}))
 public abstract class Episode {
 
     /**

library/src/main/java/me/proxer/library/entity/info/EpisodeInfo.java

@@ -1,10 +1,12 @@
 package me.proxer.library.entity.info;
 
 import com.squareup.moshi.Json;
+import lombok.EqualsAndHashCode;
 import lombok.Value;
 import me.proxer.library.enums.Category;
 import me.proxer.library.enums.MediaLanguage;
 
+import javax.annotation.Nullable;
 import java.util.List;
 import java.util.Set;
 
@@ -14,6 +16,7 @@
  * @author Ruben Gees.
  */
 @Value
+@EqualsAndHashCode(onParam = @__({@Nullable}))
 public class EpisodeInfo {
 
     /**