API methods PacketHandler#of

PacketEvents support

Author: Jsinco

build.gradle.kts

@@ -12,7 +12,7 @@ allprojects {
     apply(plugin = "com.gradleup.shadow")
 
     group = "me.outspending.biomesapi"
-    version = "0.0.18"
+    version = "0.0.19"
 
     tasks.withType<JavaCompile> {
         options.encoding = "UTF-8"

main/src/main/java/me/outspending/biomesapi/annotations/AsOf.java

@@ -1,5 +1,7 @@
 package me.outspending.biomesapi.annotations;
 
+import org.jetbrains.annotations.ApiStatus;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -21,6 +23,7 @@
  *
  * In the above example, the {@code someApiMethod} method has been present or modified since version 1.0.
  */
+@ApiStatus.Internal
 @Retention(RetentionPolicy.RUNTIME)
 @Target({
         ElementType.METHOD,

main/src/main/java/me/outspending/biomesapi/annotations/Experimental.java

@@ -1,5 +1,7 @@
 package me.outspending.biomesapi.annotations;
 
+import org.jetbrains.annotations.ApiStatus;
+
 import java.lang.annotation.ElementType;
 import java.lang.annotation.Retention;
 import java.lang.annotation.RetentionPolicy;
@@ -11,7 +13,12 @@
  * This annotation can be applied to methods, types, constructors, modules, and packages.
  *
  * @version 0.0.1
+ * @since 0.0.1
+ * @author Outspending
+ * @deprecated Use {@link org.jetbrains.annotations.ApiStatus.Experimental} instead
  */
+@ApiStatus.Internal
+@Deprecated(since = "0.0.19", forRemoval = true)
 @Retention(RetentionPolicy.RUNTIME)
 @Target({
         ElementType.METHOD,

main/src/main/java/me/outspending/biomesapi/exceptions/MissingPacketLibraryException.java

@@ -0,0 +1,24 @@
+package me.outspending.biomesapi.exceptions;
+
+import me.outspending.biomesapi.annotations.AsOf;
+
+/**
+ * Exception thrown when the required packet library is missing.
+ *
+ * @version 0.0.19
+ * @since 0.0.6
+ * @author Jsinco
+ */
+@AsOf("0.0.6")
+public class MissingPacketManipulatorLibraryException extends RuntimeException {
+
+    @AsOf("0.0.19")
+    public MissingPacketManipulatorLibraryException(String message) {
+        super(message);
+    }
+
+    @AsOf("0.0.6")
+    public MissingPacketManipulatorLibraryException(String message, Throwable cause) {
+        super(message, cause);
+    }
+}

main/src/main/java/me/outspending/biomesapi/exceptions/MissingPacketManipulatorLibraryException.java

@@ -1,8 +1,9 @@
 package me.outspending.biomesapi.packet;
 
 import me.outspending.biomesapi.annotations.AsOf;
-import me.outspending.biomesapi.exceptions.MissingPacketLibraryException;
+import me.outspending.biomesapi.exceptions.MissingPacketManipulatorLibraryException;
 import me.outspending.biomesapi.packet.data.PhonyCustomBiome;
+import me.outspending.biomesapi.packet.handlers.PacketEventsPacketHandler;
 import me.outspending.biomesapi.packet.handlers.ProtocolLibPacketHandler;
 import me.outspending.biomesapi.registry.BiomeResourceKey;
 import org.bukkit.World;
@@ -19,13 +20,12 @@
  * An external packet handling library (either ProtocolLib or PacketEvents) is required
  * for this interface.
  * </p>
- * @version 0.0.10
+ * @version 0.0.19
  * @since 0.0.6
  * @author Jsinco
  */
-@me.outspending.biomesapi.annotations.Experimental
 @ApiStatus.Experimental
-@AsOf("0.0.10")
+@AsOf("0.0.19")
 public interface PacketHandler {
 
 
@@ -34,25 +34,40 @@ public interface PacketHandler {
      * The packet listener priority defaults to NORMAL.
      * @param provider The plugin providing this PacketHandler
      * @return A new PacketHandler instance
+     * @since 0.0.6
+     * @throws MissingPacketManipulatorLibraryException if ProtocolLib is not installed
+     * @deprecated use {@link #of(Plugin, Manipulator)} or {@link #of(Plugin, Manipulator, Priority)} instead
      */
+    @Deprecated(since = "0.0.19")
     @AsOf("0.0.6")
     static @NotNull PacketHandler of(@NotNull Plugin provider) {
-        return of(provider, Priority.NORMAL);
+        return of(provider, Manipulator.PROTOCOLLIB, Priority.NORMAL);
+    }
+
+    /**
+     * Creates a PacketHandler using ProtocolLib as the underlying packet manipulation library.
+     * The packet listener priority defaults to NORMAL.
+     * @param provider The plugin providing this PacketHandler
+     * @return A new PacketHandler instance
+     * @since 0.0.19
+     * @throws MissingPacketManipulatorLibraryException if the specified manipulator library is not installed
+     */
+    @AsOf("0.0.19")
+    static @NotNull PacketHandler of(@NotNull Plugin provider, @NotNull Manipulator manipulator) {
+        return of(provider, manipulator, Priority.NORMAL);
     }
 
     /**
      * Creates a PacketHandler using ProtocolLib as the underlying packet manipulation library.
      * @param provider The plugin providing this PacketHandler
      * @param priority The priority of the packet listener
      * @return A new PacketHandler instance
+     * @since 0.0.6
+     * @throws MissingPacketManipulatorLibraryException if the specified manipulator library is not installed
      */
-    @AsOf("0.0.6")
-    static @NotNull PacketHandler of(@NotNull Plugin provider, @NotNull PacketHandler.Priority priority) {
-        try {
-            return new ProtocolLibPacketHandler(provider, priority);
-        } catch (ClassNotFoundException e) {
-            throw new MissingPacketLibraryException("Could not find ProtocolLib classes. Please ensure ProtocolLib is installed.", e);
-        }
+    @AsOf("0.0.19")
+    static @NotNull PacketHandler of(@NotNull Plugin provider, @NotNull Manipulator manipulator, @NotNull PacketHandler.Priority priority) {
+        return manipulator.create(provider, priority);
     }
 
     /**
@@ -214,4 +229,61 @@ public int getLevel() {
 
     }
 
+    /**
+     * Enum constant for supported packet manipulation libraries.
+     * @version 0.0.19
+     * @since 0.0.19
+     */
+    @AsOf("0.0.19")
+    enum Manipulator {
+        PROTOCOLLIB(
+                "ProtocolLib",
+                "com.comphenix.protocol.ProtocolLibrary",
+                (provider, priority) -> new ProtocolLibPacketHandler(provider, priority)
+        ),
+        PACKETEVENTS(
+                "PacketEvents",
+                "com.github.retrooper.packetevents.PacketEvents",
+                (provider, priority) -> new PacketEventsPacketHandler(priority)
+        );
+
+        private final String name;
+        private final String owningClass;
+        private final PacketHandlerFactory factory;
+
+        Manipulator(String name, String owningClass, PacketHandlerFactory factory) {
+            this.name = name;
+            this.owningClass = owningClass;
+            this.factory = factory;
+        }
+
+        public String getName() {
+            return name;
+        }
+
+        public String getOwningClass() {
+            return owningClass;
+        }
+
+        public boolean isAvailable() {
+            try {
+                Class.forName(owningClass);
+                return true;
+            } catch (ClassNotFoundException e) {
+                return false;
+            }
+        }
+
+        public PacketHandler create(@NotNull Plugin provider, @NotNull PacketHandler.Priority priority) throws MissingPacketManipulatorLibraryException {
+            if (!isAvailable()) {
+                throw new MissingPacketManipulatorLibraryException("Could not find required classes for " + name + ". Please ensure " + name + " is installed.");
+            }
+            return factory.create(provider, priority);
+        }
+
+        @FunctionalInterface
+        private interface PacketHandlerFactory {
+            @NotNull PacketHandler create(@NotNull Plugin provider, @NotNull PacketHandler.Priority priority);
+        }
+    }
 }

main/src/main/java/me/outspending/biomesapi/packet/PacketHandler.java

@@ -21,7 +21,6 @@
  * @since 0.0.6
  * @author Jsinco
  */
-@me.outspending.biomesapi.annotations.Experimental
 @ApiStatus.Experimental
 @AsOf("0.0.6")
 public class PhonyCustomBiomeCollector {

main/src/main/java/me/outspending/biomesapi/packet/PhonyCustomBiomeCollector.java

@@ -19,21 +19,23 @@
 import org.bukkit.craftbukkit.CraftServer;
 import org.bukkit.craftbukkit.block.CraftBiome;
 import org.bukkit.craftbukkit.util.CraftMagicNumbers;
+import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
 import java.lang.reflect.Field;
 
 /**
  * Internal helper class for packet handling related to chunk data and biome modification.
  *
- * @version 0.0.6
+ * @version 0.0.19
  * @since 0.0.6
  * @author Jsinco
  */
-@AsOf("0.0.6")
-class PacketHandlerHelper {
+@AsOf("0.0.19")
+@ApiStatus.Internal
+class NativeMinecraftPacketHandlerHelper {
 
-    static PacketHandlerHelper INSTANCE = new PacketHandlerHelper();
+    static NativeMinecraftPacketHandlerHelper INSTANCE = new NativeMinecraftPacketHandlerHelper();
 
     static int CHUNK_SECTION_SIZE = 16; // Each chunk section is 16x16x16 blocks
     static int CHUNK_SECTIONS = 4; // Each chunk section has 4x4x4 = 64 biome entries