Merge pull request #64 from TheNextLvl-net/jspecify

Remove package-info.java files and add @NullMarked annotations

Author: NonSwag

api/build.gradle.kts

@@ -26,7 +26,6 @@ repositories {
 
 dependencies {
     compileOnly("org.projectlombok:lombok:1.18.36")
-    compileOnly("net.thenextlvl.core:annotations:2.0.1")
     compileOnly("io.papermc.paper:paper-api:1.21.3-R0.1-SNAPSHOT")
 
     compileOnlyApi(platform("com.intellectualsites.bom:bom-newest:1.51"))

api/src/main/java/net/thenextlvl/gopaint/api/brush/BrushController.java

@@ -5,12 +5,14 @@
 import org.bukkit.entity.Player;
 import org.bukkit.inventory.ItemStack;
 import org.bukkit.inventory.meta.ItemMeta;
+import org.jspecify.annotations.NullMarked;
 
 import java.util.Optional;
 
 /**
  * This interface controls the brush settings for each player.
  */
+@NullMarked
 public interface BrushController {
     /**
      * Retrieves the brush settings for a specific player.

api/src/main/java/net/thenextlvl/gopaint/api/brush/BrushRegistry.java

@@ -1,6 +1,7 @@
 package net.thenextlvl.gopaint.api.brush;
 
 import net.kyori.adventure.key.Key;
+import org.jspecify.annotations.NullMarked;
 
 import java.util.Optional;
 import java.util.stream.Stream;
@@ -9,6 +10,7 @@
  * The BrushRegistry interface represents a registry for brushes.
  * It provides methods to access, register, and unregister brushes.
  */
+@NullMarked
 public interface BrushRegistry {
     /**
      * Returns a stream of registered brushes.

api/src/main/java/net/thenextlvl/gopaint/api/brush/PatternBrush.java

@@ -16,13 +16,15 @@
 import net.kyori.adventure.key.Keyed;
 import net.kyori.adventure.text.Component;
 import net.thenextlvl.gopaint.api.brush.setting.BrushSettings;
-import org.jetbrains.annotations.NotNull;
+import org.jspecify.annotations.NonNull;
+import org.jspecify.annotations.NullMarked;
 
 /**
  * This interface represents a brush used for painting blocks in a world.
  */
 @Getter
 @ToString
+@NullMarked
 @EqualsAndHashCode
 @RequiredArgsConstructor
 public abstract class PatternBrush implements Comparable<PatternBrush>, Keyed, Brush {
@@ -75,7 +77,7 @@ public abstract class PatternBrush implements Comparable<PatternBrush>, Keyed, B
     public abstract void build(EditSession session, BlockVector3 position, Pattern pattern, double size) throws MaxChangedBlocksException;
 
     @Override
-    public int compareTo(@NotNull PatternBrush brush) {
+    public int compareTo(@NonNull PatternBrush brush) {
         return key().compareTo(brush.key());
     }
 }

api/src/main/java/net/thenextlvl/gopaint/api/brush/SpherePatternBrush.java

@@ -5,7 +5,9 @@
 import com.sk89q.worldedit.function.pattern.Pattern;
 import com.sk89q.worldedit.math.BlockVector3;
 import net.kyori.adventure.key.Key;
+import org.jspecify.annotations.NullMarked;
 
+@NullMarked
 public abstract class SpherePatternBrush extends PatternBrush {
     public SpherePatternBrush(String headValue, Key key) {
         super(headValue, key);

api/src/main/java/net/thenextlvl/gopaint/api/brush/mask/VisibleMask.java

@@ -5,7 +5,9 @@
 import com.sk89q.worldedit.function.mask.Mask;
 import com.sk89q.worldedit.math.BlockVector3;
 import com.sk89q.worldedit.math.Vector3;
+import org.jspecify.annotations.NullMarked;
 
+@NullMarked
 public record VisibleMask(Extent extent, Vector3 viewPoint) implements Mask {
 
     @Override

api/src/main/java/net/thenextlvl/gopaint/api/brush/mask/package-info.java

@@ -9,9 +9,11 @@
 import com.sk89q.worldedit.world.block.BlockState;
 import net.thenextlvl.gopaint.api.brush.setting.BrushSettings;
 import org.bukkit.Material;
+import org.jspecify.annotations.NullMarked;
 
 import java.util.Objects;
 
+@NullMarked
 public interface BuildPattern extends Pattern {
     BlockVector3 position();