Add Position, Scheduler.

Author: vLuckyyy

commons-adventure/build.gradle.kts

@@ -7,6 +7,7 @@ plugins {
 
 
 dependencies {
+    api(project(":commons-shared"))
     api("net.kyori:adventure-api:4.15.0")
     api("net.kyori:adventure-text-minimessage:4.15.0")
     api("net.kyori:adventure-text-serializer-legacy:4.15.0")

commons-shared-bukkit/build.gradle.kts

@@ -7,6 +7,7 @@ plugins {
 
 
 dependencies {
+    api(project(":commons-shared"))
     api("org.spigotmc:spigot-api:1.19.4-R0.1-SNAPSHOT")
     api("net.kyori:adventure-api:4.15.0")
 }

commons-shared-bukkit/src/main/java/com/eternalcode/commons/shared/bukkit/position/Position.java

@@ -1,60 +1,19 @@
 package com.eternalcode.commons.shared.bukkit.position;
 
-import java.util.Objects;
 import java.util.regex.Matcher;
 import java.util.regex.Pattern;
 
 /**
  * Disclaimer - Bukkit {@link org.bukkit.Location} storage may cause a memory leak, because it is a wrapper for
  * coordinates and {@link org.bukkit.World} reference. If you need to store location use {@link Position} and
  * {@link PositionAdapter}.
- * */
-public final class Position {
+ */
+public record Position(double x, double y, double z, float yaw, float pitch, String world) {
 
     public static final String NONE_WORLD = "__NONE__";
 
-    private static final Pattern PARSE_FORMAT = Pattern.compile("Position\\{x=(?<x>-?[\\d.]+), y=(?<y>-?[\\d.]+), z=(?<z>-?[\\d.]+), yaw=(?<yaw>-?[\\d.]+), pitch=(?<pitch>-?[\\d.]+), world='(?<world>.+)'}");
-
-    private final double x;
-    private final double y;
-    private final double z;
-    private final float yaw;
-    private final float pitch;
-    private final String world;
-
-
-    public Position(double x, double y, double z, float yaw, float pitch, String world) {
-        this.x = x;
-        this.y = y;
-        this.z = z;
-        this.yaw = yaw;
-        this.pitch = pitch;
-        this.world = world;
-    }
-
-    public String getWorld() {
-        return this.world;
-    }
-
-    public double getX() {
-        return this.x;
-    }
-
-    public double getY() {
-        return this.y;
-    }
-
-    public double getZ() {
-        return this.z;
-    }
-
-    public float getYaw() {
-        return this.yaw;
-    }
-
-    public float getPitch() {
-        return this.pitch;
-    }
+    private static final Pattern PARSE_FORMAT = Pattern.compile(
+        "Position\\{x=(?<x>-?[\\d.]+), y=(?<y>-?[\\d.]+), z=(?<z>-?[\\d.]+), yaw=(?<yaw>-?[\\d.]+), pitch=(?<pitch>-?[\\d.]+), world='(?<world>.+)'}");
 
     public boolean isNoneWorld() {
         return this.world.equals(NONE_WORLD);
@@ -80,11 +39,6 @@ public boolean equals(Object o) {
             && this.world.equals(position.world);
     }
 
-    @Override
-    public int hashCode() {
-        return Objects.hash(this.x, this.y, this.z, this.yaw, this.pitch, this.world);
-    }
-
     @Override
     public String toString() {
         return "Position{" +

commons-shared-bukkit/src/main/java/com/eternalcode/commons/shared/bukkit/position/PositionAdapter.java

@@ -23,18 +23,18 @@ public static Position convert(Location location) {
     }
 
     public static Location convert(Position position) {
-        World world = Bukkit.getWorld(position.getWorld());
+        World world = Bukkit.getWorld(position.world());
 
         if (world == null) {
             throw new IllegalStateException("World is not defined");
         }
 
         return new Location(
             world,
-            position.getX(),
-            position.getY(),
-            position.getZ(),
-            position.getYaw(),
-            position.getPitch());
+            position.x(),
+            position.y(),
+            position.z(),
+            position.yaw(),
+            position.pitch());
     }
 }

commons-shared-bukkit/src/main/java/com/eternalcode/commons/shared/bukkit/scheduler/BukkitSchedulerImpl.java

@@ -0,0 +1,70 @@
+package com.eternalcode.commons.shared.bukkit.scheduler;
+
+import com.eternalcode.commons.shared.scheduler.Scheduler;
+import com.eternalcode.commons.shared.scheduler.Task;
+import java.util.concurrent.CompletableFuture;
+import org.bukkit.plugin.Plugin;
+import org.bukkit.scheduler.BukkitScheduler;
+
+import java.time.Duration;
+import java.util.function.Supplier;
+
+public class BukkitSchedulerImpl implements Scheduler {
+
+    private final Plugin plugin;
+    private final BukkitScheduler rootScheduler;
+
+    public BukkitSchedulerImpl(Plugin plugin) {
+        this.plugin = plugin;
+        this.rootScheduler = plugin.getServer().getScheduler();
+    }
+
+    @Override
+    public Task sync(Runnable task) {
+        return new BukkitTaskImpl(this.rootScheduler.runTask(this.plugin, task));
+    }
+
+    @Override
+    public Task async(Runnable task) {
+        return new BukkitTaskImpl(this.rootScheduler.runTaskAsynchronously(this.plugin, task));
+    }
+
+    @Override
+    public Task laterSync(Runnable task, Duration delay) {
+        return new BukkitTaskImpl(this.rootScheduler.runTaskLater(this.plugin, task, this.toTick(delay)));
+    }
+
+    @Override
+    public Task laterAsync(Runnable task, Duration delay) {
+        return new BukkitTaskImpl(this.rootScheduler.runTaskLaterAsynchronously(this.plugin, task, this.toTick(delay)));
+    }
+
+    @Override
+    public Task timerSync(Runnable task, Duration delay, Duration period) {
+        return new BukkitTaskImpl(this.rootScheduler.runTaskTimer(this.plugin, task, this.toTick(delay), this.toTick(period)));
+    }
+
+    @Override
+    public Task timerAsync(Runnable task, Duration delay, Duration period) {
+        return new BukkitTaskImpl(this.rootScheduler.runTaskTimerAsynchronously(this.plugin, task, this.toTick(delay), this.toTick(period)));
+    }
+
+    @Override
+    public <T> CompletableFuture<T> completeSync(Supplier<T> task) {
+        CompletableFuture<T> completable = new CompletableFuture<>();
+        this.rootScheduler.runTask(this.plugin, () -> completable.complete(task.get()));
+        return completable;
+    }
+
+    @Override
+    public <T> CompletableFuture<T> completeAsync(Supplier<T> task) {
+        CompletableFuture<T> completable = new CompletableFuture<>();
+        this.rootScheduler.runTaskAsynchronously(this.plugin, () -> completable.complete(task.get()));
+        return completable;
+    }
+
+    private long toTick(Duration duration) {
+        return duration.toMillis() / 50L;
+    }
+
+}

commons-shared-bukkit/src/main/java/com/eternalcode/commons/shared/bukkit/scheduler/BukkitTaskImpl.java

@@ -0,0 +1,29 @@
+package com.eternalcode.commons.shared.bukkit.scheduler;
+
+import com.eternalcode.commons.shared.scheduler.Task;
+import org.bukkit.scheduler.BukkitTask;
+
+class BukkitTaskImpl implements Task {
+
+    private final BukkitTask rootTask;
+
+    BukkitTaskImpl(BukkitTask rootTask) {
+        this.rootTask = rootTask;
+    }
+
+    @Override
+    public void cancel() {
+        this.rootTask.cancel();
+    }
+
+    @Override
+    public boolean isCanceled() {
+        return this.rootTask.isCancelled();
+    }
+
+    @Override
+    public boolean isAsync() {
+        return !this.rootTask.isSync();
+    }
+
+}

commons-shared-bukkit/test/com/eternalcode/commons/shared/bukkit/position/PositionAdapterTest.java

@@ -27,10 +27,10 @@ void testConvertLocationToPosition() {
 
         Position position = PositionAdapter.convert(location);
 
-        assertEquals(1, position.getX());
-        assertEquals(2, position.getY());
-        assertEquals(3, position.getZ());
-        assertEquals(WORLD_NAME, position.getWorld());
+        assertEquals(1, position.x());
+        assertEquals(2, position.y());
+        assertEquals(3, position.z());
+        assertEquals(WORLD_NAME, position.world());
     }
 
     @Test

commons-shared-bukkit/test/com/eternalcode/commons/shared/bukkit/position/PositionTest.java

@@ -16,32 +16,32 @@ void setUp() {
 
     @Test
     void getWorld() {
-        assertEquals("world", position.getWorld());
+        assertEquals("world", position.world());
     }
 
     @Test
     void getX() {
-        assertEquals(1.0d, position.getX());
+        assertEquals(1.0d, position.x());
     }
 
     @Test
     void getY() {
-        assertEquals(2.0d, position.getY());
+        assertEquals(2.0d, position.y());
     }
 
     @Test
     void getZ() {
-        assertEquals(3.0d, position.getZ());
+        assertEquals(3.0d, position.z());
     }
 
     @Test
     void getYaw() {
-        assertEquals(4.0f, position.getYaw());
+        assertEquals(4.0f, position.yaw());
     }
 
     @Test
     void getPitch() {
-        assertEquals(5.0f, position.getPitch());
+        assertEquals(5.0f, position.pitch());
     }
 
     @Test
@@ -55,14 +55,14 @@ void testEqualsAndHashCode() {
         Position position3 = new Position(1.0d, 2.0d, 3.1d, 4.0f, 5.0f, "world");
 
         // Reflexive test
-        assertTrue(position.equals(position));
+        assertEquals(position, position);
 
         // Symmetric test
-        assertTrue(position.equals(position2));
-        assertTrue(position2.equals(position));
+        assertEquals(position, position2);
+        assertEquals(position2, position);
 
-        assertFalse(position.equals(position3));
-        assertFalse(position3.equals(position));
+        assertNotEquals(position, position3);
+        assertNotEquals(position3, position);
 
         // hashCode
         assertEquals(position.hashCode(), position2.hashCode());

commons-shared/src/main/java/com/eternalcode/commons/shared/scheduler/Scheduler.java

@@ -0,0 +1,24 @@
+package com.eternalcode.commons.shared.scheduler;
+
+import java.time.Duration;
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Supplier;
+
+public interface Scheduler {
+
+    Task sync(Runnable task);
+
+    Task async(Runnable task);
+
+    Task laterSync(Runnable task, Duration delay);
+
+    Task laterAsync(Runnable task, Duration delay);
+
+    Task timerSync(Runnable task, Duration delay, Duration period);
+
+    Task timerAsync(Runnable task, Duration delay, Duration period);
+
+    <T> CompletableFuture<T> completeSync(Supplier<T> task);
+
+    <T> CompletableFuture<T> completeAsync(Supplier<T> task);
+}

commons-shared/src/main/java/com/eternalcode/commons/shared/scheduler/Task.java

@@ -0,0 +1,11 @@
+package com.eternalcode.commons.shared.scheduler;
+
+public interface Task {
+
+    void cancel();
+
+    boolean isCanceled();
+
+    boolean isAsync();
+
+}