Refactor message key within enums in api

thomasmny · thomasmny · commit 8675a184ffcf · 2025-06-24T10:53:02.000+02:00
diff --git a/buildsystem-api/src/main/java/de/eintosti/buildsystem/api/navigator/settings/WorldFilter.java b/buildsystem-api/src/main/java/de/eintosti/buildsystem/api/navigator/settings/WorldFilter.java
@@ -19,6 +19,7 @@
 
 import de.eintosti.buildsystem.api.world.BuildWorld;
 import java.util.function.Predicate;
+import org.jetbrains.annotations.ApiStatus.Internal;
 
 public interface WorldFilter {
 
@@ -34,6 +35,7 @@ enum Mode {
             this.loreKey = loreKey;
         }
 
+        @Internal
         public String getLoreKey() {
             return loreKey;
         }
diff --git a/buildsystem-api/src/main/java/de/eintosti/buildsystem/api/navigator/settings/WorldSort.java b/buildsystem-api/src/main/java/de/eintosti/buildsystem/api/navigator/settings/WorldSort.java
@@ -61,15 +61,15 @@ public enum WorldSort {
      */
     OLDEST_FIRST("world_sort_date_oldest");
 
-    private final String key;
+    private final String messageKey;
 
-    WorldSort(String key) {
-        this.key = key;
+    WorldSort(String messageKey) {
+        this.messageKey = messageKey;
     }
 
     @Internal
-    public String getKey() {
-        return key;
+    public String getMessageKey() {
+        return messageKey;
     }
 
     public static WorldSort matchWorldSort(String type) {
@@ -85,46 +85,4 @@ public static WorldSort matchWorldSort(String type) {
 
         return NAME_A_TO_Z;
     }
-
-    public WorldSort getNext() {
-        switch (this) {
-            default: // NAME_A_TO_Z
-                return NAME_Z_TO_A;
-            case NAME_Z_TO_A:
-                return PROJECT_A_TO_Z;
-            case PROJECT_A_TO_Z:
-                return PROJECT_Z_TO_A;
-            case PROJECT_Z_TO_A:
-                return STATUS_NOT_STARTED;
-            case STATUS_NOT_STARTED:
-                return STATUS_FINISHED;
-            case STATUS_FINISHED:
-                return NEWEST_FIRST;
-            case NEWEST_FIRST:
-                return OLDEST_FIRST;
-            case OLDEST_FIRST:
-                return NAME_A_TO_Z;
-        }
-    }
-
-    public WorldSort getPrevious() {
-        switch (this) {
-            default: // NAME_A_TO_Z
-                return OLDEST_FIRST;
-            case NAME_Z_TO_A:
-                return NAME_A_TO_Z;
-            case PROJECT_A_TO_Z:
-                return NAME_Z_TO_A;
-            case PROJECT_Z_TO_A:
-                return PROJECT_A_TO_Z;
-            case STATUS_NOT_STARTED:
-                return PROJECT_Z_TO_A;
-            case STATUS_FINISHED:
-                return STATUS_NOT_STARTED;
-            case NEWEST_FIRST:
-                return STATUS_FINISHED;
-            case OLDEST_FIRST:
-                return NEWEST_FIRST;
-        }
-    }
 }
diff --git a/buildsystem-api/src/main/java/de/eintosti/buildsystem/api/player/settings/DesignColor.java b/buildsystem-api/src/main/java/de/eintosti/buildsystem/api/player/settings/DesignColor.java
@@ -17,6 +17,9 @@
  */
 package de.eintosti.buildsystem.api.player.settings;
 
+/**
+ * A {@link DesignColor} is the color which glass panes are tinted to in different menus.
+ */
 public enum DesignColor {
     RED,
     ORANGE,
@@ -35,6 +38,12 @@ public enum DesignColor {
     LIGHT_GRAY,
     BLACK;
 
+    /**
+     * Gets the {@link DesignColor} from a string.
+     *
+     * @param colorName The name of the color
+     * @return The {@link DesignColor} or {@link DesignColor#BLACK} if the color does not exist
+     */
     public static DesignColor matchColor(String colorName) {
         try {
             return valueOf(colorName);
diff --git a/buildsystem-api/src/main/java/de/eintosti/buildsystem/api/world/data/BuildWorldStatus.java b/buildsystem-api/src/main/java/de/eintosti/buildsystem/api/world/data/BuildWorldStatus.java
@@ -18,7 +18,6 @@
 package de.eintosti.buildsystem.api.world.data;
 
 import de.eintosti.buildsystem.api.world.BuildWorld;
-
 import java.util.Locale;
 import org.jetbrains.annotations.ApiStatus.Internal;
 
@@ -52,15 +51,15 @@ public enum BuildWorldStatus {
     ARCHIVE("status_archive", 5),
 
     /**
-     * Represents a world that is not shown in the navigator.
+     * Represents a world not shown in the navigator.
      */
     HIDDEN("status_hidden", 6);
 
-    private final String key;
+    private final String messageKey;
     private final int stage;
 
-    BuildWorldStatus(String key, int stage) {
-        this.key = key;
+    BuildWorldStatus(String messageKey, int stage) {
+        this.messageKey = messageKey;
         this.stage = stage;
     }
 
@@ -70,8 +69,8 @@ public enum BuildWorldStatus {
      * @return The type's display name
      */
     @Internal
-    public String getKey() {
-        return key;
+    public String getMessageKey() {
+        return messageKey;
     }
 
     /**
diff --git a/buildsystem-api/src/main/java/de/eintosti/buildsystem/api/world/data/BuildWorldType.java b/buildsystem-api/src/main/java/de/eintosti/buildsystem/api/world/data/BuildWorldType.java
@@ -19,6 +19,7 @@
 
 import org.bukkit.World.Environment;
 import org.jetbrains.annotations.ApiStatus.Internal;
+import org.jetbrains.annotations.Nullable;
 
 public enum BuildWorldType {
 
@@ -72,19 +73,20 @@ public enum BuildWorldType {
      */
     UNKNOWN(null);
 
-    private final String key;
+    private final String messageKey;
 
-    BuildWorldType(String key) {
-        this.key = key;
+    BuildWorldType(String messageKey) {
+        this.messageKey = messageKey;
     }
 
     /**
-     * Get the display name of the {@link BuildWorldType}.
+     * Get the message key for the {@link BuildWorldType}'s display name.
      *
-     * @return The type's display name
+     * @return The type's display name message key, or {@code null} for {@link #IMPORTED} and {@link #UNKNOWN}
      */
     @Internal
-    public String getKey() {
-        return key;
+    @Nullable
+    public String getMessageKey() {
+        return messageKey;
     }
 }
diff --git a/buildsystem-core/src/main/java/de/eintosti/buildsystem/command/subcommand/worlds/InfoSubCommand.java b/buildsystem-core/src/main/java/de/eintosti/buildsystem/command/subcommand/worlds/InfoSubCommand.java
@@ -65,13 +65,13 @@ public void execute(Player player, String[] args) {
                 new AbstractMap.SimpleEntry<>("%world%", buildWorld.getName()),
                 new AbstractMap.SimpleEntry<>("%creator%", getCreator(builders)),
                 new AbstractMap.SimpleEntry<>("%item%", worldData.material().get().name()),
-                new AbstractMap.SimpleEntry<>("%type%", Messages.getString(buildWorld.getType().getKey(), player)),
+                new AbstractMap.SimpleEntry<>("%type%", Messages.getString(buildWorld.getType().getMessageKey(), player)),
                 new AbstractMap.SimpleEntry<>("%private%", worldData.privateWorld().get()),
                 new AbstractMap.SimpleEntry<>("%builders_enabled%", worldData.buildersEnabled().get()),
                 new AbstractMap.SimpleEntry<>("%builders%", builders.asPlaceholder(player)),
                 new AbstractMap.SimpleEntry<>("%block_breaking%", worldData.blockBreaking().get()),
                 new AbstractMap.SimpleEntry<>("%block_placement%", worldData.blockPlacement().get()),
-                new AbstractMap.SimpleEntry<>("%status%", Messages.getString(worldData.status().get().getKey(), player)),
+                new AbstractMap.SimpleEntry<>("%status%", Messages.getString(worldData.status().get().getMessageKey(), player)),
                 new AbstractMap.SimpleEntry<>("%project%", worldData.project().get()),
                 new AbstractMap.SimpleEntry<>("%permission%", worldData.permission().get()),
                 new AbstractMap.SimpleEntry<>("%time%", buildWorld.getWorldTime()),
diff --git a/buildsystem-core/src/main/java/de/eintosti/buildsystem/expansion/placeholderapi/PlaceholderApiExpansion.java b/buildsystem-core/src/main/java/de/eintosti/buildsystem/expansion/placeholderapi/PlaceholderApiExpansion.java
@@ -233,11 +233,11 @@ private String parseBuildWorldPlaceholder(Player player, String identifier) {
             case "spawn":
                 return worldData.customSpawn().get();
             case "status":
-                return Messages.getString(worldData.status().get().getKey(), player);
+                return Messages.getString(worldData.status().get().getMessageKey(), player);
             case "time":
                 return buildWorld.getWorldTime();
             case "type":
-                return Messages.getString(buildWorld.getType().getKey(), player);
+                return Messages.getString(buildWorld.getType().getMessageKey(), player);
             case "world":
                 return buildWorld.getName();
             default:
diff --git a/buildsystem-core/src/main/java/de/eintosti/buildsystem/navigator/inventory/FilteredWorldsInventory.java b/buildsystem-core/src/main/java/de/eintosti/buildsystem/navigator/inventory/FilteredWorldsInventory.java
@@ -45,6 +45,7 @@
 import java.util.ArrayList;
 import java.util.List;
 import java.util.Set;
+import java.util.function.Function;
 import org.bukkit.Bukkit;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
@@ -160,7 +161,7 @@ private void addWorlds(Player player) {
     private void addWorldSortItem(Inventory inventory, Player player) {
         Settings settings = settingsManager.getSettings(player);
         WorldSort worldSort = settings.getWorldDisplay().getWorldSort();
-        inventory.setItem(45, InventoryUtils.createItem(XMaterial.BOOK, Messages.getString("world_sort_title", player), Messages.getString(worldSort.getKey(), player)));
+        inventory.setItem(45, InventoryUtils.createItem(XMaterial.BOOK, Messages.getString("world_sort_title", player), Messages.getString(worldSort.getMessageKey(), player)));
     }
 
     private void addWorldFilterItem(Inventory inventory, Player player) {
@@ -223,9 +224,8 @@ public void onInventoryClick(InventoryClickEvent event) {
 
         switch (event.getSlot()) {
             case 45:
-                WorldSort newSort = event.isLeftClick()
-                        ? worldDisplay.getWorldSort().getNext()
-                        : worldDisplay.getWorldSort().getPrevious();
+                Function<WorldSort, WorldSort> newSortFunction = event.isLeftClick() ? this::getNextSort : this::getPreviousSort;
+                WorldSort newSort = newSortFunction.apply(worldDisplay.getWorldSort());
                 worldDisplay.setWorldSort(newSort);
                 openInventory(player);
                 return;
@@ -271,6 +271,48 @@ public void onInventoryClick(InventoryClickEvent event) {
         manageInventoryClick(event, player, itemStack);
     }
 
+    private WorldSort getNextSort(WorldSort sort) {
+        switch (sort) {
+            case NEWEST_FIRST:
+                return WorldSort.OLDEST_FIRST;
+            case OLDEST_FIRST:
+                return WorldSort.NAME_A_TO_Z;
+            case PROJECT_A_TO_Z:
+                return WorldSort.PROJECT_Z_TO_A;
+            case PROJECT_Z_TO_A:
+                return WorldSort.STATUS_NOT_STARTED;
+            case STATUS_NOT_STARTED:
+                return WorldSort.STATUS_FINISHED;
+            case STATUS_FINISHED:
+                return WorldSort.NEWEST_FIRST;
+            case NAME_Z_TO_A:
+                return WorldSort.PROJECT_A_TO_Z;
+            default: // NAME_A_TO_Z
+                return WorldSort.NAME_Z_TO_A;
+        }
+    }
+
+    public WorldSort getPreviousSort(WorldSort sort) {
+        switch (sort) {
+            case NEWEST_FIRST:
+                return WorldSort.STATUS_FINISHED;
+            case OLDEST_FIRST:
+                return WorldSort.NEWEST_FIRST;
+            case PROJECT_A_TO_Z:
+                return WorldSort.NAME_Z_TO_A;
+            case PROJECT_Z_TO_A:
+                return WorldSort.PROJECT_A_TO_Z;
+            case STATUS_NOT_STARTED:
+                return WorldSort.PROJECT_Z_TO_A;
+            case STATUS_FINISHED:
+                return WorldSort.STATUS_NOT_STARTED;
+            case NAME_Z_TO_A:
+                return WorldSort.NAME_A_TO_Z;
+            default: // NAME_A_TO_Z
+                return WorldSort.OLDEST_FIRST;
+        }
+    }
+
     /**
      * Manage clicking in a {@link FilteredWorldsInventory}.
      * <p>
diff --git a/buildsystem-core/src/main/java/de/eintosti/buildsystem/player/settings/SettingsManager.java b/buildsystem-core/src/main/java/de/eintosti/buildsystem/player/settings/SettingsManager.java
@@ -163,7 +163,7 @@ private String parseWorldInformation(Player player, BuildWorld buildWorld, Strin
         WorldData worldData = buildWorld.getData();
         switch (input) {
             case "%status%":
-                return Messages.getString(worldData.status().get().getKey(), player);
+                return Messages.getString(worldData.status().get().getMessageKey(), player);
             case "%permission%":
                 return worldData.permission().get();
             case "%project%":
diff --git a/buildsystem-core/src/main/java/de/eintosti/buildsystem/world/BuildWorldImpl.java b/buildsystem-core/src/main/java/de/eintosti/buildsystem/world/BuildWorldImpl.java
@@ -169,7 +169,7 @@ public String getDisplayName(Player player) {
     public List<String> getLore(Player player) {
         @SuppressWarnings("unchecked")
         Map.Entry<String, Object>[] placeholders = new Map.Entry[]{
-                new AbstractMap.SimpleEntry<>("%status%", Messages.getString(worldData.status().get().getKey(), player)),
+                new AbstractMap.SimpleEntry<>("%status%", Messages.getString(worldData.status().get().getMessageKey(), player)),
                 new AbstractMap.SimpleEntry<>("%project%", worldData.project().get()),
                 new AbstractMap.SimpleEntry<>("%permission%", worldData.permission().get()),
                 new AbstractMap.SimpleEntry<>("%creator%", builders.hasCreator() ? builders.getCreator().getName() : "-"),
diff --git a/buildsystem-core/src/main/java/de/eintosti/buildsystem/world/creation/BuildWorldCreatorImpl.java b/buildsystem-core/src/main/java/de/eintosti/buildsystem/world/creation/BuildWorldCreatorImpl.java
@@ -173,7 +173,7 @@ private void createPredefinedOrCustomWorld(Player player) {
 
         Messages.sendMessage(player, "worlds_world_creation_started",
                 new AbstractMap.SimpleEntry<>("%world%", worldName),
-                new AbstractMap.SimpleEntry<>("%type%", Messages.getString(worldType.getKey(), player))
+                new AbstractMap.SimpleEntry<>("%type%", Messages.getString(worldType.getMessageKey(), player))
         );
         finishPreparationsAndGenerate(buildWorld);
         teleportAfterCreation(player);
diff --git a/buildsystem-core/src/main/java/de/eintosti/buildsystem/world/data/StatusInventory.java b/buildsystem-core/src/main/java/de/eintosti/buildsystem/world/data/StatusInventory.java
@@ -87,7 +87,7 @@ private void fillGuiWithGlass(Player player, Inventory inventory) {
 
     private void addStatusItem(Player player, Inventory inventory, int position, BuildWorldStatus status) {
         XMaterial material = plugin.getCustomizableIcons().getIcon(status);
-        String displayName = Messages.getString(status.getKey(), player);
+        String displayName = Messages.getString(status.getMessageKey(), player);
 
         if (!player.hasPermission(status.getPermission())) {
             material = XMaterial.BARRIER;
@@ -161,7 +161,7 @@ public void onInventoryClick(InventoryClickEvent event) {
         XSound.ENTITY_CHICKEN_EGG.play(player);
         Messages.sendMessage(player, "worlds_setstatus_set",
                 new AbstractMap.SimpleEntry<>("%world%", buildWorld.getName()),
-                new AbstractMap.SimpleEntry<>("%status%", Messages.getString(status.getKey(), player))
+                new AbstractMap.SimpleEntry<>("%status%", Messages.getString(status.getMessageKey(), player))
         );
     }
 
diff --git a/buildsystem-core/src/main/java/de/eintosti/buildsystem/world/modification/EditInventory.java b/buildsystem-core/src/main/java/de/eintosti/buildsystem/world/modification/EditInventory.java
@@ -112,7 +112,7 @@ public Inventory getInventory(Player player, BuildWorld buildWorld) {
         addDifficultyItem(player, inventory, buildWorld);
         inventory.setItem(40, InventoryUtils.createItem(plugin.getCustomizableIcons().getIcon(worldData.status().get()), Messages.getString("worldeditor_status_item", player),
                 Messages.getStringList("worldeditor_status_lore", player,
-                        new AbstractMap.SimpleEntry<>("%status%", Messages.getString(buildWorld.getData().status().get().getKey(), player))
+                        new AbstractMap.SimpleEntry<>("%status%", Messages.getString(buildWorld.getData().status().get().getMessageKey(), player))
                 )
         ));
         inventory.setItem(41, InventoryUtils.createItem(XMaterial.ANVIL, Messages.getString("worldeditor_project_item", player),

Original file line number	Diff line number	Diff line change
`@@ -19,6 +19,7 @@`
`19`	`19`
`20`	`20`	`import de.eintosti.buildsystem.api.world.BuildWorld;`
`21`	`21`	`import java.util.function.Predicate;`
	`22`	`+import org.jetbrains.annotations.ApiStatus.Internal;`
`22`	`23`
`23`	`24`	`public interface WorldFilter {`
`24`	`25`
`@@ -34,6 +35,7 @@ enum Mode {`
`34`	`35`	`this.loreKey = loreKey;`
`35`	`36`	`}`
`36`	`37`
	`38`	`+ @Internal`
`37`	`39`	`public String getLoreKey() {`
`38`	`40`	`return loreKey;`
`39`	`41`	`}`