Refactor bulkedit api to expose less classes, and implement BulkEditCreator

benwoo1110 · benwoo1110 · commit 83d9675f205e · 2025-04-25T17:36:53.000+08:00
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/commands/bulkedit/BulkEditCommand.java b/src/main/java/org/mvplugins/multiverse/inventories/commands/bulkedit/BulkEditCommand.java
@@ -1,15 +1,26 @@
 package org.mvplugins.multiverse.inventories.commands.bulkedit;
 
 import org.jetbrains.annotations.ApiStatus;
+import org.jvnet.hk2.annotations.Contract;
 import org.mvplugins.multiverse.core.command.MVCommandIssuer;
 import org.mvplugins.multiverse.core.utils.StringFormatter;
+import org.mvplugins.multiverse.external.jakarta.inject.Inject;
 import org.mvplugins.multiverse.inventories.commands.InventoriesCommand;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.action.BulkEditAction;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.action.BulkEditResult;
+import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkEditAction;
+import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkEditCreator;
+import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkEditResult;
 
+@Contract
 @ApiStatus.Internal
 public abstract class BulkEditCommand extends InventoriesCommand {
 
+    protected final BulkEditCreator bulkEditCreator;
+
+    @Inject
+    protected BulkEditCommand(BulkEditCreator bulkEditCreator) {
+        this.bulkEditCreator = bulkEditCreator;
+    }
+
     protected void outputActionSummary(MVCommandIssuer issuer, BulkEditAction<?> bulkEditAction) {
         issuer.sendMessage("Summary of affected profiles:");
         bulkEditAction.getActionSummary().forEach((key, value) ->
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/commands/bulkedit/playerprofile/ClearCommand.java b/src/main/java/org/mvplugins/multiverse/inventories/commands/bulkedit/playerprofile/ClearCommand.java
@@ -12,28 +12,27 @@
 import org.mvplugins.multiverse.external.acf.commands.annotation.Syntax;
 import org.mvplugins.multiverse.external.jakarta.inject.Inject;
 import org.mvplugins.multiverse.external.jetbrains.annotations.NotNull;
-import org.mvplugins.multiverse.inventories.MultiverseInventories;
 import org.mvplugins.multiverse.inventories.commands.bulkedit.BulkEditCommand;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkProfilesPayload;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.action.PlayerProfileClearAction;
+import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkEditAction;
+import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkEditCreator;
+import org.mvplugins.multiverse.inventories.profile.bulkedit.PlayerProfilesPayload;
 import org.mvplugins.multiverse.inventories.profile.key.ContainerKey;
 import org.mvplugins.multiverse.inventories.profile.key.GlobalProfileKey;
 import org.mvplugins.multiverse.inventories.profile.key.ProfileType;
 
 @Service
 final class ClearCommand extends BulkEditCommand {
 
-    private final MultiverseInventories inventories;
     private final CommandQueueManager commandQueueManager;
     private final IncludeGroupsWorldsFlag flags;
 
     @Inject
     ClearCommand(
-            @NotNull MultiverseInventories inventories,
+            @NotNull BulkEditCreator bulkEditCreator,
             @NotNull CommandQueueManager commandQueueManager,
             @NotNull IncludeGroupsWorldsFlag flags
     ) {
-        this.inventories = inventories;
+        super(bulkEditCreator);
         this.commandQueueManager = commandQueueManager;
         this.flags = flags;
     }
@@ -51,9 +50,8 @@ void onCommand(
     ) {
         ParsedCommandFlags parsedFlags = flags.parse(flagArray);
 
-        PlayerProfileClearAction bulkEditAction = new PlayerProfileClearAction(
-                inventories,
-                new BulkProfilesPayload(
+        BulkEditAction<?> bulkEditAction = bulkEditCreator.playerProfileClear(
+                new PlayerProfilesPayload(
                         globalProfileKeys,
                         containerKeys,
                         profileTypes,
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/commands/bulkedit/playerprofile/DeleteCommand.java b/src/main/java/org/mvplugins/multiverse/inventories/commands/bulkedit/playerprofile/DeleteCommand.java
@@ -13,10 +13,10 @@
 import org.mvplugins.multiverse.external.acf.commands.annotation.Syntax;
 import org.mvplugins.multiverse.external.jakarta.inject.Inject;
 import org.mvplugins.multiverse.external.jetbrains.annotations.NotNull;
-import org.mvplugins.multiverse.inventories.MultiverseInventories;
 import org.mvplugins.multiverse.inventories.commands.bulkedit.BulkEditCommand;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkProfilesPayload;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.action.PlayerProfileDeleteAction;
+import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkEditAction;
+import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkEditCreator;
+import org.mvplugins.multiverse.inventories.profile.bulkedit.PlayerProfilesPayload;
 import org.mvplugins.multiverse.inventories.profile.key.ContainerKey;
 import org.mvplugins.multiverse.inventories.profile.key.GlobalProfileKey;
 import org.mvplugins.multiverse.inventories.profile.key.ProfileType;
@@ -25,17 +25,16 @@
 @Service
 final class DeleteCommand extends BulkEditCommand {
 
-    private final MultiverseInventories inventories;
     private final CommandQueueManager commandQueueManager;
     private final IncludeGroupsWorldsFlag flags;
 
     @Inject
     DeleteCommand(
-            @NotNull MultiverseInventories inventories,
+            @NotNull BulkEditCreator bulkEditCreator,
             @NotNull CommandQueueManager commandQueueManager,
             @NotNull IncludeGroupsWorldsFlag flags
     ) {
-        this.inventories = inventories;
+        super(bulkEditCreator);
         this.commandQueueManager = commandQueueManager;
         this.flags = flags;
     }
@@ -54,15 +53,14 @@ void onCommand(
     ) {
         ParsedCommandFlags parsedFlags = flags.parse(flagArray);
 
-        PlayerProfileDeleteAction bulkEditAction = new PlayerProfileDeleteAction(
-                inventories,
-                sharable,
-                new BulkProfilesPayload(
+        BulkEditAction<?> bulkEditAction = bulkEditCreator.playerProfileDeleteSharable(
+                new PlayerProfilesPayload(
                         globalProfileKeys,
                         containerKeys,
                         profileTypes,
                         parsedFlags.hasFlag(flags.includeGroupsWorlds)
-                )
+                ),
+                sharable
         );
 
         issuer.sendMessage("Summary of affected profiles:");
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/BulkEditAction.java b/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/BulkEditAction.java
@@ -1,4 +1,4 @@
-package org.mvplugins.multiverse.inventories.profile.bulkedit.action;
+package org.mvplugins.multiverse.inventories.profile.bulkedit;
 
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
@@ -15,7 +15,7 @@
 import java.util.concurrent.CompletableFuture;
 
 @ApiStatus.Experimental
-public abstract class BulkEditAction<K extends GlobalProfileKey> {
+public sealed abstract class BulkEditAction<K extends GlobalProfileKey> permits PlayerFileAction, PlayerProfileAction {
 
     protected final MultiverseInventories inventories;
     protected final ProfileDataSource profileDataSource;
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/BulkEditCreator.java b/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/BulkEditCreator.java
@@ -0,0 +1,28 @@
+package org.mvplugins.multiverse.inventories.profile.bulkedit;
+
+import org.jetbrains.annotations.ApiStatus;
+import org.jetbrains.annotations.NotNull;
+import org.jvnet.hk2.annotations.Service;
+import org.mvplugins.multiverse.external.jakarta.inject.Inject;
+import org.mvplugins.multiverse.inventories.MultiverseInventories;
+import org.mvplugins.multiverse.inventories.share.Sharable;
+
+@Service
+@ApiStatus.Experimental
+public final class BulkEditCreator {
+
+    private final MultiverseInventories inventories;
+
+    @Inject
+    BulkEditCreator(@NotNull MultiverseInventories inventories) {
+        this.inventories = inventories;
+    }
+
+    public BulkEditAction<?> playerProfileClear(PlayerProfilesPayload bulkProfilesPayload) {
+        return new PlayerProfileClearAction(inventories, bulkProfilesPayload);
+    }
+
+    public BulkEditAction<?> playerProfileDeleteSharable(PlayerProfilesPayload bulkProfilesPayload, Sharable<?> sharable) {
+        return new PlayerProfileDeleteAction(inventories, sharable, bulkProfilesPayload);
+    }
+}
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/BulkEditResult.java b/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/BulkEditResult.java
@@ -1,4 +1,4 @@
-package org.mvplugins.multiverse.inventories.profile.bulkedit.action;
+package org.mvplugins.multiverse.inventories.profile.bulkedit;
 
 import org.jetbrains.annotations.ApiStatus;
 
@@ -11,6 +11,8 @@ public final class BulkEditResult {
     private final AtomicInteger successCount = new AtomicInteger(0);
     private final AtomicInteger failureCount = new AtomicInteger(0);
 
+    BulkEditResult() { }
+
     void incrementSuccess() {
         successCount.incrementAndGet();
     }
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerFileAction.java b/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerFileAction.java
@@ -1,23 +1,20 @@
-package org.mvplugins.multiverse.inventories.profile.bulkedit.action;
+package org.mvplugins.multiverse.inventories.profile.bulkedit;
 
 import org.jetbrains.annotations.ApiStatus;
 import org.mvplugins.multiverse.inventories.MultiverseInventories;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkProfilesAggregator;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkProfilesPayload;
 import org.mvplugins.multiverse.inventories.profile.key.ProfileFileKey;
 
 import java.util.List;
 import java.util.Map;
 
-@ApiStatus.Experimental
-public abstract class PlayerFileAction extends BulkEditAction<ProfileFileKey> {
+abstract sealed class PlayerFileAction extends BulkEditAction<ProfileFileKey> permits PlayerProfileClearAction {
 
-    private final BulkProfilesAggregator profilesAggregator;
-    protected final BulkProfilesPayload bulkProfilesPayload; 
+    private final PlayerProfilesAggregator profilesAggregator;
+    protected final PlayerProfilesPayload bulkProfilesPayload;
     
-    PlayerFileAction(MultiverseInventories inventories, BulkProfilesPayload bulkProfilesPayload) {
+    PlayerFileAction(MultiverseInventories inventories, PlayerProfilesPayload bulkProfilesPayload) {
         super(inventories, bulkProfilesPayload.globalProfileKeys());
-        this.profilesAggregator = inventories.getServiceLocator().getService(BulkProfilesAggregator.class);
+        this.profilesAggregator = inventories.getServiceLocator().getService(PlayerProfilesAggregator.class);
         this.bulkProfilesPayload = bulkProfilesPayload;
     }
 
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerProfileAction.java b/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerProfileAction.java
@@ -1,26 +1,23 @@
-package org.mvplugins.multiverse.inventories.profile.bulkedit.action;
+package org.mvplugins.multiverse.inventories.profile.bulkedit;
 
 import org.jetbrains.annotations.ApiStatus;
 import org.mvplugins.multiverse.inventories.MultiverseInventories;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkProfilesAggregator;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkProfilesPayload;
 import org.mvplugins.multiverse.inventories.profile.key.ProfileKey;
 
 import java.util.List;
 import java.util.Map;
 
-@ApiStatus.Experimental
-public abstract class PlayerProfileAction extends BulkEditAction<ProfileKey> {
+abstract sealed class PlayerProfileAction extends BulkEditAction<ProfileKey> permits PlayerProfileDeleteAction {
 
-    private final BulkProfilesAggregator profilesAggregator;
-    private final BulkProfilesPayload bulkProfilesPayload;
+    private final PlayerProfilesAggregator profilesAggregator;
+    private final PlayerProfilesPayload bulkProfilesPayload;
 
     protected PlayerProfileAction(
             MultiverseInventories inventories,
-            BulkProfilesPayload bulkProfilesPayload
+            PlayerProfilesPayload bulkProfilesPayload
     ) {
         super(inventories, bulkProfilesPayload.globalProfileKeys());
-        this.profilesAggregator = inventories.getServiceLocator().getService(BulkProfilesAggregator.class);
+        this.profilesAggregator = inventories.getServiceLocator().getService(PlayerProfilesAggregator.class);
         this.bulkProfilesPayload = bulkProfilesPayload;
     }
 
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerProfileClearAction.java b/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerProfileClearAction.java
@@ -1,14 +1,12 @@
-package org.mvplugins.multiverse.inventories.profile.bulkedit.action;
+package org.mvplugins.multiverse.inventories.profile.bulkedit;
 
 import org.bukkit.entity.Player;
 import org.jetbrains.annotations.ApiStatus;
 import org.mvplugins.multiverse.inventories.MultiverseInventories;
 import org.mvplugins.multiverse.inventories.handleshare.ReadOnlyShareHandler;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkProfilesPayload;
 import org.mvplugins.multiverse.inventories.profile.group.WorldGroup;
 import org.mvplugins.multiverse.inventories.profile.group.WorldGroupManager;
 import org.mvplugins.multiverse.inventories.profile.key.ContainerType;
-import org.mvplugins.multiverse.inventories.profile.key.GlobalProfileKey;
 import org.mvplugins.multiverse.inventories.profile.key.ProfileFileKey;
 import org.mvplugins.multiverse.inventories.profile.key.ProfileType;
 import org.mvplugins.multiverse.inventories.profile.key.ProfileTypes;
@@ -19,13 +17,12 @@
 import java.util.Set;
 import java.util.concurrent.CompletableFuture;
 
-@ApiStatus.Experimental
-public final class PlayerProfileClearAction extends PlayerFileAction {
+final class PlayerProfileClearAction extends PlayerFileAction {
 
     private final WorldGroupManager worldGroupManager;
     private final Set<ProfileType> profileTypesSet;
 
-    public PlayerProfileClearAction(MultiverseInventories inventories, BulkProfilesPayload bulkProfilesPayload) {
+    public PlayerProfileClearAction(MultiverseInventories inventories, PlayerProfilesPayload bulkProfilesPayload) {
         super(inventories, bulkProfilesPayload);
         this.worldGroupManager = inventories.getServiceLocator().getService(WorldGroupManager.class);
         this.profileTypesSet = Set.of(bulkProfilesPayload.profileTypes());
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerProfileDeleteAction.java b/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerProfileDeleteAction.java
@@ -1,12 +1,10 @@
-package org.mvplugins.multiverse.inventories.profile.bulkedit.action;
+package org.mvplugins.multiverse.inventories.profile.bulkedit;
 
 import org.bukkit.entity.Player;
 import org.jetbrains.annotations.ApiStatus;
 import org.mvplugins.multiverse.inventories.MultiverseInventories;
 import org.mvplugins.multiverse.inventories.handleshare.SingleShareReader;
 import org.mvplugins.multiverse.inventories.profile.data.ProfileData;
-import org.mvplugins.multiverse.inventories.profile.data.ProfileDataSnapshot;
-import org.mvplugins.multiverse.inventories.profile.bulkedit.BulkProfilesPayload;
 import org.mvplugins.multiverse.inventories.profile.data.SingleSharableData;
 import org.mvplugins.multiverse.inventories.profile.group.WorldGroup;
 import org.mvplugins.multiverse.inventories.profile.group.WorldGroupManager;
@@ -19,8 +17,7 @@
 import java.util.List;
 import java.util.concurrent.CompletableFuture;
 
-@ApiStatus.Experimental
-public final class PlayerProfileDeleteAction extends PlayerProfileAction {
+final class PlayerProfileDeleteAction extends PlayerProfileAction {
 
 
     private final WorldGroupManager worldGroupManager;
@@ -29,7 +26,7 @@ public final class PlayerProfileDeleteAction extends PlayerProfileAction {
     public PlayerProfileDeleteAction(
             MultiverseInventories inventories,
             Sharable sharable,
-            BulkProfilesPayload bulkProfilesPayload
+            PlayerProfilesPayload bulkProfilesPayload
     ) {
         super(inventories, bulkProfilesPayload);
         this.worldGroupManager = inventories.getServiceLocator().getService(WorldGroupManager.class);
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerProfilesAggregator.java b/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerProfilesAggregator.java
@@ -17,18 +17,17 @@
 import java.util.List;
 import java.util.Set;
 
-@ApiStatus.Experimental
 @Service
-public final class BulkProfilesAggregator {
+final class PlayerProfilesAggregator {
 
     private final WorldGroupManager worldGroupManager;
 
     @Inject
-    BulkProfilesAggregator(WorldGroupManager worldGroupManager) {
+    PlayerProfilesAggregator(WorldGroupManager worldGroupManager) {
         this.worldGroupManager = worldGroupManager;
     }
 
-    public List<ProfileFileKey> getProfileFileKeys(BulkProfilesPayload payload) {
+    List<ProfileFileKey> getProfileFileKeys(PlayerProfilesPayload payload) {
         var containerKeys = payload.includeGroupsWorlds()
                 ? includeGroupsWorlds(payload.containerKeys())
                 : payload.containerKeys();
@@ -48,7 +47,7 @@ public List<ProfileFileKey> getProfileFileKeys(BulkProfilesPayload payload) {
         return profileFileKeys;
     }
 
-    public List<ProfileKey> getPlayerProfileKeys(BulkProfilesPayload payload) {
+    List<ProfileKey> getPlayerProfileKeys(PlayerProfilesPayload payload) {
         var containerKeys = payload.includeGroupsWorlds()
                 ? includeGroupsWorlds(payload.containerKeys())
                 : payload.containerKeys();
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerProfilesPayload.java b/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/PlayerProfilesPayload.java
@@ -12,10 +12,10 @@
 import java.util.Map;
 
 @ApiStatus.Experimental
-public record BulkProfilesPayload(@NotNull GlobalProfileKey[] globalProfileKeys,
-                                  @NotNull ContainerKey[] containerKeys,
-                                  @NotNull ProfileType[] profileTypes,
-                                  boolean includeGroupsWorlds) {
+public record PlayerProfilesPayload(@NotNull GlobalProfileKey[] globalProfileKeys,
+                                    @NotNull ContainerKey[] containerKeys,
+                                    @NotNull ProfileType[] profileTypes,
+                                    boolean includeGroupsWorlds) {
 
     public Map<String, List<String>> getSummary() {
         return Map.of(
diff --git a/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/action/package-info.java b/src/main/java/org/mvplugins/multiverse/inventories/profile/bulkedit/action/package-info.java
