Standardize nullability checks with checkerframework

SpongePowered · Nov 12, 2023 · e5fb171 · e5fb171
1 parent 323fab8
commit e5fb171
Show file tree

Hide file tree

Showing 137 changed files with 209 additions and 332 deletions.
diff --git a/...accessors/java/org/spongepowered/common/accessor/commands/CommandSourceStackAccessor.java b/...accessors/java/org/spongepowered/common/accessor/commands/CommandSourceStackAccessor.java
@@ -36,14 +36,13 @@
 import net.minecraft.world.entity.Entity;
 import net.minecraft.world.phys.Vec2;
 import net.minecraft.world.phys.Vec3;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.gen.Invoker;
 import org.spongepowered.common.UntransformedInvokerError;
 
 import java.util.function.IntConsumer;
 
-import javax.annotation.Nullable;
-
 @Mixin(CommandSourceStack.class)
 public interface CommandSourceStackAccessor {
 

diff --git a/src/accessors/java/org/spongepowered/common/accessor/world/entity/DisplayAccessor.java b/src/accessors/java/org/spongepowered/common/accessor/world/entity/DisplayAccessor.java
@@ -28,12 +28,11 @@
 import net.minecraft.network.syncher.SynchedEntityData;
 import net.minecraft.util.Brightness;
 import net.minecraft.world.entity.Display;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.gen.Invoker;
 import org.spongepowered.common.UntransformedInvokerError;
 
-import javax.annotation.Nullable;
-
 @Mixin(Display.class)
 public interface DisplayAccessor {
 

diff --git a/...epowered/common/accessor/world/level/block/entity/AbstractFurnaceBlockEntityAccessor.java b/...epowered/common/accessor/world/level/block/entity/AbstractFurnaceBlockEntityAccessor.java
@@ -32,13 +32,12 @@
 import net.minecraft.world.item.crafting.RecipeHolder;
 import net.minecraft.world.item.crafting.RecipeManager;
 import net.minecraft.world.level.block.entity.AbstractFurnaceBlockEntity;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.gen.Accessor;
 import org.spongepowered.asm.mixin.gen.Invoker;
 import org.spongepowered.common.UntransformedInvokerError;
 
-import javax.annotation.Nullable;
-
 @Mixin(AbstractFurnaceBlockEntity.class)
 public interface AbstractFurnaceBlockEntityAccessor {
 

diff --git a/src/main/java/org/spongepowered/common/bridge/network/chat/SpongeChatDecorator.java b/src/main/java/org/spongepowered/common/bridge/network/chat/SpongeChatDecorator.java
@@ -27,7 +27,7 @@
 import net.minecraft.network.chat.ChatDecorator;
 import net.minecraft.network.chat.Component;
 import net.minecraft.server.level.ServerPlayer;
-import org.jetbrains.annotations.Nullable;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.event.CauseStackManager;
 import org.spongepowered.api.event.SpongeEventFactory;
 import org.spongepowered.api.event.message.PlayerChatEvent;

diff --git a/src/main/java/org/spongepowered/common/command/registrar/SpongeCommandRegistrarType.java b/src/main/java/org/spongepowered/common/command/registrar/SpongeCommandRegistrarType.java
@@ -25,7 +25,7 @@
 package org.spongepowered.common.command.registrar;
 
 import io.leangen.geantyref.TypeToken;
-import org.jetbrains.annotations.NotNull;
+import org.checkerframework.checker.nullness.qual.NonNull;
 import org.spongepowered.api.command.manager.CommandManager;
 import org.spongepowered.api.command.registrar.CommandRegistrar;
 import org.spongepowered.api.command.registrar.CommandRegistrarType;
@@ -52,12 +52,12 @@ public SpongeCommandRegistrarType(
     }
 
     @Override
-    public @NotNull TypeToken<V> handledType() {
+    public @NonNull TypeToken<V> handledType() {
         return this.handledType;
     }
 
     @Override
-    public @NotNull CommandRegistrar<V> create(final CommandManager.@NotNull Mutable manager) {
+    public @NonNull CommandRegistrar<V> create(final CommandManager.@NonNull Mutable manager) {
         return this.supplier.apply(manager);
     }
 }
diff --git a/src/main/java/org/spongepowered/common/data/DataSerializer.java b/src/main/java/org/spongepowered/common/data/DataSerializer.java
@@ -26,7 +26,7 @@
 
 import com.google.common.collect.ImmutableList;
 import org.apache.commons.lang3.ArrayUtils;
-import org.jetbrains.annotations.NotNull;
+import org.checkerframework.checker.nullness.qual.NonNull;
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.Sponge;
 import org.spongepowered.api.data.persistence.DataContainer;
@@ -136,7 +136,7 @@ private static DataQuery serializeMapKey(final Object value) {
         throw new UnsupportedOperationException("Unsupported map-key type " + value.getClass());
     }
 
-    @NotNull
+    @NonNull
     private static Object serializeArray(final DataView.SafetyMode safetyMode, final Object value) {
         switch (safetyMode) {
             case ALL_DATA_CLONED:

diff --git a/src/main/java/org/spongepowered/common/data/provider/entity/AbstractRaiderData.java b/src/main/java/org/spongepowered/common/data/provider/entity/AbstractRaiderData.java
@@ -25,13 +25,12 @@
 package org.spongepowered.common.data.provider.entity;
 
 import net.minecraft.world.entity.raid.Raider;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.data.Keys;
 import org.spongepowered.common.accessor.world.entity.raid.RaiderAccessor;
 import org.spongepowered.common.bridge.world.entity.raid.RaidBridge;
 import org.spongepowered.common.data.provider.DataProviderRegistrator;
 
-import javax.annotation.Nullable;
-
 public final class AbstractRaiderData {
 
     private AbstractRaiderData() {

diff --git a/src/main/java/org/spongepowered/common/data/provider/entity/DisplayEntityData.java b/src/main/java/org/spongepowered/common/data/provider/entity/DisplayEntityData.java
@@ -28,6 +28,7 @@
 import net.minecraft.util.Brightness;
 import net.minecraft.world.entity.Display;
 import net.minecraft.world.item.ItemDisplayContext;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.joml.Quaterniond;
 import org.joml.Vector3f;
 import org.spongepowered.api.block.BlockState;
@@ -48,8 +49,6 @@
 
 import java.awt.Color;
 
-import javax.annotation.Nullable;
-
 public class DisplayEntityData {
 
     private DisplayEntityData() {

diff --git a/src/main/java/org/spongepowered/common/item/recipe/SpongeRecipeRegistration.java b/src/main/java/org/spongepowered/common/item/recipe/SpongeRecipeRegistration.java
@@ -39,7 +39,7 @@
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.crafting.Ingredient;
 import net.minecraft.world.item.crafting.RecipeSerializer;
-import org.jetbrains.annotations.Nullable;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.data.persistence.DataContainer;
 import org.spongepowered.api.data.persistence.DataFormats;

diff --git a/src/main/java/org/spongepowered/common/item/recipe/cooking/ResultFunctionRecipe.java b/src/main/java/org/spongepowered/common/item/recipe/cooking/ResultFunctionRecipe.java
@@ -24,7 +24,7 @@
  */
 package org.spongepowered.common.item.recipe.cooking;
 
-import javax.annotation.Nullable;
+import org.checkerframework.checker.nullness.qual.Nullable;
 
 public interface ResultFunctionRecipe {
     @Nullable String resultFunctionId();

diff --git a/src/main/java/org/spongepowered/common/item/recipe/ingredient/IngredientResultUtil.java b/src/main/java/org/spongepowered/common/item/recipe/ingredient/IngredientResultUtil.java
@@ -32,14 +32,13 @@
 import net.minecraft.core.NonNullList;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.world.Container;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.common.SpongeCommon;
 
 import java.text.MessageFormat;
 import java.util.Map;
 import java.util.function.Function;
 
-import javax.annotation.Nullable;
-
 public final class IngredientResultUtil {
 
     private static final Map<String, Function<?, net.minecraft.world.item.ItemStack>> cachedResultFunctions = new Object2ObjectOpenHashMap<>();

diff --git a/src/main/java/org/spongepowered/common/item/recipe/smithing/SpongeSmithingRecipe.java b/src/main/java/org/spongepowered/common/item/recipe/smithing/SpongeSmithingRecipe.java
@@ -30,7 +30,7 @@
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.crafting.Ingredient;
 import net.minecraft.world.item.crafting.SmithingTransformRecipe;
-import org.jetbrains.annotations.Nullable;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.common.item.recipe.cooking.ResultFunctionRecipe;
 import org.spongepowered.common.item.recipe.ingredient.IngredientResultUtil;
 

diff --git a/...main/java/org/spongepowered/common/item/recipe/stonecutting/SpongeStonecuttingRecipe.java b/...main/java/org/spongepowered/common/item/recipe/stonecutting/SpongeStonecuttingRecipe.java
@@ -29,7 +29,7 @@
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.crafting.Ingredient;
 import net.minecraft.world.item.crafting.StonecutterRecipe;
-import org.jetbrains.annotations.Nullable;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.common.item.recipe.cooking.ResultFunctionRecipe;
 import org.spongepowered.common.item.recipe.ingredient.IngredientResultUtil;
 

diff --git a/src/main/java/org/spongepowered/common/resource/SpongeResourcePath.java b/src/main/java/org/spongepowered/common/resource/SpongeResourcePath.java
@@ -26,8 +26,8 @@
 
 import org.apache.commons.io.FilenameUtils;
 import org.apache.logging.log4j.util.Strings;
-import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
+import org.checkerframework.checker.nullness.qual.NonNull;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.resource.ResourcePath;
 
@@ -97,7 +97,7 @@ public String extension() {
     }
 
     @Override
-    public int compareTo(@NotNull final ResourcePath o) {
+    public int compareTo(@NonNull final ResourcePath o) {
         return this.key.compareTo(o.key());
     }
 

diff --git a/src/main/java/org/spongepowered/common/world/generation/carver/SpongeCarverTemplate.java b/src/main/java/org/spongepowered/common/world/generation/carver/SpongeCarverTemplate.java
@@ -33,7 +33,7 @@
 import net.minecraft.world.level.levelgen.carver.CarverConfiguration;
 import net.minecraft.world.level.levelgen.carver.ConfiguredWorldCarver;
 import net.minecraft.world.level.levelgen.carver.WorldCarver;
-import org.jetbrains.annotations.Nullable;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.data.persistence.DataContainer;
 import org.spongepowered.api.data.persistence.DataFormats;

diff --git a/src/main/java/org/spongepowered/common/world/schematic/SchematicTranslator.java b/src/main/java/org/spongepowered/common/world/schematic/SchematicTranslator.java
@@ -32,7 +32,6 @@
 import net.minecraft.util.datafix.DataFixTypes;
 import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
-import org.jetbrains.annotations.NotNull;
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.Sponge;
 import org.spongepowered.api.block.BlockState;
@@ -246,7 +245,7 @@ private static Function<DataView, Optional<EntityArchetypeEntry>> deserializeEnt
         };
     }
 
-    @NotNull
+    @NonNull
     private static Consumer<DataView> deserializeBlockEntities(
         final Vector3i offset, final SpongeArchetypeVolume archetypeVolume,
         final boolean needsFixers

diff --git a/src/main/java/org/spongepowered/common/world/server/SpongeWorldManager.java b/src/main/java/org/spongepowered/common/world/server/SpongeWorldManager.java
@@ -67,7 +67,7 @@
 import net.minecraft.world.level.storage.LevelStorageSource;
 import net.minecraft.world.level.storage.PrimaryLevelData;
 import net.minecraft.world.level.storage.WorldData;
-import org.jetbrains.annotations.Nullable;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.Server;
 import org.spongepowered.api.Sponge;

diff --git a/src/main/java/org/spongepowered/common/world/server/SpongeWorldTemplate.java b/src/main/java/org/spongepowered/common/world/server/SpongeWorldTemplate.java
@@ -42,8 +42,8 @@
 import net.minecraft.world.level.GameType;
 import net.minecraft.world.level.dimension.DimensionType;
 import net.minecraft.world.level.dimension.LevelStem;
+import org.checkerframework.checker.nullness.qual.NonNull;
 import org.checkerframework.checker.nullness.qual.Nullable;
-import org.jetbrains.annotations.NotNull;
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.data.DataHolder;
 import org.spongepowered.api.data.DataManipulator;
@@ -287,7 +287,7 @@ protected WorldTemplate build0() {
             return new SpongeWorldTemplate(this.key, levelStem, this.pack);
         }
 
-        @NotNull
+        @NonNull
         private static Holder<DimensionType> dimensionTypeHolder(final WorldType worldType) {
             final Registry<DimensionType> dimensionTypeRegistry = SpongeCommon.server().registryAccess().registryOrThrow(Registries.DIMENSION_TYPE);
             final ResourceLocation key = dimensionTypeRegistry.getKey((DimensionType) (Object) worldType);

diff --git a/src/mixins/java/org/spongepowered/common/mixin/api/item/merchant/MerchantMixin_API.java b/src/mixins/java/org/spongepowered/common/mixin/api/item/merchant/MerchantMixin_API.java
@@ -28,6 +28,7 @@
 import net.minecraft.world.item.ItemStack;
 import net.minecraft.world.item.trading.MerchantOffer;
 import net.minecraft.world.item.trading.MerchantOffers;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.data.Keys;
 import org.spongepowered.api.entity.living.Humanoid;
 import org.spongepowered.api.item.merchant.Merchant;
@@ -38,8 +39,6 @@
 
 import java.util.Collections;
 
-import javax.annotation.Nullable;
-
 @Mixin(value = Merchant.class)
 @Implements(@Interface(iface = net.minecraft.world.item.trading.Merchant.class, prefix = "imerchant$"))
 public interface MerchantMixin_API extends Merchant {

diff --git a/...org/spongepowered/common/mixin/api/minecraft/advancements/CriterionProgressMixin_API.java b/...org/spongepowered/common/mixin/api/minecraft/advancements/CriterionProgressMixin_API.java
@@ -28,6 +28,7 @@
 import net.minecraft.advancements.AdvancementHolder;
 import net.minecraft.advancements.CriterionProgress;
 import net.minecraft.resources.ResourceLocation;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.advancement.AdvancementProgress;
 import org.spongepowered.api.advancement.criteria.AdvancementCriterion;
 import org.spongepowered.asm.mixin.Mixin;
@@ -38,8 +39,6 @@
 import java.time.Instant;
 import java.util.Optional;
 
-import javax.annotation.Nullable;
-
 @Mixin(CriterionProgress.class)
 public abstract class CriterionProgressMixin_API implements org.spongepowered.api.advancement.criteria.CriterionProgress {
 

diff --git a/...ns/java/org/spongepowered/common/mixin/api/minecraft/advancements/FrameTypeMixin_API.java b/...ns/java/org/spongepowered/common/mixin/api/minecraft/advancements/FrameTypeMixin_API.java
@@ -27,15 +27,14 @@
 import net.kyori.adventure.text.format.TextColor;
 import net.minecraft.ChatFormatting;
 import net.minecraft.advancements.FrameType;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.advancement.AdvancementType;
 import org.spongepowered.asm.mixin.Mixin;
 import org.spongepowered.asm.mixin.injection.At;
 import org.spongepowered.asm.mixin.injection.Inject;
 import org.spongepowered.asm.mixin.injection.callback.CallbackInfo;
 import org.spongepowered.common.adventure.SpongeAdventure;
 
-import javax.annotation.Nullable;
-
 @Mixin(FrameType.class)
 public abstract class FrameTypeMixin_API implements AdvancementType {
 

diff --git a/src/mixins/java/org/spongepowered/common/mixin/api/minecraft/client/MinecraftMixin_API.java b/src/mixins/java/org/spongepowered/common/mixin/api/minecraft/client/MinecraftMixin_API.java
@@ -29,6 +29,7 @@
 import net.minecraft.client.server.IntegratedServer;
 import net.minecraft.network.Connection;
 import net.minecraft.server.packs.repository.PackRepository;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.Game;
 import org.spongepowered.api.Sponge;
 import org.spongepowered.api.client.LocalServer;
@@ -51,8 +52,6 @@
 import java.util.Locale;
 import java.util.Optional;
 
-import javax.annotation.Nullable;
-
 @Mixin(Minecraft.class)
 public abstract class MinecraftMixin_API implements SpongeClient, SpongeRegistryHolder {
 

diff --git a/...ixins/java/org/spongepowered/common/mixin/api/minecraft/core/MappedRegistryMixin_API.java b/...ixins/java/org/spongepowered/common/mixin/api/minecraft/core/MappedRegistryMixin_API.java
@@ -30,6 +30,7 @@
 import net.minecraft.core.MappedRegistry;
 import net.minecraft.resources.ResourceLocation;
 import net.minecraft.tags.TagKey;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.ResourceKey;
 import org.spongepowered.api.registry.Registry;
 import org.spongepowered.api.registry.RegistryEntry;
@@ -50,8 +51,6 @@
 import java.util.stream.Collectors;
 import java.util.stream.Stream;
 
-import javax.annotation.Nullable;
-
 @Mixin(MappedRegistry.class)
 @Implements(@Interface(iface = Registry.class, prefix = "registry$", remap = Interface.Remap.NONE))
 public abstract class MappedRegistryMixin_API<T> implements Registry<T> {

diff --git a/src/mixins/java/org/spongepowered/common/mixin/api/minecraft/map/MapDecorationMixin_API.java b/src/mixins/java/org/spongepowered/common/mixin/api/minecraft/map/MapDecorationMixin_API.java
@@ -27,6 +27,7 @@
 import com.google.common.base.Preconditions;
 import net.minecraft.network.chat.Component;
 import net.minecraft.world.level.saveddata.maps.MapDecoration;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.data.persistence.DataContainer;
 import org.spongepowered.api.map.decoration.MapDecorationType;
 import org.spongepowered.api.map.decoration.orientation.MapDecorationOrientation;
@@ -40,8 +41,6 @@
 import org.spongepowered.common.util.MapUtil;
 import org.spongepowered.math.vector.Vector2i;
 
-import javax.annotation.Nullable;
-
 @Mixin(MapDecoration.class)
 public abstract class MapDecorationMixin_API implements org.spongepowered.api.map.decoration.MapDecoration {
 

diff --git a/...s/java/org/spongepowered/common/mixin/api/minecraft/network/FriendlyByteBufMixin_API.java b/...s/java/org/spongepowered/common/mixin/api/minecraft/network/FriendlyByteBufMixin_API.java
@@ -33,6 +33,7 @@
 import net.minecraft.nbt.CompoundTag;
 import net.minecraft.nbt.Tag;
 import net.minecraft.network.FriendlyByteBuf;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.spongepowered.api.data.persistence.DataView;
 import org.spongepowered.api.network.channel.ChannelBuf;
 import org.spongepowered.asm.mixin.Implements;
@@ -48,8 +49,6 @@
 import java.io.IOException;
 import java.util.UUID;
 
-import javax.annotation.Nullable;
-
 @Mixin(FriendlyByteBuf.class)
 @Implements(@Interface(iface = ChannelBuf.class, prefix = "cbuf$", remap = Remap.NONE))
 public abstract class FriendlyByteBufMixin_API extends ByteBuf {