Fix Registry#getKey implementation

2024-12-21 14:56:01 -08:00
parent 54debf494f
commit 46c6f497c7
13 changed files with 164 additions and 277 deletions
--- a/paper-server/src/main/java/io/papermc/paper/util/OldEnumHolderable.java
+++ b/paper-server/src/main/java/io/papermc/paper/util/OldEnumHolderable.java
@@ -0,0 +1,88 @@
+package io.papermc.paper.util;
+
+import com.google.common.base.Preconditions;
+import java.util.Locale;
+import net.minecraft.core.Holder;
+import org.bukkit.Keyed;
+import org.bukkit.NamespacedKey;
+import org.bukkit.util.OldEnum;
+import org.jspecify.annotations.NullMarked;
+import org.jspecify.annotations.Nullable;
+
+@SuppressWarnings("removal")
+@Deprecated
+@NullMarked
+public abstract class OldEnumHolderable<A extends OldEnum<A>, M> implements Holderable<M>, OldEnum<A>, Keyed {
+
+    private final Holder<M> holder;
+    private final int ordinal;
+    private final @Nullable String name;
+
+    protected OldEnumHolderable(final Holder<M> holder, final int ordinal) {
+        this.holder = holder;
+        this.ordinal = ordinal;
+        if (holder instanceof final Holder.Reference<M> reference) {
+            // For backwards compatibility, minecraft values will stile return the uppercase name without the namespace,
+            // in case plugins use for example the name as key in a config file to receive registry item specific values.
+            // Custom registry items will return the key with namespace. For a plugin this should look than like a new registry item
+            // (which can always be added in new minecraft versions and the plugin should therefore handle it accordingly).
+            if (NamespacedKey.MINECRAFT.equals(reference.key().location().getNamespace())) {
+                this.name = reference.key().location().getPath().toUpperCase(Locale.ROOT);
+            } else {
+                this.name = reference.key().location().toString();
+            }
+        } else {
+            this.name = null;
+        }
+    }
+
+    @Override
+    public Holder<M> getHolder() {
+        return this.holder;
+    }
+
+    @Override
+    @Deprecated
+    public int compareTo(A other) {
+        this.checkIsReference();
+        return this.ordinal - other.ordinal();
+    }
+
+    @Override
+    @Deprecated
+    public String name() {
+        this.checkIsReference();
+        return this.name;
+    }
+
+    @Override
+    @Deprecated
+    public int ordinal() {
+        this.checkIsReference();
+        return this.ordinal;
+    }
+
+    private void checkIsReference() {
+        Preconditions.checkState(this.holder.kind() == Holder.Kind.REFERENCE, "Cannot call method for this registry item, because it is not registered.");
+    }
+
+    @Override
+    public NamespacedKey getKey() {
+        return MCUtil.fromResourceKey(this.holder.unwrapKey().orElseThrow(() -> new IllegalStateException("Cannot get key for this registry item, because it is not registered.")));
+    }
+
+    @Override
+    public boolean equals(final Object obj) {
+        return this.implEquals(obj);
+    }
+
+    @Override
+    public int hashCode() {
+        return this.implHashCode();
+    }
+
+    @Override
+    public String toString() {
+        return this.implToString();
+    }
+}