v0.3.0 - Add task consumers & Better platform detection

Author: TechnicallyCoded

build.gradle

@@ -7,7 +7,7 @@ buildscript {
 allprojects {
     apply plugin: 'java'
 
-    version = '0.2.6'
+    version = '0.3.0'
 
     repositories {
 

common/src/main/java/com/tcoded/folialib/FoliaLib.java

@@ -1,11 +1,10 @@
 package com.tcoded.folialib;
 
 import com.tcoded.folialib.enums.ImplementationType;
-import com.tcoded.folialib.impl.*;
+import com.tcoded.folialib.impl.ServerImplementation;
 import org.bukkit.plugin.java.JavaPlugin;
 
 import java.lang.reflect.InvocationTargetException;
-import java.util.List;
 import java.util.logging.Logger;
 
 public class FoliaLib {
@@ -20,39 +19,18 @@ public FoliaLib(JavaPlugin plugin) {
 
         // Find the implementation type based on the class names
         ImplementationType foundType = ImplementationType.UNKNOWN;
-        typeLoop:
+
         for (ImplementationType type : ImplementationType.values()) {
-            String[] classNames = type.getClassNames();
-
-            // Check if any of the class names are present
-            for (String className : classNames) {
-                try {
-                    // Try to load the class
-                    Class.forName(className);
-
-                    // Found the server type, remember that and break the loop
-                    foundType = type;
-                    break typeLoop;
-                } catch (ClassNotFoundException ignored) {}
-            }
+            // Implementation is not suited for this server
+            if (!type.selfCheck()) continue;
+            // Found implementation match
+            foundType = type;
+            break;
         }
 
         // Apply the implementation based on the type
         this.implementationType = foundType;
-        switch (foundType) {
-            case FOLIA:
-                this.implementation = this.createServerImpl("FoliaImplementation");
-                break;
-            case PAPER:
-                this.implementation = this.createServerImpl("PaperImplementation");
-                break;
-            case SPIGOT:
-                this.implementation = this.createServerImpl("SpigotImplementation");
-                break;
-            default:
-                this.implementation = this.createServerImpl("UnsupportedImplementation");
-                break;
-        }
+        this.implementation = this.createServerImpl(this.implementationType.getImplementationClassName());
 
         // Check for valid implementation
         if (this.implementation == null) {
@@ -76,7 +54,7 @@ public FoliaLib(JavaPlugin plugin) {
     }
 
     private ServerImplementation createServerImpl(String implName) {
-        String basePackage = "com.tcoded.folialib.impl.";
+        String basePackage = this.getClass().getPackage().getName() + ".impl.";
 
         try {
             return (ServerImplementation) Class.forName(basePackage + implName)

common/src/main/java/com/tcoded/folialib/enums/ImplementationType.java

@@ -1,23 +1,97 @@
 package com.tcoded.folialib.enums;
 
+import com.tcoded.folialib.impl.ServerImplementation;
+import com.tcoded.folialib.util.ImplementationTestsUtil;
+
+import java.util.function.Consumer;
+import java.util.function.Supplier;
+
+/**
+ * This enum is used to determine the server implementation type.
+ * <p>
+ * The enum is ordered by PRIORITY. The first implementation that passes all tests will be used.
+ * <p>
+ * A server is considered 'legacy' if it does not support task consumers. This feature was added in 1.13.2.
+ * This means that event 1.13.1 servers are considered legacy servers as they do not support highly important
+ * features that developers may want to use. Refer to {@link ServerImplementation#runLater(Consumer, long)}
+ * for more information on the behavior of task consumer-enabled methods on servers which do not support this feature.
+ */
+@SuppressWarnings("SpellCheckingInspection")
 public enum ImplementationType {
 
-    // Ordered by priority
-    @SuppressWarnings("SpellCheckingInspection")
-    FOLIA ("io.papermc.paper.threadedregions.RegionizedServer"),
-    @SuppressWarnings("SpellCheckingInspection")
-    PAPER ("com.destroystokyo.paper.PaperConfig", "io.papermc.paper.configuration.Configuration"),
-    @SuppressWarnings("SpellCheckingInspection")
-    SPIGOT ("org.spigotmc.SpigotConfig"),
-    UNKNOWN;
+    FOLIA (
+            "FoliaImplementation",
+            new Supplier[0],
+            "io.papermc.paper.threadedregions.RegionizedServer"
+    ),
+    PAPER (
+            "PaperImplementation",
+            new Supplier[] {ImplementationTestsUtil::isTaskConsumersSupported},
+            "com.destroystokyo.paper.PaperConfig", "io.papermc.paper.configuration.Configuration"
+    ),
+    LEGACY_PAPER (
+            "LegacyPaperImplementation",
+            new Supplier[0],
+            "com.destroystokyo.paper.PaperConfig", "io.papermc.paper.configuration.Configuration"
+    ),
+    SPIGOT (
+            "SpigotImplementation",
+            new Supplier[] {ImplementationTestsUtil::isTaskConsumersSupported},
+            "org.spigotmc.SpigotConfig"
+    ),
+    LEGACY_SPIGOT (
+            "LegacySpigotImplementation",
+            new Supplier[0],
+            "org.spigotmc.SpigotConfig"
+    ),
+    UNKNOWN (
+            "UnsupportedImplementation",
+            new Supplier[0]
+    );
 
+    private final String implementationClassName;
+    private final Supplier<Boolean>[] tests;
     private final String[] classNames;
 
-    ImplementationType(String... classNames) {
+    ImplementationType(String implementationClassName, Supplier<Boolean>[] tests, String... classNames) {
+        this.implementationClassName = implementationClassName;
+        this.tests = tests;
         this.classNames = classNames;
     }
 
+    public String getImplementationClassName() {
+        return implementationClassName;
+    }
+
+    public Supplier<Boolean>[] getTests() {
+        return tests;
+    }
+
     public String[] getClassNames() {
         return classNames;
     }
+
+    public boolean selfCheck() {
+        // Run self-tests
+        for (Supplier<Boolean> test : this.getTests()) {
+            if (!test.get()) return false;
+        }
+
+        // Self-test for class names
+        String[] classNames = this.getClassNames();
+
+        // Check if any of the class names are present
+        for (String className : classNames) {
+            try {
+                // Try to load the class
+                Class.forName(className);
+
+                // Found the server type, remember that and break the loop
+                return true;
+            } catch (ClassNotFoundException ignored) {}
+        }
+
+        return false;
+    }
 }
+

common/src/main/java/com/tcoded/folialib/util/ImplementationTestsUtil.java

@@ -0,0 +1,49 @@
+package com.tcoded.folialib.util;
+
+import org.bukkit.plugin.Plugin;
+import org.bukkit.scheduler.BukkitScheduler;
+import org.bukkit.scheduler.BukkitTask;
+
+import java.util.function.Consumer;
+
+public class ImplementationTestsUtil {
+
+    private static final boolean IS_CANCELLED_SUPPORTED;
+    private static final boolean IS_TASK_CONSUMERS_SUPPORTED;
+
+
+    static {
+        boolean isCancelledSupported = false;
+        try {
+            Class<BukkitTask> bukkitTaskClass = BukkitTask.class;
+            // noinspection JavaReflectionMemberAccess
+            bukkitTaskClass.getDeclaredMethod("isCancelled");
+            isCancelledSupported = true;
+        } catch (NoSuchMethodException e) {
+            // ignore
+        }
+        // Set class-wide
+        IS_CANCELLED_SUPPORTED = isCancelledSupported;
+
+        boolean taskConsumersSupported = false;
+        try {
+            Class<BukkitScheduler> bukkitSchedulerClass = BukkitScheduler.class;
+            // noinspection JavaReflectionMemberAccess
+            bukkitSchedulerClass.getDeclaredMethod("runTask", Plugin.class, Consumer.class);
+            taskConsumersSupported = true;
+        } catch (NoSuchMethodException e) {
+            // ignore
+        }
+        // Set class-wide
+        IS_TASK_CONSUMERS_SUPPORTED = taskConsumersSupported;
+    }
+
+    public static boolean isCancelledSupported() {
+        return IS_CANCELLED_SUPPORTED;
+    }
+
+    public static boolean isTaskConsumersSupported() {
+        return IS_TASK_CONSUMERS_SUPPORTED;
+    }
+
+}

common/src/main/java/com/tcoded/folialib/util/TimeConverter.java

@@ -8,7 +8,7 @@ public static long toTicks(long time, TimeUnit unit) {
         return unit.toMillis(time) / 50;
     }
 
-    public static long toMillis(long delay) {
-        return delay * 50L;
+    public static long toMillis(long ticks) {
+        return ticks * 50L;
     }
 }