annotate method

xGinko · Aug 6, 2024 · 569e2e2 · 569e2e2
1 parent b16eace
commit 569e2e2
Show file tree

Hide file tree

Showing 31 changed files with 101 additions and 37 deletions.
diff --git a/...ExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/BannedItemNames.java b/...ExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/BannedItemNames.java
@@ -12,6 +12,8 @@
 import org.bukkit.event.Listener;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.ItemMeta;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.Collections;
 import java.util.EnumSet;
@@ -78,7 +80,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (
                 itemStack == null
                 || whitelistedTypes.contains(itemStack.getType())

diff --git a/...ExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/BannedMaterials.java b/...ExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/BannedMaterials.java
@@ -7,6 +7,8 @@
 import me.xginko.aef.utils.ItemUtil;
 import org.bukkit.Material;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.EnumSet;
 import java.util.List;
@@ -65,7 +67,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null) {
             return ItemLegality.LEGAL;
         }

diff --git a/...ploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/IllegalItemModule.java b/...ploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/IllegalItemModule.java
@@ -38,7 +38,9 @@
 import org.bukkit.event.world.ChunkLoadEvent;
 import org.bukkit.inventory.InventoryHolder;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.checkerframework.checker.nullness.qual.PolyNull;
+import org.jetbrains.annotations.NotNull;
 
 import java.time.Duration;
 import java.util.Arrays;
@@ -49,9 +51,6 @@
 
 public abstract class IllegalItemModule extends AEFModule implements Listener {
 
-    public abstract ItemLegality legalityOf(ItemStack itemStack);
-    public abstract void handleItem(ItemStack itemStack, ItemLegality legality);
-
     protected final AEFPermission bypassPermission;
     protected final IllegalHandling handling;
     protected final Set<Listener> optionalListeners;
@@ -62,6 +61,7 @@ public IllegalItemModule(String configPath, AEFPermission bypassPermission) {
         super(configPath);
         this.bypassPermission = bypassPermission;
         this.optionalListeners = new HashSet<>();
+
         String configuredHandling = config.getString(configPath + ".handling", IllegalHandling.PREVENT_USE_ONLY.name(),
                 "Available options:\n" + Arrays.stream(IllegalHandling.values())
                         .map(option -> option.name() + " - " + option.description())
@@ -157,6 +157,10 @@ private void onChunkLoad(ChunkLoadEvent event) {
         this.createIfAbsent = eventClass -> new ExpiringSet<>(delay);
     }
 
+    public abstract @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack);
+
+    public abstract void handleItem(ItemStack itemStack, ItemLegality legality);
+
     @Override
     public void enable() {
         plugin.getServer().getPluginManager().registerEvents(this, plugin);
@@ -170,7 +174,7 @@ public void disable() {
         optionalListeners.clear();
     }
 
-    public ItemLegality legalityOf(Iterable<ItemStack> itemStacks) {
+    public ItemLegality legalityOf(@Nullable Iterable<ItemStack> itemStacks) {
         if (itemStacks == null) {
             return ItemLegality.LEGAL;
         }

diff --git a/...yExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/IllegalPotions.java b/...yExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/IllegalPotions.java
@@ -7,6 +7,8 @@
 import me.xginko.aef.utils.MaterialUtil;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.PotionMeta;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 public class IllegalPotions extends IllegalItemModule {
 
@@ -27,7 +29,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || !MaterialUtil.POTIONS.contains(itemStack.getType()) || !itemStack.hasItemMeta()) {
             return ItemLegality.LEGAL;
         }

diff --git a/...xploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/InvalidStackSize.java b/...xploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/InvalidStackSize.java
@@ -6,6 +6,8 @@
 import me.xginko.aef.utils.ItemUtil;
 import org.bukkit.Material;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.EnumSet;
 import java.util.List;
@@ -47,7 +49,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || itemStack.getType().isAir()) {
             return ItemLegality.LEGAL;
         }

diff --git a/...yExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/ItemAttributes.java b/...yExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/ItemAttributes.java
@@ -8,6 +8,8 @@
 import org.bukkit.inventory.ItemFlag;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.ItemMeta;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.EnumSet;
 import java.util.List;
@@ -49,7 +51,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || itemStack.getType().isAir() || !itemStack.hasItemMeta()) {
             return ItemLegality.LEGAL;
         }

diff --git a/AnarchyExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/PlayerHeads.java b/AnarchyExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/PlayerHeads.java
@@ -6,6 +6,8 @@
 import me.xginko.aef.utils.ItemUtil;
 import me.xginko.aef.utils.MaterialUtil;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 public class PlayerHeads extends IllegalItemModule {
 
@@ -26,7 +28,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null) {
             return ItemLegality.LEGAL;
         }

diff --git a/AnarchyExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/SpawnEggs.java b/AnarchyExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/SpawnEggs.java
@@ -8,6 +8,8 @@
 import me.xginko.aef.utils.ItemUtil;
 import org.bukkit.Material;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.Collections;
 import java.util.EnumSet;
@@ -49,7 +51,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || whitelistedTypes.contains(itemStack.getType())) {
             return ItemLegality.LEGAL;
         }

diff --git a/...chyExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/Unbreakables.java b/...chyExploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/Unbreakables.java
@@ -8,6 +8,8 @@
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.Damageable;
 import org.bukkit.inventory.meta.ItemMeta;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.EnumSet;
 import java.util.List;
@@ -53,7 +55,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || itemStack.getType().isAir() || !itemStack.hasItemMeta()) {
             return ItemLegality.LEGAL;
         }

diff --git a/...Folia/src/main/java/me/xginko/aef/modules/illegals/items/enchantments/HigherEnchants.java b/...Folia/src/main/java/me/xginko/aef/modules/illegals/items/enchantments/HigherEnchants.java
@@ -8,6 +8,8 @@
 import org.bukkit.Material;
 import org.bukkit.enchantments.Enchantment;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.EnumSet;
 import java.util.HashSet;
@@ -63,7 +65,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || itemStack.getType().isAir()) {
             return ItemLegality.LEGAL;
         }

diff --git a/...src/main/java/me/xginko/aef/modules/illegals/items/enchantments/InapplicableEnchants.java b/...src/main/java/me/xginko/aef/modules/illegals/items/enchantments/InapplicableEnchants.java
@@ -8,6 +8,8 @@
 import org.bukkit.Material;
 import org.bukkit.enchantments.Enchantment;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.EnumSet;
 import java.util.List;
@@ -51,7 +53,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || itemStack.getType().isAir()) {
             return ItemLegality.LEGAL;
         }

diff --git a/...src/main/java/me/xginko/aef/modules/illegals/items/enchantments/IncompatibleEnchants.java b/...src/main/java/me/xginko/aef/modules/illegals/items/enchantments/IncompatibleEnchants.java
@@ -8,6 +8,8 @@
 import org.bukkit.Material;
 import org.bukkit.enchantments.Enchantment;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.Collections;
 import java.util.EnumSet;
@@ -76,7 +78,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || itemStack.getType() == Material.AIR) {
             return ItemLegality.LEGAL;
         }

diff --git a/...xploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/nbt/CommandItems.java b/...xploitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/nbt/CommandItems.java
@@ -6,6 +6,8 @@
 import me.xginko.aef.modules.illegals.items.IllegalItemModule;
 import me.xginko.aef.utils.MaterialUtil;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 public class CommandItems extends IllegalItemModule {
 
@@ -27,7 +29,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || itemStack.getType().isAir()) {
             return ItemLegality.LEGAL;
         }

diff --git a/...oitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/nbt/CustomNBTFilter.java b/...oitFixesFolia/src/main/java/me/xginko/aef/modules/illegals/items/nbt/CustomNBTFilter.java
@@ -8,6 +8,8 @@
 import me.xginko.aef.utils.ItemUtil;
 import org.bukkit.Material;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.EnumSet;
 import java.util.HashSet;
@@ -52,7 +54,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || itemStack.getType().isAir()) {
             return ItemLegality.LEGAL;
         }

diff --git a/...xesFolia/src/main/java/me/xginko/aef/modules/illegals/items/nbt/NBTFilledStorageItem.java b/...xesFolia/src/main/java/me/xginko/aef/modules/illegals/items/nbt/NBTFilledStorageItem.java
@@ -10,6 +10,8 @@
 import me.xginko.aef.utils.MaterialUtil;
 import org.bukkit.Material;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.EnumSet;
 import java.util.Objects;
@@ -55,7 +57,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || itemStack.getType().isAir()) {
             return ItemLegality.LEGAL;
         }

diff --git a/...xploitFixesLegacy/src/main/java/me/xginko/aef/modules/illegals/items/BannedItemNames.java b/...xploitFixesLegacy/src/main/java/me/xginko/aef/modules/illegals/items/BannedItemNames.java
@@ -6,6 +6,8 @@
 import org.bukkit.Material;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.ItemMeta;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.Collections;
 import java.util.EnumSet;
@@ -56,7 +58,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (
                 itemStack == null
                 || whitelistedTypes.contains(itemStack.getType())

diff --git a/...xploitFixesLegacy/src/main/java/me/xginko/aef/modules/illegals/items/BannedMaterials.java b/...xploitFixesLegacy/src/main/java/me/xginko/aef/modules/illegals/items/BannedMaterials.java
@@ -7,6 +7,8 @@
 import me.xginko.aef.utils.ItemUtil;
 import org.bukkit.Material;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 import java.util.EnumSet;
 import java.util.List;
@@ -65,7 +67,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null) {
             return ItemLegality.LEGAL;
         }

diff --git a/...loitFixesLegacy/src/main/java/me/xginko/aef/modules/illegals/items/IllegalItemModule.java b/...loitFixesLegacy/src/main/java/me/xginko/aef/modules/illegals/items/IllegalItemModule.java
@@ -38,7 +38,9 @@
 import org.bukkit.event.world.ChunkLoadEvent;
 import org.bukkit.inventory.InventoryHolder;
 import org.bukkit.inventory.ItemStack;
+import org.checkerframework.checker.nullness.qual.Nullable;
 import org.checkerframework.checker.nullness.qual.PolyNull;
+import org.jetbrains.annotations.NotNull;
 
 import java.time.Duration;
 import java.util.Arrays;
@@ -49,13 +51,9 @@
 
 public abstract class IllegalItemModule extends AEFModule implements Listener {
 
-    public abstract ItemLegality legalityOf(ItemStack itemStack);
-    public abstract void handleItem(ItemStack itemStack, ItemLegality legality);
-
     protected final AEFPermission bypassPermission;
     protected final IllegalHandling handling;
     protected final Set<Listener> optionalListeners;
-
     private final Cache<Class<? extends Event>, ExpiringSet<Object>> listenerCooldowns;
     private final Function<Class<? extends Event>, @PolyNull ExpiringSet<Object>> createIfAbsent;
 
@@ -159,6 +157,10 @@ private void onChunkLoad(ChunkLoadEvent event) {
         this.createIfAbsent = eventClass -> new ExpiringSet<>(delay);
     }
 
+    public abstract @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack);
+
+    public abstract void handleItem(ItemStack itemStack, ItemLegality legality);
+
     @Override
     public void enable() {
         plugin.getServer().getPluginManager().registerEvents(this, plugin);

diff --git a/...ExploitFixesLegacy/src/main/java/me/xginko/aef/modules/illegals/items/IllegalPotions.java b/...ExploitFixesLegacy/src/main/java/me/xginko/aef/modules/illegals/items/IllegalPotions.java
@@ -7,6 +7,8 @@
 import me.xginko.aef.utils.MaterialUtil;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.PotionMeta;
+import org.checkerframework.checker.nullness.qual.Nullable;
+import org.jetbrains.annotations.NotNull;
 
 public class IllegalPotions extends IllegalItemModule {
 
@@ -27,7 +29,7 @@ public boolean shouldEnable() {
     }
 
     @Override
-    public ItemLegality legalityOf(ItemStack itemStack) {
+    public @NotNull ItemLegality legalityOf(@Nullable ItemStack itemStack) {
         if (itemStack == null || !MaterialUtil.POTIONS.contains(itemStack.getType()) || !itemStack.hasItemMeta()) {
             return ItemLegality.LEGAL;
         }