Add nullability annotations to nbt tags

Author: booky10

api/src/main/java/com/github/retrooper/packetevents/protocol/nbt/NBT.java

@@ -20,14 +20,15 @@
 
 import com.github.retrooper.packetevents.protocol.util.NbtCodecException;
 import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
 
 @NullMarked
 public abstract class NBT {
 
     public abstract NBTType<?> getType();
 
     @Override
-    public abstract boolean equals(Object other);
+    public abstract boolean equals(@Nullable Object other);
 
     @Override
     public abstract int hashCode();

api/src/main/java/com/github/retrooper/packetevents/protocol/nbt/NBTByte.java

@@ -18,6 +18,10 @@
 
 package com.github.retrooper.packetevents.protocol.nbt;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+@NullMarked
 public class NBTByte extends NBTNumber {
 
     protected final byte value;
@@ -80,7 +84,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

api/src/main/java/com/github/retrooper/packetevents/protocol/nbt/NBTByteArray.java

@@ -18,8 +18,12 @@
 
 package com.github.retrooper.packetevents.protocol.nbt;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
 import java.util.Arrays;
 
+@NullMarked
 public class NBTByteArray extends NBT {
 
     protected final byte[] array;
@@ -38,7 +42,7 @@ public byte[] getValue() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

api/src/main/java/com/github/retrooper/packetevents/protocol/nbt/NBTCompound.java

@@ -24,6 +24,7 @@
 import com.github.retrooper.packetevents.wrapper.PacketWrapper;
 import org.jetbrains.annotations.Contract;
 import org.jetbrains.annotations.Nullable;
+import org.jspecify.annotations.NullMarked;
 
 import java.text.MessageFormat;
 import java.util.ArrayList;
@@ -34,6 +35,7 @@
 import java.util.Set;
 import java.util.function.Supplier;
 
+@NullMarked
 public class NBTCompound extends NBT {
 
     protected final Map<String, NBT> tags = new LinkedHashMap<>();
@@ -199,7 +201,7 @@ public NBT removeTag(String key) {
     }
 
     @SuppressWarnings("unchecked")
-    public <T extends NBT> T removeTagAndReturnIfType(String key, Class<T> type) {
+    public <T extends NBT> @Nullable T removeTagAndReturnIfType(String key, Class<T> type) {
         NBT tag = removeTag(key);
         if (type.isInstance(tag)) {
             return (T) tag;
@@ -208,15 +210,15 @@ public <T extends NBT> T removeTagAndReturnIfType(String key, Class<T> type) {
     }
 
     @SuppressWarnings("unchecked")
-    public <T extends NBT> NBTList<T> removeTagAndReturnIfListType(String key, Class<T> type) {
+    public <T extends NBT> @Nullable NBTList<T> removeTagAndReturnIfListType(String key, Class<T> type) {
         NBTList<?> list = removeTagAndReturnIfType(key, NBTList.class);
         if ((list != null) && type.isAssignableFrom(list.getTagsType().getNBTClass())) {
             return (NBTList<T>) list;
         }
         return null;
     }
 
-    public void setTag(String key, NBT tag) {
+    public void setTag(String key, @Nullable NBT tag) {
         if (tag != null) {
             tags.put(key, tag);
         } else {
@@ -251,7 +253,6 @@ public boolean getBooleanOrThrow(String string) {
         return tag != null ? decoder.decode(tag, wrapper) : def;
     }
 
-    @Contract("_, _, !null, _ -> !null")
     public <T> @Nullable T getOrSupply(String key, NbtDecoder<T> decoder, Supplier<@Nullable T> def, PacketWrapper<?> wrapper) {
         NBT tag = this.getTagOrNull(key);
         return tag != null ? decoder.decode(tag, wrapper) : def.get();
@@ -333,7 +334,7 @@ public <T> void setCompactList(String key, List<T> value, NbtEncoder<T> encoder,
     }
 
     @Override
-    public boolean equals(Object other) {
+    public boolean equals(@Nullable Object other) {
         if (other instanceof NBTCompound) {
             if (isEmpty() && ((NBTCompound) other).isEmpty()) {
                 return true;

api/src/main/java/com/github/retrooper/packetevents/protocol/nbt/NBTDouble.java

@@ -18,6 +18,10 @@
 
 package com.github.retrooper.packetevents.protocol.nbt;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+@NullMarked
 public class NBTDouble extends NBTNumber {
 
     protected final double value;
@@ -72,7 +76,7 @@ public int hashCode() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

api/src/main/java/com/github/retrooper/packetevents/protocol/nbt/NBTEnd.java

@@ -18,6 +18,10 @@
 
 package com.github.retrooper.packetevents.protocol.nbt;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+@NullMarked
 public class NBTEnd extends NBT {
 
     public static final NBTEnd INSTANCE = new NBTEnd();
@@ -28,7 +32,7 @@ public NBTType<NBTEnd> getType() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

api/src/main/java/com/github/retrooper/packetevents/protocol/nbt/NBTFloat.java

@@ -18,6 +18,10 @@
 
 package com.github.retrooper.packetevents.protocol.nbt;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+@NullMarked
 public class NBTFloat extends NBTNumber {
 
     protected final float value;
@@ -67,7 +71,7 @@ public double getAsDouble() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

api/src/main/java/com/github/retrooper/packetevents/protocol/nbt/NBTInt.java

@@ -18,6 +18,10 @@
 
 package com.github.retrooper.packetevents.protocol.nbt;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+@NullMarked
 public class NBTInt extends NBTNumber {
 
     protected final int value;
@@ -67,7 +71,7 @@ public double getAsDouble() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

api/src/main/java/com/github/retrooper/packetevents/protocol/nbt/NBTIntArray.java

@@ -18,8 +18,12 @@
 
 package com.github.retrooper.packetevents.protocol.nbt;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
 import java.util.Arrays;
 
+@NullMarked
 public class NBTIntArray extends NBT {
 
     protected final int[] array;
@@ -38,7 +42,7 @@ public int[] getValue() {
     }
 
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }

api/src/main/java/com/github/retrooper/packetevents/protocol/nbt/NBTList.java

@@ -18,12 +18,16 @@
 
 package com.github.retrooper.packetevents.protocol.nbt;
 
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
 import java.text.MessageFormat;
 import java.util.ArrayList;
 import java.util.Collections;
 import java.util.List;
 import java.util.Objects;
 
+@NullMarked
 public class NBTList<T extends NBT> extends NBT {
 
     protected final NBTType<T> type;
@@ -167,7 +171,7 @@ public List<? extends NBT> unwrapTags() {
 
     @SuppressWarnings("unchecked")
     @Override
-    public boolean equals(Object obj) {
+    public boolean equals(@Nullable Object obj) {
         if (this == obj) {
             return true;
         }