Merge pull request #3311 from Multiverse/refactor/remove-deprecate

Deprecate other removeWorld methods in favour of using RemoveWorldOpt…

Author: benwoo1110

src/main/java/org/mvplugins/multiverse/core/utils/result/FailureReason.java

@@ -3,12 +3,21 @@
 import co.aikar.locales.MessageKey;
 import co.aikar.locales.MessageKeyProvider;
 
+import org.jetbrains.annotations.ApiStatus;
 import org.mvplugins.multiverse.core.locale.MVCorei18n;
 
 /**
  * Represents a failure reason for an {@link Attempt}.
  */
 public interface FailureReason extends MessageKeyProvider {
+    /**
+     * A generic failure reason that can be used when no specific reason is applicable.
+     *
+     * @since 5.2
+     */
+    @ApiStatus.AvailableSince("5.2")
+    FailureReason GENERIC = new FailureReason() { };
+
     default MessageKey getMessageKey() {
         return MVCorei18n.GENERIC_FAILURE.getMessageKey();
     }

src/main/java/org/mvplugins/multiverse/core/utils/result/SuccessReason.java

@@ -3,9 +3,21 @@
 import co.aikar.locales.MessageKey;
 import co.aikar.locales.MessageKeyProvider;
 
+import org.jetbrains.annotations.ApiStatus;
 import org.mvplugins.multiverse.core.locale.MVCorei18n;
 
+/**
+ * Represents a success reason for an {@link Attempt}.
+ */
 public interface SuccessReason extends MessageKeyProvider {
+    /**
+     * A generic success reason that can be used when no specific reason is applicable.
+     *
+     * @since 5.2
+     */
+    @ApiStatus.AvailableSince("5.2")
+    SuccessReason GENERIC = new SuccessReason() { };
+
     default MessageKey getMessageKey() {
         return MVCorei18n.GENERIC_SUCCESS.getMessageKey();
     }

src/main/java/org/mvplugins/multiverse/core/world/WorldManager.java

@@ -171,7 +171,11 @@ private void loadNewWorldConfigs(Collection<WorldConfig> newWorldConfigs) {
     }
 
     private void removeWorldsNotInConfigs(Collection<String> removedWorlds) {
-        removedWorlds.forEach(worldName -> removeWorld(worldName)
+        removedWorlds.forEach(worldName -> getWorld(worldName)
+                .fold(
+                        () -> Attempt.failure(FailureReason.GENERIC, Message.of("world already removed")),
+                        world -> removeWorld(RemoveWorldOptions.world(world))
+                )
                 .onFailure(failure -> Logging.severe("Failed to unload world %s: %s", worldName, failure))
                 .onSuccess(success -> Logging.fine("Unloaded world %s as it was removed from config", worldName)));
     }
@@ -515,10 +519,14 @@ private Attempt<MultiverseWorld, UnloadFailureReason> removeLoadedMultiverseWorl
      *
      * @param worldName The name of the world to remove.
      * @return The result of the remove.
+     *
+     * @deprecated Get the {@link MultiverseWorld} yourself and use {@link #removeWorld(RemoveWorldOptions)} instead.
      */
+    @Deprecated(since = "5.2", forRemoval = true)
+    @ApiStatus.ScheduledForRemoval(inVersion = "6.0")
     public Attempt<String, RemoveFailureReason> removeWorld(@NotNull String worldName) {
         return getWorld(worldName)
-                .map(this::removeWorld)
+                .map(world -> removeWorld(RemoveWorldOptions.world(world)))
                 .getOrElse(() -> worldActionResult(RemoveFailureReason.WORLD_NON_EXISTENT, worldName));
     }
 
@@ -528,7 +536,11 @@ public Attempt<String, RemoveFailureReason> removeWorld(@NotNull String worldNam
      *
      * @param world The multiverse world to remove.
      * @return The result of the remove.
+     *
+     * @deprecated Use {@link #removeWorld(RemoveWorldOptions)} instead.
      */
+    @Deprecated(since = "5.2", forRemoval = true)
+    @ApiStatus.ScheduledForRemoval(inVersion = "6.0")
     public Attempt<String, RemoveFailureReason> removeWorld(@NotNull MultiverseWorld world) {
         return removeWorld(RemoveWorldOptions.world(world));
     }
@@ -539,9 +551,13 @@ public Attempt<String, RemoveFailureReason> removeWorld(@NotNull MultiverseWorld
      *
      * @param loadedWorld The multiverse world to remove.
      * @return The result of the remove.
+     *
+     * @deprecated Use {@link #removeWorld(RemoveWorldOptions)} instead.
      */
+    @Deprecated(since = "5.2", forRemoval = true)
+    @ApiStatus.ScheduledForRemoval(inVersion = "6.0")
     public Attempt<String, RemoveFailureReason> removeWorld(@NotNull LoadedMultiverseWorld loadedWorld) {
-        return unloadBeforeRemoveWorld(loadedWorld, RemoveWorldOptions.world(loadedWorld));
+        return removeWorld(RemoveWorldOptions.world(loadedWorld));
     }
 
     /**
@@ -622,7 +638,11 @@ private Attempt<String, DeleteFailureReason> doDeleteWorld(@NotNull LoadedMultiv
                             ? Attempt.failure(DeleteFailureReason.EVENT_CANCELLED)
                             : Attempt.success(null);
                 })
-                .mapAttempt(() -> removeWorld(world).transform(DeleteFailureReason.REMOVE_FAILED))
+                .mapAttempt(() -> removeWorld(RemoveWorldOptions
+                        .world(world)
+                        .unloadBukkitWorld(true)
+                        .saveBukkitWorld(false)
+                ).transform(DeleteFailureReason.REMOVE_FAILED))
                 .mapAttempt(() -> fileUtils.deleteFolder(worldFolder.get(), options.keepFiles()).fold(
                         exception -> worldActionResult(DeleteFailureReason.FAILED_TO_DELETE_FOLDER,
                                 world.getName(), exception),

src/main/java/org/mvplugins/multiverse/core/world/reasons/RemoveFailureReason.java

@@ -3,16 +3,22 @@
 import co.aikar.locales.MessageKey;
 import co.aikar.locales.MessageKeyProvider;
 
+import org.jetbrains.annotations.ApiStatus;
 import org.mvplugins.multiverse.core.locale.MVCorei18n;
 import org.mvplugins.multiverse.core.utils.result.FailureReason;
+import org.mvplugins.multiverse.core.world.WorldManager;
 
 /**
  * Result of a world removal operation.
  */
 public enum RemoveFailureReason implements FailureReason {
     /**
      * The world does not exist.
+     *
+     * @deprecated No longer in use as {@link WorldManager#removeWorld(String)} is now deprecated.
      */
+    @Deprecated(forRemoval = true, since = "5.2")
+    @ApiStatus.ScheduledForRemoval(inVersion = "6.0")
     WORLD_NON_EXISTENT(MVCorei18n.REMOVEWORLD_WORLDNONEXISTENT),
 
     /**

src/test/java/org/mvplugins/multiverse/core/world/WorldManagerTest.kt

@@ -11,6 +11,7 @@ import org.mvplugins.multiverse.core.world.options.CloneWorldOptions
 import org.mvplugins.multiverse.core.world.options.CreateWorldOptions
 import org.mvplugins.multiverse.core.world.options.DeleteWorldOptions
 import org.mvplugins.multiverse.core.world.options.RegenWorldOptions
+import org.mvplugins.multiverse.core.world.options.RemoveWorldOptions
 import org.mvplugins.multiverse.core.world.options.UnloadWorldOptions
 import org.mvplugins.multiverse.core.world.reasons.CloneFailureReason
 import org.mvplugins.multiverse.core.world.reasons.CreateFailureReason
@@ -102,7 +103,7 @@ class WorldManagerTest : TestWithMockBukkit() {
 
     @Test
     fun `Remove world`() {
-        assertTrue(worldManager.removeWorld(world).isSuccess)
+        assertTrue(worldManager.removeWorld(RemoveWorldOptions.world(world)).isSuccess)
         assertFalse(worldManager.getWorld("world").isDefined)
         assertFalse(worldManager.getLoadedWorld("world").isDefined)
         assertFalse(worldManager.getUnloadedWorld("world").isDefined)