Fix deprecated PlayerSpawnChangeEvent by migrating to dynamic listener

Author: benwoo1110

src/main/java/org/mvplugins/multiverse/inventories/MultiverseInventories.java

@@ -16,9 +16,8 @@
 import org.mvplugins.multiverse.inventories.dataimport.DataImportManager;
 import org.mvplugins.multiverse.inventories.dataimport.DataImporter;
 import org.mvplugins.multiverse.inventories.destination.LastLocationDestination;
-import org.mvplugins.multiverse.inventories.handleshare.ShareHandleListener;
 import org.mvplugins.multiverse.inventories.handleshare.SingleShareWriter;
-import org.mvplugins.multiverse.inventories.handleshare.SpawnChangeListener;
+import org.mvplugins.multiverse.inventories.listeners.MVInvListener;
 import org.mvplugins.multiverse.inventories.handleshare.WriteOnlyShareHandler;
 import org.mvplugins.multiverse.inventories.profile.PlayerNamesMapper;
 import org.mvplugins.multiverse.inventories.profile.ProfileCacheManager;
@@ -55,12 +54,6 @@ public class MultiverseInventories extends MultiverseModule {
     @Inject
     private Provider<InventoriesConfig> inventoriesConfig;
     @Inject
-    private Provider<ShareHandleListener> shareHandleListener;
-    @Inject
-    private Provider<RespawnListener> respawnListener;
-    @Inject
-    private Provider<MVEventsListener> mvEventsListener;
-    @Inject
     private Provider<WorldGroupManager> worldGroupManager;
     @Inject
     private Provider<PlayerNamesMapper> playerNamesMapperProvider;
@@ -82,7 +75,6 @@ public class MultiverseInventories extends MultiverseModule {
     private Provider<MVInvCommandPermissions> mvInvCommandPermissions;
 
     private InventoriesDupingPatch dupingPatch;
-    private boolean usingSpawnChangeEvent = false;
 
     public MultiverseInventories() {
         super();
@@ -114,7 +106,7 @@ public final void onEnable() {
         inventoriesConfig.get().save().onFailure(e -> Logging.severe("Failed to save config file!"));
 
         // Register Stuff
-        this.registerEvents();
+        this.registerDynamicListeners(MVInvListener.class);
         this.setUpLocales();
         this.registerCommands();
         this.registerDestinations();
@@ -160,23 +152,6 @@ public void onDisable() {
         Logging.shutdown();
     }
 
-    private void registerEvents() {
-        PluginManager pluginManager = this.getServer().getPluginManager();
-        pluginManager.registerEvents(shareHandleListener.get(), this);
-        pluginManager.registerEvents(respawnListener.get(), this);
-        pluginManager.registerEvents(mvEventsListener.get(), this);
-        if (inventoriesConfig.get().getUseImprovedRespawnLocationDetection()) {
-            try {
-                Class.forName("org.bukkit.event.player.PlayerSpawnChangeEvent");
-                pluginManager.registerEvents(new SpawnChangeListener(this), this);
-                usingSpawnChangeEvent = true;
-                Logging.fine("Yayy PlayerSpawnChangeEvent will be used!");
-            } catch (ClassNotFoundException e) {
-                Logging.fine("PlayerSpawnChangeEvent will not be used!");
-            }
-        }
-    }
-
     private void registerCommands() {
         Try.run(() -> {
             mvInvCommandCompletion.get();
@@ -259,8 +234,4 @@ public void reloadConfig() {
             worldGroupManager.get().checkForConflicts(null);
         }, 1L);
     }
-
-    public boolean isUsingSpawnChangeEvent() {
-        return usingSpawnChangeEvent;
-    }
 }

src/main/java/org/mvplugins/multiverse/inventories/handleshare/GameModeShareHandler.java

@@ -19,7 +19,7 @@
 /**
  * GameMode change implementation of ShareHandler.
  */
-final class GameModeShareHandler extends ShareHandler {
+public final class GameModeShareHandler extends ShareHandler {
 
     private final GameMode fromGameMode;
     private final GameMode toGameMode;
@@ -28,7 +28,7 @@ final class GameModeShareHandler extends ShareHandler {
     private final String world;
     private final List<WorldGroup> worldGroups;
 
-    GameModeShareHandler(MultiverseInventories inventories, Player player,
+    public GameModeShareHandler(MultiverseInventories inventories, Player player,
                          GameMode fromGameMode, GameMode toGameMode) {
         super(inventories, player);
         this.fromGameMode = fromGameMode;

src/main/java/org/mvplugins/multiverse/inventories/handleshare/SpawnChangeListener.java

@@ -16,14 +16,14 @@
 /**
  * WorldChange implementation of ShareHandler.
  */
-final class WorldChangeShareHandler extends ShareHandler {
+public final class WorldChangeShareHandler extends ShareHandler {
 
     private final String fromWorld;
     private final String toWorld;
     private final List<WorldGroup> fromWorldGroups;
     private final List<WorldGroup> toWorldGroups;
 
-    WorldChangeShareHandler(MultiverseInventories inventories, Player player, String fromWorld, String toWorld) {
+    public WorldChangeShareHandler(MultiverseInventories inventories, Player player, String fromWorld, String toWorld) {
         super(inventories, player);
         this.fromWorld = fromWorld;
         this.toWorld = toWorld;

src/main/java/org/mvplugins/multiverse/inventories/handleshare/WorldChangeShareHandler.java

@@ -1,24 +1,23 @@
-package org.mvplugins.multiverse.inventories;
+package org.mvplugins.multiverse.inventories.listeners;
 
 import com.dumptruckman.minecraft.util.Logging;
-import org.bukkit.event.EventHandler;
-import org.bukkit.event.Listener;
 import org.jetbrains.annotations.NotNull;
 import org.jvnet.hk2.annotations.Service;
+import org.mvplugins.multiverse.core.dynamiclistener.annotations.EventMethod;
 import org.mvplugins.multiverse.core.event.MVConfigReloadEvent;
 import org.mvplugins.multiverse.core.event.MVDebugModeEvent;
 import org.mvplugins.multiverse.core.event.MVDumpsDebugInfoEvent;
 import org.mvplugins.multiverse.external.jakarta.inject.Inject;
+import org.mvplugins.multiverse.inventories.MultiverseInventories;
 import org.mvplugins.multiverse.inventories.config.InventoriesConfig;
 import org.mvplugins.multiverse.inventories.profile.ProfileCacheManager;
-import org.mvplugins.multiverse.inventories.profile.ProfileDataSource;
 import org.mvplugins.multiverse.inventories.profile.group.WorldGroup;
 import org.mvplugins.multiverse.inventories.profile.group.WorldGroupManager;
 
 import java.io.File;
 
 @Service
-final class MVEventsListener implements Listener {
+final class MVEventsListener implements MVInvListener {
 
     private final MultiverseInventories inventories;
     private final InventoriesConfig config;
@@ -42,7 +41,7 @@ final class MVEventsListener implements Listener {
      *
      * @param event The MVVersionEvent that this plugin will listen for.
      */
-    @EventHandler
+    @EventMethod
     void dumpsDebugInfoRequest(MVDumpsDebugInfoEvent event) {
         event.appendDebugInfo(getDebugInfo());
         File configFile = new File(this.inventories.getDataFolder(), "config.yml");
@@ -94,7 +93,7 @@ private String getDebugInfo() {
         return versionInfo.toString();
     }
 
-    @EventHandler
+    @EventMethod
     void onDebugModeChange(MVDebugModeEvent event) {
         Logging.setDebugLevel(event.getLevel());
     }
@@ -104,7 +103,7 @@ void onDebugModeChange(MVDebugModeEvent event) {
      *
      * @param event The MVConfigReloadEvent that this plugin will listen for.
      */
-    @EventHandler
+    @EventMethod
     void configReload(MVConfigReloadEvent event) {
         this.inventories.reloadConfig();
         event.addConfig("Multiverse-Inventories - config.yml");

…iverse/inventories/MVEventsListener.java …entories/listeners/MVEventsListener.javasrc/main/java/org/mvplugins/multiverse/inventories/MVEventsListener.java renamed to src/main/java/org/mvplugins/multiverse/inventories/listeners/MVEventsListener.java src/main/java/org/mvplugins/multiverse/inventories/MVEventsListener.java renamed to src/main/java/org/mvplugins/multiverse/inventories/listeners/MVEventsListener.java

@@ -0,0 +1,8 @@
+package org.mvplugins.multiverse.inventories.listeners;
+
+import org.jvnet.hk2.annotations.Contract;
+import org.mvplugins.multiverse.core.dynamiclistener.DynamicListener;
+
+@Contract
+public sealed interface MVInvListener extends DynamicListener permits MVEventsListener, RespawnListener, ShareHandleListener, SpawnChangeListener {
+}

src/main/java/org/mvplugins/multiverse/inventories/listeners/MVInvListener.java

@@ -1,12 +1,12 @@
-package org.mvplugins.multiverse.inventories;
+package org.mvplugins.multiverse.inventories.listeners;
 
 import org.bukkit.Location;
 import org.bukkit.World;
-import org.bukkit.event.EventHandler;
 import org.bukkit.event.EventPriority;
-import org.bukkit.event.Listener;
 import org.bukkit.event.player.PlayerRespawnEvent;
 import org.jvnet.hk2.annotations.Service;
+import org.mvplugins.multiverse.core.dynamiclistener.annotations.DefaultEventPriority;
+import org.mvplugins.multiverse.core.dynamiclistener.annotations.EventMethod;
 import org.mvplugins.multiverse.core.world.LoadedMultiverseWorld;
 import org.mvplugins.multiverse.core.world.WorldManager;
 import org.mvplugins.multiverse.external.jakarta.inject.Inject;
@@ -19,7 +19,7 @@
  * Specific events for handling player respawns location
  */
 @Service
-final class RespawnListener implements Listener {
+final class RespawnListener implements MVInvListener {
 
     private final WorldGroupManager worldGroupManager;
     private final WorldManager worldManager;
@@ -38,7 +38,8 @@ final class RespawnListener implements Listener {
      *
      * @param event The player respawn event.
      */
-    @EventHandler(priority = EventPriority.LOWEST)
+    @EventMethod
+    @DefaultEventPriority(EventPriority.LOWEST)
     void lowestPriorityRespawn(PlayerRespawnEvent event) {
         if (!event.isBedSpawn()) {
             World world = event.getPlayer().getWorld();
@@ -52,7 +53,8 @@ void lowestPriorityRespawn(PlayerRespawnEvent event) {
      *
      * @param event The player respawn event.
      */
-    @EventHandler(priority = EventPriority.LOW)
+    @EventMethod
+    @DefaultEventPriority(EventPriority.LOW)
     void lowPriorityRespawn(PlayerRespawnEvent event) {
         if (!event.isBedSpawn()) {
             this.handleRespawn(event, EventPriority.LOW);
@@ -64,7 +66,8 @@ void lowPriorityRespawn(PlayerRespawnEvent event) {
      *
      * @param event The player respawn event.
      */
-    @EventHandler(priority = EventPriority.NORMAL)
+    @EventMethod
+    @DefaultEventPriority(EventPriority.NORMAL)
     void normalPriorityRespawn(PlayerRespawnEvent event) {
         if (!event.isBedSpawn()) {
             this.handleRespawn(event, EventPriority.NORMAL);
@@ -76,7 +79,8 @@ void normalPriorityRespawn(PlayerRespawnEvent event) {
      *
      * @param event The player respawn event.
      */
-    @EventHandler(priority = EventPriority.HIGH)
+    @EventMethod
+    @DefaultEventPriority(EventPriority.HIGH)
     void highPriorityRespawn(PlayerRespawnEvent event) {
         if (!event.isBedSpawn()) {
             this.handleRespawn(event, EventPriority.HIGH);
@@ -88,7 +92,8 @@ void highPriorityRespawn(PlayerRespawnEvent event) {
      *
      * @param event The player respawn event.
      */
-    @EventHandler(priority = EventPriority.HIGHEST)
+    @EventMethod
+    @DefaultEventPriority(EventPriority.HIGHEST)
     void highestPriorityRespawn(PlayerRespawnEvent event) {
         if (!event.isBedSpawn()) {
             this.handleRespawn(event, EventPriority.HIGHEST);
@@ -100,7 +105,8 @@ void highestPriorityRespawn(PlayerRespawnEvent event) {
      *
      * @param event The player respawn event.
      */
-    @EventHandler(priority = EventPriority.MONITOR)
+    @EventMethod
+    @DefaultEventPriority(EventPriority.MONITOR)
     void monitorPriorityRespawn(PlayerRespawnEvent event) {
         if (!event.isBedSpawn()) {
             this.handleRespawn(event, EventPriority.MONITOR);