Finish converting most of the undeprecated api to jspecify

PaperMC · Sep 30, 2024 · e7e1ab5 · e7e1ab5
1 parent ba3c29b
commit e7e1ab5
Show file tree

Hide file tree

Showing 45 changed files with 1,045 additions and 981 deletions.
diff --git a/patches/api/0004-Code-Generation.patch b/patches/api/0004-Code-Generation.patch
@@ -85,10 +85,10 @@ index 0000000000000000000000000000000000000000..2512dba27edfdccbc4430815b6cba048
 +}
 diff --git a/src/main/java/io/papermc/paper/registry/RegistryKey.java b/src/main/java/io/papermc/paper/registry/RegistryKey.java
 new file mode 100644
-index 0000000000000000000000000000000000000000..1e2765d296decbb3e61b8434e78b5e0214f8fee0
+index 0000000000000000000000000000000000000000..8410d7213370f01cbedbf7fac29bac96f150c49a
 --- /dev/null
 +++ b/src/main/java/io/papermc/paper/registry/RegistryKey.java
-@@ -0,0 +1,177 @@
+@@ -0,0 +1,179 @@
 +package io.papermc.paper.registry;
 +
 +import net.kyori.adventure.key.Keyed;
@@ -121,6 +121,7 @@ index 0000000000000000000000000000000000000000..1e2765d296decbb3e61b8434e78b5e02
 +import org.bukkit.potion.PotionEffectType;
 +import org.bukkit.potion.PotionType;
 +import org.jetbrains.annotations.ApiStatus;
++import org.jspecify.annotations.NullMarked;
 +
 +import static io.papermc.paper.registry.RegistryKeyImpl.create;
 +
@@ -137,6 +138,7 @@ index 0000000000000000000000000000000000000000..1e2765d296decbb3e61b8434e78b5e02
 + * @param <T> the value type
 + */
 +@SuppressWarnings("unused")
++@NullMarked
 +public sealed interface RegistryKey<T> extends Keyed permits RegistryKeyImpl {
 +
 +    /* ******************* *
@@ -268,19 +270,21 @@ index 0000000000000000000000000000000000000000..1e2765d296decbb3e61b8434e78b5e02
 +}
 diff --git a/src/main/java/io/papermc/paper/registry/RegistryKeyImpl.java b/src/main/java/io/papermc/paper/registry/RegistryKeyImpl.java
 new file mode 100644
-index 0000000000000000000000000000000000000000..791813220b2504214b1adecc69093cd600fb0f8c
+index 0000000000000000000000000000000000000000..80e3e64f47ac55a4978c9e5b430e2f2d1c871d1b
 --- /dev/null
 +++ b/src/main/java/io/papermc/paper/registry/RegistryKeyImpl.java
-@@ -0,0 +1,24 @@
+@@ -0,0 +1,26 @@
 +package io.papermc.paper.registry;
 +
 +import com.google.common.collect.Sets;
 +import java.util.Set;
 +import net.kyori.adventure.key.Key;
 +import org.intellij.lang.annotations.Subst;
-+import org.jetbrains.annotations.NotNull;
++import org.jspecify.annotations.NullMarked;
++import org.jspecify.annotations.Nullable;
 +
-+record RegistryKeyImpl<T>(@NotNull Key key) implements RegistryKey<T> {
++@NullMarked
++record RegistryKeyImpl<T>(Key key) implements RegistryKey<T> {
 +
 +    static final Set<RegistryKey<?>> REGISTRY_KEYS = Sets.newIdentityHashSet();
 +
@@ -298,23 +302,24 @@ index 0000000000000000000000000000000000000000..791813220b2504214b1adecc69093cd6
 +}
 diff --git a/src/main/java/io/papermc/paper/registry/TypedKey.java b/src/main/java/io/papermc/paper/registry/TypedKey.java
 new file mode 100644
-index 0000000000000000000000000000000000000000..6f5a062ba7ee7173468ecea3c1855a233bf3855e
+index 0000000000000000000000000000000000000000..cb2e1a4a6d583787573eeefab24e3188c43d148f
 --- /dev/null
 +++ b/src/main/java/io/papermc/paper/registry/TypedKey.java
-@@ -0,0 +1,44 @@
+@@ -0,0 +1,45 @@
 +package io.papermc.paper.registry;
 +
 +import net.kyori.adventure.key.Key;
 +import net.kyori.adventure.key.Keyed;
 +import org.jetbrains.annotations.ApiStatus;
-+import org.jetbrains.annotations.NotNull;
++import org.jspecify.annotations.NullMarked;
 +
 +/**
 + * Represents a key for a value in a specific registry.
 + *
 + * @param <T> the value type for the registry
 + */
 +@ApiStatus.Experimental
++@NullMarked
 +public sealed interface TypedKey<T> extends Keyed permits TypedKeyImpl {
 +
 +    /**
@@ -323,15 +328,15 @@ index 0000000000000000000000000000000000000000..6f5a062ba7ee7173468ecea3c1855a23
 +     * @return the value's key
 +     */
 +    @Override
-+    @NotNull Key key();
++    Key key();
 +
 +    /**
 +     * Gets the registry key for the value this key
 +     * represents.
 +     *
 +     * @return the registry key
 +     */
-+    @NotNull RegistryKey<T> registryKey();
++    RegistryKey<T> registryKey();
 +
 +    /**
 +     * Create a typed key from a key and a registry key.
@@ -342,23 +347,23 @@ index 0000000000000000000000000000000000000000..6f5a062ba7ee7173468ecea3c1855a23
 +     * @return a new key for the value key and registry key
 +     */
 +    @ApiStatus.Experimental
-+    static <T> @NotNull TypedKey<T> create(final @NotNull RegistryKey<T> registryKey, final @NotNull Key key) {
++    static <T> TypedKey<T> create(final RegistryKey<T> registryKey, final Key key) {
 +        return new TypedKeyImpl<>(key, registryKey);
 +    }
 +}
 diff --git a/src/main/java/io/papermc/paper/registry/TypedKeyImpl.java b/src/main/java/io/papermc/paper/registry/TypedKeyImpl.java
 new file mode 100644
-index 0000000000000000000000000000000000000000..1a97b3359c4ece5c29131da7c3f208aaa8fab66e
+index 0000000000000000000000000000000000000000..99375deaa6b90b33cd6a77e0df651236d304874e
 --- /dev/null
 +++ b/src/main/java/io/papermc/paper/registry/TypedKeyImpl.java
 @@ -0,0 +1,8 @@
 +package io.papermc.paper.registry;
 +
 +import net.kyori.adventure.key.Key;
-+import net.kyori.adventure.key.Keyed;
-+import org.jetbrains.annotations.NotNull;
++import org.jspecify.annotations.NullMarked;
 +
-+record TypedKeyImpl<T>(@NotNull Key key, @NotNull RegistryKey<T> registryKey) implements TypedKey<T> {
++@NullMarked
++record TypedKeyImpl<T>(Key key, RegistryKey<T> registryKey) implements TypedKey<T> {
 +}
 diff --git a/src/main/java/org/bukkit/MinecraftExperimental.java b/src/main/java/org/bukkit/MinecraftExperimental.java
 index a86b87e4c3332202e40e484c3f9c6562b419c70f..305532968f9f7dd497c77259ed147ea2f081bc74 100644

diff --git a/patches/api/0006-Adventure.patch b/patches/api/0006-Adventure.patch
@@ -91,23 +91,25 @@ index 3383fb91249ea53740326b538abd905f84ff0e3c..74f0e2b812c1e2e922b136fefe505fc8
      doLast {
 diff --git a/src/main/java/io/papermc/paper/chat/ChatRenderer.java b/src/main/java/io/papermc/paper/chat/ChatRenderer.java
 new file mode 100644
-index 0000000000000000000000000000000000000000..ffe0a921cc1ebbb95104f22b57e0e3af85e287a6
+index 0000000000000000000000000000000000000000..1288cdeafe587e9e78e7c5087742ea054ba8423d
 --- /dev/null
 +++ b/src/main/java/io/papermc/paper/chat/ChatRenderer.java
-@@ -0,0 +1,71 @@
+@@ -0,0 +1,70 @@
 +package io.papermc.paper.chat;
 +
 +import net.kyori.adventure.audience.Audience;
 +import net.kyori.adventure.text.Component;
 +import org.bukkit.entity.Player;
 +import org.jetbrains.annotations.ApiStatus;
-+import org.jetbrains.annotations.NotNull;
++import org.jspecify.annotations.NullMarked;
 +
 +/**
 + * A chat renderer is responsible for rendering chat messages sent by {@link Player}s to the server.
 + */
++@NullMarked
 +@FunctionalInterface
 +public interface ChatRenderer {
++
 +    /**
 +     * Renders a chat message. This will be called once for each receiving {@link Audience}.
 +     *
@@ -118,15 +120,13 @@ index 0000000000000000000000000000000000000000..ffe0a921cc1ebbb95104f22b57e0e3af
 +     * @return a rendered chat message
 +     */
 +    @ApiStatus.OverrideOnly
-+    @NotNull
-+    Component render(@NotNull Player source, @NotNull Component sourceDisplayName, @NotNull Component message, @NotNull Audience viewer);
++    Component render(Player source, Component sourceDisplayName, Component message, Audience viewer);
 +
 +    /**
 +     * Create a new instance of the default {@link ChatRenderer}.
 +     *
 +     * @return a new {@link ChatRenderer}
 +     */
-+    @NotNull
 +    static ChatRenderer defaultRenderer() {
 +        return new ViewerUnawareImpl.Default((source, sourceDisplayName, message) -> Component.translatable("chat.type.text", sourceDisplayName, message));
 +    }
@@ -142,8 +142,7 @@ index 0000000000000000000000000000000000000000..ffe0a921cc1ebbb95104f22b57e0e3af
 +     * @param renderer the viewer unaware renderer
 +     * @return a new {@link ChatRenderer}
 +     */
-+    @NotNull
-+    static ChatRenderer viewerUnaware(final @NotNull ViewerUnaware renderer) {
++    static ChatRenderer viewerUnaware(final ViewerUnaware renderer) {
 +        return new ViewerUnawareImpl(renderer);
 +    }
 +
@@ -153,6 +152,7 @@ index 0000000000000000000000000000000000000000..ffe0a921cc1ebbb95104f22b57e0e3af
 +     * @see ChatRenderer#viewerUnaware(ViewerUnaware)
 +     */
 +    interface ViewerUnaware {
++
 +        /**
 +         * Renders a chat message.
 +         *
@@ -162,24 +162,26 @@ index 0000000000000000000000000000000000000000..ffe0a921cc1ebbb95104f22b57e0e3af
 +         * @return a rendered chat message
 +         */
 +        @ApiStatus.OverrideOnly
-+        @NotNull
-+        Component render(@NotNull Player source, @NotNull Component sourceDisplayName, @NotNull Component message);
++        Component render(Player source, Component sourceDisplayName, Component message);
 +    }
 +}
 diff --git a/src/main/java/io/papermc/paper/chat/ViewerUnawareImpl.java b/src/main/java/io/papermc/paper/chat/ViewerUnawareImpl.java
 new file mode 100644
-index 0000000000000000000000000000000000000000..2ad76b1751ba707f7ae0d283aa1cbaf6c9619da9
+index 0000000000000000000000000000000000000000..e1ef23b4bdf60a299d6d37099cef777b3de13ac7
 --- /dev/null
 +++ b/src/main/java/io/papermc/paper/chat/ViewerUnawareImpl.java
-@@ -0,0 +1,35 @@
+@@ -0,0 +1,38 @@
 +package io.papermc.paper.chat;
 +
 +import net.kyori.adventure.audience.Audience;
 +import net.kyori.adventure.text.Component;
 +import org.bukkit.entity.Player;
-+import org.jetbrains.annotations.NotNull;
-+import org.jetbrains.annotations.Nullable;
++import org.jetbrains.annotations.ApiStatus;
++import org.jspecify.annotations.NullMarked;
++import org.jspecify.annotations.Nullable;
 +
++@ApiStatus.Internal
++@NullMarked
 +sealed class ViewerUnawareImpl implements ChatRenderer, ChatRenderer.ViewerUnaware permits ViewerUnawareImpl.Default {
 +    private final ViewerUnaware unaware;
 +    private @Nullable Component message;
@@ -189,12 +191,12 @@ index 0000000000000000000000000000000000000000..2ad76b1751ba707f7ae0d283aa1cbaf6
 +    }
 +
 +    @Override
-+    public @NotNull Component render(final @NotNull Player source, final @NotNull Component sourceDisplayName, final @NotNull Component message, final @NotNull Audience viewer) {
++    public Component render(final Player source, final Component sourceDisplayName, final Component message, final Audience viewer) {
 +        return this.render(source, sourceDisplayName, message);
 +    }
 +
 +    @Override
-+    public @NotNull Component render(final @NotNull Player source, final @NotNull Component sourceDisplayName, final @NotNull Component message) {
++    public Component render(final Player source, final Component sourceDisplayName, final Component message) {
 +        if (this.message == null) {
 +            this.message = this.unaware.render(source, sourceDisplayName, message);
 +        }
@@ -579,12 +581,13 @@ index 0000000000000000000000000000000000000000..42a82ce2316a4aad2883d24c7e2ff95d
 +}
 diff --git a/src/main/java/io/papermc/paper/text/PaperComponents.java b/src/main/java/io/papermc/paper/text/PaperComponents.java
 new file mode 100644
-index 0000000000000000000000000000000000000000..1a11cfde07db55194cd26757863a268b9042d0bb
+index 0000000000000000000000000000000000000000..934d1d3ca490a8e25c438bc8c57eb6bde50e0147
 --- /dev/null
 +++ b/src/main/java/io/papermc/paper/text/PaperComponents.java
-@@ -0,0 +1,177 @@
+@@ -0,0 +1,180 @@
 +package io.papermc.paper.text;
 +
++import java.io.IOException;
 +import net.kyori.adventure.text.Component;
 +import net.kyori.adventure.text.flattener.ComponentFlattener;
 +import net.kyori.adventure.text.format.NamedTextColor;
@@ -595,15 +598,15 @@ index 0000000000000000000000000000000000000000..1a11cfde07db55194cd26757863a268b
 +import org.bukkit.Bukkit;
 +import org.bukkit.command.CommandSender;
 +import org.bukkit.entity.Entity;
-+import org.jetbrains.annotations.NotNull;
-+import org.jetbrains.annotations.Nullable;
-+
-+import java.io.IOException;
++import org.jspecify.annotations.NullMarked;
++import org.jspecify.annotations.Nullable;
 +
 +/**
 + * Paper API-specific methods for working with {@link Component}s and related.
 + */
++@NullMarked
 +public final class PaperComponents {
++
 +    private PaperComponents() {
 +        throw new RuntimeException("PaperComponents is not to be instantiated!");
 +    }
@@ -633,7 +636,7 @@ index 0000000000000000000000000000000000000000..1a11cfde07db55194cd26757863a268b
 +     * @return the resolved component
 +     * @throws IOException if a syntax error tripped during resolving
 +     */
-+    public static @NotNull Component resolveWithContext(@NotNull Component input, @Nullable CommandSender context, @Nullable Entity scoreboardSubject) throws IOException {
++    public static Component resolveWithContext(final Component input, final @Nullable CommandSender context, final @Nullable Entity scoreboardSubject) throws IOException {
 +        return resolveWithContext(input, context, scoreboardSubject, true);
 +    }
 +
@@ -664,7 +667,8 @@ index 0000000000000000000000000000000000000000..1a11cfde07db55194cd26757863a268b
 +     * @return the resolved component
 +     * @throws IOException if a syntax error tripped during resolving
 +     */
-+    public static @NotNull Component resolveWithContext(@NotNull Component input, @Nullable CommandSender context, @Nullable Entity scoreboardSubject, boolean bypassPermissions) throws IOException {
++    @SuppressWarnings("deprecation") // using unsafe as a bridge
++    public static Component resolveWithContext(final Component input, final @Nullable CommandSender context, final @Nullable Entity scoreboardSubject, final boolean bypassPermissions) throws IOException {
 +        return Bukkit.getUnsafe().resolveWithContext(input, context, scoreboardSubject, bypassPermissions);
 +    }
 +
@@ -673,7 +677,8 @@ index 0000000000000000000000000000000000000000..1a11cfde07db55194cd26757863a268b
 +     *
 +     * @return a component flattener
 +     */
-+    public static @NotNull ComponentFlattener flattener() {
++    @SuppressWarnings("deprecation") // using unsafe as a bridge
++    public static ComponentFlattener flattener() {
 +        return Bukkit.getUnsafe().componentFlattener();
 +    }
 +
@@ -688,7 +693,7 @@ index 0000000000000000000000000000000000000000..1a11cfde07db55194cd26757863a268b
 +     * @deprecated will be removed in adventure 5.0.0, use {@link PlainTextComponentSerializer#plainText()}
 +     */
 +    @Deprecated(forRemoval = true, since = "1.18.1")
-+    public static @NotNull PlainComponentSerializer plainSerializer() {
++    public static PlainComponentSerializer plainSerializer() {
 +        return Bukkit.getUnsafe().plainComponentSerializer();
 +    }
 +
@@ -703,7 +708,7 @@ index 0000000000000000000000000000000000000000..1a11cfde07db55194cd26757863a268b
 +     * @deprecated use {@link PlainTextComponentSerializer#plainText()}
 +     */
 +    @Deprecated(forRemoval = true, since = "1.18.2")
-+    public static @NotNull PlainTextComponentSerializer plainTextSerializer() {
++    public static PlainTextComponentSerializer plainTextSerializer() {
 +        return Bukkit.getUnsafe().plainTextSerializer();
 +    }
 +
@@ -719,7 +724,7 @@ index 0000000000000000000000000000000000000000..1a11cfde07db55194cd26757863a268b
 +     * @deprecated use {@link GsonComponentSerializer#gson()}
 +     */
 +    @Deprecated(forRemoval = true, since = "1.18.2")
-+    public static @NotNull GsonComponentSerializer gsonSerializer() {
++    public static GsonComponentSerializer gsonSerializer() {
 +        return Bukkit.getUnsafe().gsonComponentSerializer();
 +    }
 +
@@ -736,7 +741,7 @@ index 0000000000000000000000000000000000000000..1a11cfde07db55194cd26757863a268b
 +     * @deprecated use {@link GsonComponentSerializer#colorDownsamplingGson()}
 +     */
 +    @Deprecated(forRemoval = true, since = "1.18.2")
-+    public static @NotNull GsonComponentSerializer colorDownsamplingGsonSerializer() {
++    public static GsonComponentSerializer colorDownsamplingGsonSerializer() {
 +        return Bukkit.getUnsafe().colorDownsamplingGsonComponentSerializer();
 +    }
 +
@@ -756,7 +761,7 @@ index 0000000000000000000000000000000000000000..1a11cfde07db55194cd26757863a268b
 +     * @deprecated use {@link LegacyComponentSerializer#legacySection()}
 +     */
 +    @Deprecated(forRemoval = true, since = "1.18.2")
-+    public static @NotNull LegacyComponentSerializer legacySectionSerializer() {
++    public static LegacyComponentSerializer legacySectionSerializer() {
 +        return Bukkit.getUnsafe().legacyComponentSerializer();
 +    }
 +}