fix: update DominionAPI dependency version to 4.6.0 and refactor event handling to use Provider methods

Author: ColdeZhang

README.md

@@ -18,7 +18,7 @@ repositories {
 }
 
 dependencies {
-    compileOnly("cn.lunadeer:DominionAPI:4.5.0")
+    compileOnly("cn.lunadeer:DominionAPI:4.6.0")
 }
 ```
 

build.gradle.kts

@@ -15,7 +15,7 @@ java {
 }
 
 group = "cn.lunadeer"
-version = "4.5.2" // << The main version should keep consistent with the core module
+version = "4.6.0" // << The main version should keep consistent with the core module
 
 // utf-8
 tasks.withType<JavaCompile> {

src/main/java/cn/lunadeer/dominion/api/DominionAPI.java

@@ -6,6 +6,9 @@
 import cn.lunadeer.dominion.api.dtos.PlayerDTO;
 import cn.lunadeer.dominion.api.dtos.flag.EnvFlag;
 import cn.lunadeer.dominion.api.dtos.flag.PriFlag;
+import cn.lunadeer.dominion.providers.DominionProvider;
+import cn.lunadeer.dominion.providers.GroupProvider;
+import cn.lunadeer.dominion.providers.MemberProvider;
 import org.bukkit.Location;
 import org.bukkit.entity.Player;
 import org.jetbrains.annotations.ApiStatus;
@@ -329,4 +332,40 @@ public static DominionAPI getInstance() {
      */
     @Deprecated(since = "4.5.0")
     public abstract boolean checkEnvironmentFlag(@Nullable DominionDTO dom, @NotNull EnvFlag flag);
+
+    /**
+     * Retrieves the DominionProvider instance.
+     * <p>
+     * This method provides access to the DominionProvider, which handles dominion-related operations
+     * such as creating, updating, and deleting dominions.
+     *
+     * @return the singleton instance of DominionProvider
+     */
+    public static DominionProvider getDominionProvider() {
+        return DominionProvider.getInstance();
+    }
+
+    /**
+     * Retrieves the GroupProvider instance.
+     * <p>
+     * This method provides access to the GroupProvider, which handles group-related operations
+     * such as creating, updating, and deleting groups within dominions.
+     *
+     * @return the singleton instance of GroupProvider
+     */
+    public static GroupProvider getGroupProvider() {
+        return GroupProvider.getInstance();
+    }
+
+    /**
+     * Retrieves the MemberProvider instance.
+     * <p>
+     * This method provides access to the MemberProvider, which handles member-related operations
+     * such as adding, updating, and removing members from dominions and groups.
+     *
+     * @return the singleton instance of MemberProvider
+     */
+    public static MemberProvider getMemberProvider() {
+        return MemberProvider.getInstance();
+    }
 }

src/main/java/cn/lunadeer/dominion/api/dtos/GroupDTO.java

@@ -3,7 +3,6 @@
 import cn.lunadeer.dominion.api.dtos.flag.PriFlag;
 import net.kyori.adventure.text.Component;
 import org.jetbrains.annotations.NotNull;
-import org.jetbrains.annotations.Nullable;
 
 import java.sql.SQLException;
 import java.util.List;
@@ -90,7 +89,7 @@ public interface GroupDTO {
      * @return the group object
      * @throws SQLException if a database access error occurs
      */
-    @Nullable GroupDTO setFlagValue(@NotNull PriFlag flag, @NotNull Boolean value) throws SQLException;
+    @NotNull GroupDTO setFlagValue(@NotNull PriFlag flag, @NotNull Boolean value) throws SQLException;
 
     /**
      * Gets all members of the group.

src/main/java/cn/lunadeer/dominion/events/dominion/DominionCreateEvent.java

@@ -10,12 +10,12 @@
 import org.jetbrains.annotations.Nullable;
 
 import java.util.UUID;
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
 
 /**
  * Event triggered when a Dominion is created in the Dominion system.
  * Setting setSkipEconomy(true) can skip the economic system processing.
- * To modify creation information, set your EventPriority to {@link org.bukkit.event.EventPriority#LOWEST}.
- * Changes made after this will not take effect.
  */
 @ApiStatus.Experimental
 public class DominionCreateEvent extends ResultEvent {
@@ -26,7 +26,7 @@ public class DominionCreateEvent extends ResultEvent {
     private CuboidDTO cuboid;
     private DominionDTO parent;
     private UUID owner;
-    private DominionDTO dominion = null;
+    private final CompletableFuture<DominionDTO> future = new CompletableFuture<>();
 
     /**
      * Constructs a new DominionCreateEvent.
@@ -53,9 +53,6 @@ public DominionCreateEvent(@NotNull CommandSender operator,
 
     /**
      * Sets whether to skip the economic system processing.
-     * <p>
-     * Changes made in {@link org.bukkit.event.EventPriority} HIGH or higher {@link org.bukkit.event.EventHandler} will not take effect.
-     * (Default is {@link org.bukkit.event.EventPriority#NORMAL})
      *
      * @param skipEconomy true to skip the economic system processing, false otherwise
      */
@@ -83,9 +80,6 @@ public boolean isSkipEconomy() {
 
     /**
      * Sets the name of the dominion.
-     * <p>
-     * Changes made in {@link org.bukkit.event.EventPriority} HIGH or higher {@link org.bukkit.event.EventHandler} will not take effect.
-     * (Default is {@link org.bukkit.event.EventPriority#NORMAL})
      *
      * @param name the name of the dominion
      */
@@ -140,9 +134,6 @@ public void setWorld(@NotNull World world) {
 
     /**
      * Sets the parent dominion.
-     * <p>
-     * Changes made in {@link org.bukkit.event.EventPriority} HIGH or higher {@link org.bukkit.event.EventHandler} will not take effect.
-     * (Default is {@link org.bukkit.event.EventPriority#NORMAL})
      *
      * @param parent the parent dominion
      */
@@ -161,9 +152,6 @@ public void setParent(@Nullable DominionDTO parent) {
 
     /**
      * Sets the owner of the dominion.
-     * <p>
-     * Changes made in {@link org.bukkit.event.EventPriority} HIGH or higher {@link org.bukkit.event.EventHandler} will not take effect.
-     * (Default is {@link org.bukkit.event.EventPriority#NORMAL})
      *
      * @param owner the owner of the dominion
      */
@@ -172,23 +160,44 @@ public void setOwner(@NotNull UUID owner) {
     }
 
     /**
-     * Gets the dominion.
+     * Gets the CompletableFuture that will be completed with the created DominionDTO.
      * <p>
-     * If retrieved in {@link org.bukkit.event.EventPriority} LOW, LOWEST, or NORMAL {@link org.bukkit.event.EventHandler}, it will be null,
-     * as the dominion has not been created yet.
+     * Under most circumstances, you should not need to use this method directly. If you
+     * need to perform actions after the dominion is created, you should use the
+     * {@link #afterCreated(Consumer)} method instead.
      *
-     * @return the dominion, or null if it has not been created yet
+     * @return the CompletableFuture to be completed
      */
-    public @Nullable DominionDTO getDominion() {
-        return dominion;
+    public CompletableFuture<DominionDTO> getFutureToComplete() {
+        return future;
     }
 
     /**
-     * Sets the dominion.
+     * Call back after the dominion is created.
+     * <p>
+     * Use this method to perform actions after the dominion has been created (may fail),
+     * if you need to do something with the created dominion.
      *
-     * @param dominion the dominion to set
+     * @param consumer the consumer to handle the created dominion
+     * @return a CompletableFuture that completes when the consumer has been executed
+     */
+    public CompletableFuture<Void> afterCreated(Consumer<DominionDTO> consumer) {
+        return future.thenAccept(consumer);
+    }
+
+    /**
+     * @deprecated This method is deprecated and will be removed in future versions.
+     * To get the created dominion, use the {@link #afterCreated(Consumer)} method instead.
+     */
+    @Deprecated(since = "4.6.0", forRemoval = true)
+    public @Nullable DominionDTO getDominion() {
+        return null;
+    }
+
+    /**
+     * @deprecated This method is deprecated and will be removed in future versions.
      */
+    @Deprecated(since = "4.6.0", forRemoval = true)
     public void setDominion(@NotNull DominionDTO dominion) {
-        this.dominion = dominion;
     }
 }

src/main/java/cn/lunadeer/dominion/events/dominion/modify/DominionModifyEvent.java

@@ -6,13 +6,17 @@
 import org.jetbrains.annotations.ApiStatus;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+
 /**
  * Event triggered when a Dominion is modified in the Dominion system.
  */
 @ApiStatus.Experimental
 public class DominionModifyEvent extends ResultEvent {
 
     private DominionDTO dominion;
+    private final CompletableFuture<DominionDTO> future = new CompletableFuture<>();
 
     /**
      * Constructs a new DominionModifyEvent.
@@ -26,11 +30,36 @@ public DominionModifyEvent(@NotNull CommandSender operator, @NotNull DominionDTO
     }
 
     /**
-     * Returns the dominion being modified.
+     * Gets the CompletableFuture that will be completed with the created DominionDTO.
+     * <p>
+     * Under most circumstances, you should not need to use this method directly. If you
+     * need to perform actions after the dominion is modified, you should use the
+     * {@link #afterModified(Consumer)} method instead.
+     *
+     * @return the CompletableFuture to be completed
+     */
+    public CompletableFuture<DominionDTO> getFutureToComplete() {
+        return future;
+    }
+
+    /**
+     * Call back after the dominion is modified.
      * <p>
-     * To get changed dominion your event listener need to be {@link org.bukkit.event.EventPriority} HIGH or higher {@link org.bukkit.event.EventHandler}.
-     * (Default is {@link org.bukkit.event.EventPriority#NORMAL})
-     * Or otherwise get the dominion before the changes are applied.
+     * Use this method to perform actions after the dominion has been modified.
+     *
+     * @param consumer the consumer to handle the created dominion
+     * @return a CompletableFuture that completes when the consumer has been executed
+     */
+    public CompletableFuture<Void> afterModified(Consumer<DominionDTO> consumer) {
+        return future.thenAccept(consumer);
+    }
+
+    /**
+     * Returns the dominion to be modified.
+     * <p>
+     * This method retrieves the dominion that is going to be modified by this event.
+     * To get the modified dominion after the event is processed, use the
+     * {@link #afterModified(Consumer)} method to register a callback.
      *
      * @return the dominion
      */
@@ -39,9 +68,11 @@ public DominionModifyEvent(@NotNull CommandSender operator, @NotNull DominionDTO
     }
 
     /**
-     * Sets the dominion being modified.
+     * Sets the dominion to be modified.
+     * <p>
+     * This method can only change which dominion will be modified.
      *
-     * @param dominion the new dominion
+     * @param dominion the dominion to set
      */
     public void setDominion(@NotNull DominionDTO dominion) {
         this.dominion = dominion;

src/main/java/cn/lunadeer/dominion/events/group/GroupAddMemberEvent.java

@@ -7,6 +7,9 @@
 import org.bukkit.command.CommandSender;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.concurrent.CompletableFuture;
+import java.util.function.Consumer;
+
 /**
  * Event triggered when a member is added to a group within a dominion.
  */
@@ -15,6 +18,7 @@ public class GroupAddMemberEvent extends ResultEvent {
     private final DominionDTO dominion;
     private final GroupDTO group;
     private MemberDTO member;
+    private final CompletableFuture<MemberDTO> future = new CompletableFuture<>();
 
     /**
      * Constructs a new GroupAddMemberEvent.
@@ -24,7 +28,10 @@ public class GroupAddMemberEvent extends ResultEvent {
      * @param group    the group to which the member is being added
      * @param member   the member being added to the group
      */
-    public GroupAddMemberEvent(@NotNull CommandSender operator, @NotNull DominionDTO dominion, @NotNull GroupDTO group, @NotNull MemberDTO member) {
+    public GroupAddMemberEvent(@NotNull CommandSender operator,
+                               @NotNull DominionDTO dominion,
+                               @NotNull GroupDTO group,
+                               @NotNull MemberDTO member) {
         super(operator);
         this.dominion = dominion;
         this.group = group;
@@ -42,6 +49,10 @@ public GroupAddMemberEvent(@NotNull CommandSender operator, @NotNull DominionDTO
 
     /**
      * Gets the member being added to the group.
+     * <p>
+     * This method returns the member that will be added to the group. If you want to
+     * get the member after it has been added (which may fail), you should use the
+     * {@link #afterAdded(Consumer)} method instead.
      *
      * @return the member
      */
@@ -66,4 +77,30 @@ public void setMember(@NotNull MemberDTO member) {
     public @NotNull DominionDTO getDominion() {
         return dominion;
     }
+
+    /**
+     * Gets the CompletableFuture that will be completed with the added MemberDTO.
+     * <p>
+     * Under most circumstances, you should not need to use this method directly. If you
+     * need to perform actions after the member is added, you should use the
+     * {@link #afterAdded(Consumer)} method instead.
+     *
+     * @return the CompletableFuture to be completed
+     */
+    public CompletableFuture<MemberDTO> getFutureToComplete() {
+        return future;
+    }
+
+    /**
+     * Call back after the member is added.
+     * <p>
+     * Use this method to perform actions after the member has been added (may fail),
+     * if you need to do something with the added member.
+     *
+     * @param consumer the consumer to handle the created member
+     * @return a CompletableFuture that completes when the consumer has been executed
+     */
+    public CompletableFuture<Void> afterAdded(Consumer<MemberDTO> consumer) {
+        return future.thenAccept(consumer);
+    }
 }