that's what we call "memory leak" here - YHT

Author: RhythmicSys

pom.xml

@@ -66,7 +66,6 @@
             <id>sonatype</id>
             <url>https://oss.sonatype.org/content/groups/public/</url>
         </repository>
-
     </repositories>
 
     <dependencies>

src/main/java/adhdmc/simplepms/SimplePMs.java

@@ -12,6 +12,7 @@
 import org.bukkit.plugin.java.JavaPlugin;
 
 import java.util.HashSet;
+import java.util.Objects;
 
 public final class SimplePMs extends JavaPlugin {
 
@@ -45,12 +46,13 @@ public static boolean isPapiEnabled() {
     }
 
     private void registerCommands() {
-        this.getCommand("msg").setExecutor(new PrivateMessage());
-        this.getCommand("reply").setExecutor(new ReplyCommand());
-        this.getCommand("socialspy").setExecutor(new SocialSpyCommand());
-        this.getCommand("spmreload").setExecutor(new ReloadCommand());
+        Objects.requireNonNull(this.getCommand("msg")).setExecutor(new PrivateMessage());
+        Objects.requireNonNull(this.getCommand("reply")).setExecutor(new ReplyCommand());
+        Objects.requireNonNull(this.getCommand("socialspy")).setExecutor(new SocialSpyCommand());
+        Objects.requireNonNull(this.getCommand("spmreload")).setExecutor(new ReloadCommand());
     }
 
+
     private static final HashSet<Player> spyingPlayers = new HashSet<>();
 
     public static HashSet<Player> getSpyingPlayers() {

src/main/java/adhdmc/simplepms/config/LocaleConfig.java

@@ -23,11 +23,19 @@ private LocaleConfig() {
         reloadLocale();
     }
 
+    /**
+     * Gets the LocaleConfig instance, instantiates it if it has not been already
+     * @return LocaleConfig
+     */
     public static LocaleConfig getInstance() {
         if (instance == null) instance = new LocaleConfig();
         return instance;
     }
 
+    /**
+     * gets the Locale config
+     * @return FileConfiguration
+     */
     public FileConfiguration getLocale() { return localeConfig; }
 
     /**

src/main/java/adhdmc/simplepms/events/PrivateMessageEvent.java

@@ -7,9 +7,19 @@
 import org.bukkit.event.HandlerList;
 import org.jetbrains.annotations.NotNull;
 
+import java.util.Collections;
 import java.util.HashSet;
+import java.util.Set;
 
+/**
+ * Called when a private message is sent
+ */
 public class PrivateMessageEvent extends Event implements Cancellable {
+    private final CommandSender initiator;
+    private final CommandSender recipient;
+    private final String messageContent;
+    private final HashSet<Player> spyingPlayers;
+    private boolean cancelled;
     private static final HandlerList handlers = new HandlerList();
     public PrivateMessageEvent(CommandSender initiator, CommandSender recipient, String messageContent, HashSet<Player> spyingPlayers) {
         this.initiator = initiator;
@@ -21,36 +31,59 @@ public PrivateMessageEvent(CommandSender initiator, CommandSender recipient, Str
     public @NotNull HandlerList getHandlers() {
         return handlers;
     }
+
+    /**
+     * Gets the handlerList for this event
+     * @return HandlerList
+     */
     public static HandlerList getHandlerList() {
         return handlers;
     }
 
-    private CommandSender initiator;
-    private CommandSender recipient;
-    private String messageContent;
-    private HashSet<Player> spyingPlayers;
-    private boolean cancelled;
-
+    /**
+     * Gets the CommandSender who sent the message
+     * @return CommandSender
+     */
     public CommandSender getInitiator() {
         return initiator;
     }
 
+    /**
+     * Gets the CommandSender who is to receive the message
+     * @return CommandSender
+     */
     public CommandSender getRecipient() {
         return recipient;
     }
 
+    /**
+     * Gets the content of the message being sent
+     * @return String
+     */
     public String getMessageContent() {
         return messageContent;
     }
 
-    public HashSet<Player> getSpyingPlayers() {
-        return spyingPlayers;
+    /**
+     * Gets the list of players who currently have SocialSpy toggled on
+     * @return {@code Set<Player>}
+     */
+    public Set<Player> getSpyingPlayers() {
+        return Collections.unmodifiableSet(spyingPlayers);
     }
 
+    /**
+     * Checks whether this event has been cancelled
+     * @return boolean
+     */
     public boolean isCancelled() {
         return cancelled;
     }
 
+    /**
+     * Sets whether this event should be cancelled
+     * @param cancel boolean
+     */
     public void setCancelled(boolean cancel) {
         cancelled = cancel;
     }

src/main/java/adhdmc/simplepms/handling/MessageHandling.java

@@ -26,10 +26,23 @@ public static MessageHandling getInstance() {
     NamespacedKey lastMessaged = SPMKey.LAST_MESSAGED.getKey();
     Component consoleChatComponent = SimplePMs.getMiniMessage().deserialize(Message.CONSOLE_FORMAT.getMessage());
     Component consoleSpyComponent = SimplePMs.getMiniMessage().deserialize(Message.CONSOLE_FORMAT_SPY.getMessage());
+
+    /**
+     * Calls the message event and handles socialspy for a message between 2 players.
+     * <br>Sends messageContent to Resolvers.
+     * <br>Uses Message keys:
+     * <ul><li>RECEIVING_FORMAT
+     * <li>SENDING_FORMAT
+     * <li>SPY_FORMAT</ul>
+     * @param initiator Player
+     * @param recipient Player
+     * @param messageContent String
+     */
     public void playerSenderAndReceiver(Player initiator, Player recipient, String messageContent) {
         // Calls private message event so other plugins can interact with this
         PrivateMessageEvent event = new PrivateMessageEvent(initiator, recipient, messageContent, spyingPlayers);
         Bukkit.getServer().getPluginManager().callEvent(event);
+        if (event.isCancelled()) return;
         initiator.getPersistentDataContainer().set(lastMessaged, PersistentDataType.STRING, recipient.getName());
         recipient.getPersistentDataContainer().set(lastMessaged, PersistentDataType.STRING, initiator.getName());
         initiator.sendMessage(Resolvers.getInstance().parseMessagePlayerToPlayer(Message.SENDING_FORMAT.getMessage(), initiator, recipient, messageContent));
@@ -41,10 +54,24 @@ public void playerSenderAndReceiver(Player initiator, Player recipient, String m
         }
     }
 
+    /**
+     * Calls the message event and handles socialspy for a message sent by the console, and received by a player
+     * <br>Sends messageContent to Resolvers.
+     * <br>Uses Message keys:
+     * <ul><li>RECEIVING_FORMAT
+     * <li>SENDING_FORMAT
+     * <li>CONSOLE_FORMAT
+     * <li>SPY_FORMAT
+     * <li>CONSOLE_FORMAT_SPY</ul>
+     * @param initiator CommandSender
+     * @param recipient Player
+     * @param messageContent String
+     */
     public void consoleSenderPlayerReceiver(CommandSender initiator, Player recipient, String messageContent) {
         // Call Event
         PrivateMessageEvent event = new PrivateMessageEvent(initiator, recipient, messageContent, spyingPlayers);
         Bukkit.getServer().getPluginManager().callEvent(event);
+        if (event.isCancelled()) return;
         recipient.getPersistentDataContainer().set(lastMessaged, PersistentDataType.STRING, Message.PDC_CONSOLE.getMessage());
         recipient.sendMessage(Resolvers.getInstance().parseMessageConsoleToPlayer(Message.RECEIVING_FORMAT.getMessage(), consoleChatComponent, recipient, messageContent));
         initiator.sendMessage(Resolvers.getInstance().parseMessageConsoleToPlayer(Message.SENDING_FORMAT.getMessage(), consoleChatComponent, recipient, messageContent));
@@ -57,6 +84,19 @@ public void consoleSenderPlayerReceiver(CommandSender initiator, Player recipien
     }
 
 
+    /**
+     * Calls the message event and handles socialspy for a message sent by a player to the console.
+     * <br>Sends messageContent to Resolvers.
+     * <br>Uses Message keys:
+     * <ul><li>ERROR_PLAYER_COMMAND
+     * <li>SENDING_FORMAT
+     * <li>CONSOLE_FORMAT
+     * <li>SPY_FORMAT
+     * <li>CONSOLE_FORMAT_SPY</ul>
+     * @param initiator CommandSender
+     * @param messageContent String
+     */
+
     public void playerSenderConsoleReceiver(CommandSender initiator, String messageContent) {
         if (!(initiator instanceof Player initiatingPlayer)){
             initiator.sendMessage(Resolvers.getInstance().parsePluginPrefix(Message.ERROR_PLAYER_COMMAND.getMessage()));
@@ -65,6 +105,7 @@ public void playerSenderConsoleReceiver(CommandSender initiator, String messageC
         // Call Event
         PrivateMessageEvent event = new PrivateMessageEvent(initiator, Bukkit.getConsoleSender(), messageContent, spyingPlayers);
         Bukkit.getServer().getPluginManager().callEvent(event);
+        if (event.isCancelled()) return;
         initiatingPlayer.getPersistentDataContainer().set(lastMessaged, PersistentDataType.STRING, Message.PDC_CONSOLE.getMessage());
         initiatingPlayer.sendMessage(Resolvers.getInstance().parseMessagePlayerToConsole(Message.SENDING_FORMAT.getMessage(), initiatingPlayer, consoleChatComponent, messageContent));
         for (Player spy : spyingPlayers) {

src/main/java/adhdmc/simplepms/handling/Resolvers.java

@@ -41,6 +41,20 @@ public static Resolvers getInstance() {
         });
     }
 
+
+    /**
+     * Parses a message between 2 players. Will parse PAPI placeholders if placeholderAPI is on the server
+     * Uses the default placeholders:
+     * <ul><li>{@code <plugin_prefix>}
+     * <li>{@code <target>}
+     * <li>{@code <initiator>}
+     * <li>{@code <message>}</ul>
+     * @param message String
+     * @param initiator Player
+     * @param target Player
+     * @param messageContent String
+     * @return Component
+     */
     public Component parseMessagePlayerToPlayer(String message, Player initiator, Player target, String messageContent){
         if (papiEnabled) {
             return miniMessage.deserialize(message,
@@ -59,6 +73,20 @@ public Component parseMessagePlayerToPlayer(String message, Player initiator, Pl
         }
     }
 
+    /**
+     * Parses a message from the console to a player. Will parse PAPI placeholders if placeholderAPI is on the server
+     * Uses the default placeholders:
+     * <ul><li>{@code <plugin_prefix>}
+     * <li>{@code <target>}
+     * <li>{@code <initiator>}
+     * <li>{@code <message>}</ul>
+     * @param message String
+     * @param initiator Component
+     * @param target Player
+     * @param messageContent String
+     * @return Component
+     */
+
     public Component parseMessageConsoleToPlayer(String message, Component initiator, Player target, String messageContent){
         if (papiEnabled) {
             return miniMessage.deserialize(message,
@@ -76,6 +104,20 @@ public Component parseMessageConsoleToPlayer(String message, Component initiator
         }
     }
 
+    /**
+     * Parses a message from a Player to the Console. Will parse PAPI placeholders if placeholderAPI is on the server
+     * Uses the default placeholders:
+     * <ul><li>{@code <plugin_prefix>}
+     * <li>{@code <target>}
+     * <li>{@code <initiator>}
+     * <li>{@code <message>}</ul>
+     * @param message String
+     * @param initiator Player
+     * @param target Component
+     * @param messageContent String
+     * @return Component
+     */
+
     public Component parseMessagePlayerToConsole(String message, Player initiator, Component target, String messageContent){
         if(papiEnabled) {
             return miniMessage.deserialize(message,
@@ -93,12 +135,27 @@ public Component parseMessagePlayerToConsole(String message, Player initiator, C
         }
     }
 
-
+    /**
+     * Parses the placeholder for the plugin prefix from the given message
+     * Uses the default placeholders:
+     * <ul><li>{@code <plugin_prefix>}</ul>
+     * @param message String
+     * @return Component
+     */
     public Component parsePluginPrefix(String message) {
         return miniMessage.deserialize(message,
                 Placeholder.parsed("plugin_prefix", Message.PLUGIN_PREFIX.getMessage()));
     }
 
+    /**
+     * Parses the plugin prefix and an additional placeholder, using the provided 'placeholderName' and 'string'
+     * Uses the default placeholders:
+     * <ul><li>{@code <plugin_prefix>}</ul>
+     * @param message String
+     * @param placeholderName String
+     * @param string String
+     * @return Component
+     */
     public Component parsePluginPrefixAndString(String message,String placeholderName, String string) {
         return miniMessage.deserialize(message,
                 Placeholder.parsed("plugin_prefix", Message.PLUGIN_PREFIX.getMessage()),

src/main/java/adhdmc/simplepms/listeners/LoginListener.java

@@ -7,6 +7,7 @@
 import org.bukkit.NamespacedKey;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
 import org.bukkit.event.Listener;
 import org.bukkit.event.player.PlayerLoginEvent;
 import org.bukkit.persistence.PersistentDataContainer;
@@ -18,7 +19,11 @@ public class LoginListener implements Listener {
     private final HashSet<Player> spyingPlayers = SimplePMs.getSpyingPlayers();
     private final NamespacedKey spyToggle = SPMKey.SPY_TOGGLE.getKey();
 
-    @EventHandler
+    /**
+     * Adds players to the 'spyingPlayers' set on login. Requires the social spy permission, and having toggled socialspy on
+     * @param loginEvent PlayerLoginEvent
+     */
+    @EventHandler(priority = EventPriority.NORMAL)
     public void onPlayerLogin(PlayerLoginEvent loginEvent) {
         Bukkit.getScheduler().runTaskLater(SimplePMs.getInstance(), ()-> {
             Player player = loginEvent.getPlayer();

src/main/java/adhdmc/simplepms/listeners/QuitListener.java

@@ -0,0 +1,24 @@
+package adhdmc.simplepms.listeners;
+
+import adhdmc.simplepms.SimplePMs;
+import org.bukkit.entity.Player;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.EventPriority;
+import org.bukkit.event.Listener;
+import org.bukkit.event.player.PlayerQuitEvent;
+
+import java.util.HashSet;
+
+public class QuitListener implements Listener {
+    private final HashSet<Player> spyingPlayers = SimplePMs.getSpyingPlayers();
+
+    /**
+     * Clears players from spyingPlayers when they quit the game
+     * @param quitEvent PlayerQuitEvent
+     */
+    @EventHandler(priority = EventPriority.NORMAL)
+    public void onPlayerQuit(PlayerQuitEvent quitEvent) {
+        Player player = quitEvent.getPlayer();
+        spyingPlayers.remove(player);
+    }
+}