Cleanup, async sql calls, javadocs

Author: RhythmicSys

src/main/java/simplexity/simplepms/SimplePMs.java

@@ -17,6 +17,7 @@
 import simplexity.simplepms.config.ConfigHandler;
 import simplexity.simplepms.listeners.LoginListener;
 import simplexity.simplepms.listeners.PreCommandListener;
+import simplexity.simplepms.listeners.PreLoginListener;
 import simplexity.simplepms.listeners.QuitListener;
 
 import java.util.HashSet;
@@ -32,21 +33,19 @@ public final class SimplePMs extends JavaPlugin {
     private static ConsoleCommandSender consoleSender;
 
 
-
     public static Set<Player> getSpyingPlayers() {
         return spyingPlayers;
     }
 
     @Override
     public void onEnable() {
         instance = this;
-        this.getServer().getPluginManager().registerEvents(new LoginListener(), this);
+        this.getServer().getPluginManager().registerEvents(new PreLoginListener(), this);
         this.getServer().getPluginManager().registerEvents(new QuitListener(), this);
         this.getServer().getPluginManager().registerEvents(new PreCommandListener(), this);
+        this.getServer().getPluginManager().registerEvents(new LoginListener(), this);
         if (this.getServer().getPluginManager().getPlugin("PlaceholderAPI") != null) {
             papiEnabled = true;
-        } else {
-            this.getLogger().info("You do not have PlaceholderAPI loaded on your server. Any PlaceholderAPI placeholders used in this plugin's messages, will not work.");
         }
         consoleSender = this.getServer().getConsoleSender();
         this.saveDefaultConfig();

src/main/java/simplexity/simplepms/events/BlockUserEvent.java

@@ -8,6 +8,7 @@
 import javax.annotation.Nullable;
 import java.util.UUID;
 
+@SuppressWarnings("unused")
 public class BlockUserEvent extends Event implements Cancellable {
     private boolean cancelled;
     private UUID initiatorUuid;
@@ -25,16 +26,34 @@ public BlockUserEvent(@NotNull UUID initiatorUuid, @NotNull UUID blockedPlayerUu
     }
 
 
+    /**
+     * Gets whether this event has been cancelled
+     *
+     * @return boolean Cancelled
+     */
+
     @Override
     public boolean isCancelled() {
         return cancelled;
     }
 
+    /**
+     * Sets whether this event should be cancelled
+     *
+     * @param cancel boolean
+     */
+
     @Override
     public void setCancelled(boolean cancel) {
         this.cancelled = cancel;
     }
 
+    /**
+     * Gets the handlerList for this event
+     *
+     * @return HandlerList
+     */
+
     public @NotNull HandlerList getHandlers() {
         return handlers;
     }
@@ -48,38 +67,90 @@ public static HandlerList getHandlerList() {
         return handlers;
     }
 
+    /**
+     * Gets the UUID of the player doing the blocking
+     * @return UUID
+     */
+
     @NotNull
     public UUID getInitiatorUuid() {
         return initiatorUuid;
     }
 
+    /**
+     * Sets the UUID for which player will have their block list altered
+     * Changing this UUID will change which user has a new player added to their blocked list
+     * This method expects a Player UUID, using andy UUID that does not belong to a player will lead to
+     * unexpected and unsupported behavior
+     *
+     * @param initiatorUuid UUID
+     */
     public void setInitiatorUuid(@NotNull UUID initiatorUuid) {
         this.initiatorUuid = initiatorUuid;
     }
 
+    /**
+     * Gets the UUID of the player being blocked in this event
+     *
+     * @return UUID player Being blocked
+     */
     @NotNull
     public UUID getBlockedPlayerUuid() {
         return blockedPlayerUuid;
     }
 
+    /**
+     * Sets the UUID of which player should be blocked
+     * Changing this UUID will alter which user is being placed into the player's block list
+     * This method expects a Player UUID, using any UUID that does not belong to a player will lead to
+     * unexpected and unsupported behavior
+     *
+     * @param blockedPlayerUuid UUID
+     */
     public void setBlockedPlayerUuid(@NotNull UUID blockedPlayerUuid) {
         this.blockedPlayerUuid = blockedPlayerUuid;
     }
 
+    /**
+     * Gets the name of the player being blocked
+     * This name is not automatically updated when someone's username changes
+     * it is only used as a player-readable identifier for remembering who they blocked and being able to unblock them
+     * All verification is done through UUID
+     *
+     * @return String name
+     */
     @NotNull
     public String getBlockedPlayerName() {
         return blockedPlayerName;
     }
 
+    /**
+     * Sets the name of the player being blocked, as of the current time.
+     * This is solely for player-readable identification
+     * This is used in the block list and in the unblock command, but UUID is used for actual verification.
+     * Display names can be used here
+     * @param blockedPlayerName String name
+     */
     public void setBlockedPlayerName(@NotNull String blockedPlayerName) {
         this.blockedPlayerName = blockedPlayerName;
     }
 
+    /**
+     * Gets the provided reason for blocking. May be null if no reason was provided.
+     *
+     * @return String block reason
+     */
     @Nullable
     public String getBlockReason() {
         return blockReason;
     }
 
+    /**
+     * Sets the reason for blocking the other player.
+     * This is displayed in the user's own blocklist, and when hovering over usernames when unblocking
+     *
+     * @param blockReason String
+     */
     public void setBlockReason(@Nullable String blockReason) {
         this.blockReason = blockReason;
     }

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

@@ -13,6 +13,7 @@
 /**
  * Called when a private message is sent
  */
+@SuppressWarnings("unused")
 public class PrivateMessageEvent extends Event implements Cancellable {
 
     private CommandSender initiator;
@@ -30,7 +31,7 @@ public PrivateMessageEvent(@NotNull CommandSender initiator, @NotNull CommandSen
     }
 
     /**
-     * Gets the CommandSender who sent the message
+     * Gets the CommandSender who sent the message.
      *
      * @return CommandSender
      */
@@ -39,7 +40,11 @@ public CommandSender getInitiator() {
     }
 
     /**
-     * Sets the CommandSender who sent the message
+     * Sets which CommandSender will start this message.
+     * Expected types are either a Player or a ConsoleCommandSender
+     * Using other types of CommandSender may lead to unexpected and unsupported behavior
+     *
+     * @param initiator CommandSender
      */
 
     public void setInitiator(CommandSender initiator) {
@@ -56,24 +61,31 @@ public CommandSender getRecipient() {
     }
 
     /**
-     * Sets the CommandSender who will receive the message
+     * Sets which CommandSender will receive this message.
+     * Expected types are either a Player or a ConsoleCommandSender
+     * Using other types of CommandSender may lead to unexpected and unsupported behavior
+     *
+     * @param recipient CommandSender
      */
 
     public void setRecipient(CommandSender recipient){
         this.recipient = recipient;
     }
 
     /**
-     * Gets the content of the message being sent
+     * Gets the message that is going to be sent from this event
      *
-     * @return String
+     * @return String message
      */
     public String getMessageContent() {
         return messageContent;
     }
 
     /**
-     * Sets the message content
+     * Sets the message that will be sent from this event.
+     * Note that this only affects the actual message content and not the way the message is formatted
+     *
+     * @param messageContent String
      */
 
     public void setMessageContent(String messageContent){
@@ -108,6 +120,12 @@ public void setCancelled(boolean cancel) {
     }
 
 
+    /**
+     * Gets the handlerList for this event
+     *
+     * @return HandlerList
+     */
+
     public @NotNull HandlerList getHandlers() {
         return handlers;
     }

src/main/java/simplexity/simplepms/events/UnblockUserEvent.java

@@ -7,28 +7,45 @@
 
 import java.util.UUID;
 
+@SuppressWarnings("unused")
 public class UnblockUserEvent extends Event implements Cancellable {
     private boolean cancelled;
     private UUID initiatorUuid;
     private UUID blockedPlayerUuid;
     private static final HandlerList handlers = new HandlerList();
 
-    public UnblockUserEvent(UUID initiatorUuid, UUID blockedPlayerUuid){
+    public UnblockUserEvent(UUID initiatorUuid, UUID blockedPlayerUuid) {
         this.initiatorUuid = initiatorUuid;
         this.blockedPlayerUuid = blockedPlayerUuid;
     }
 
+    /**
+     * Gets whether this event has been cancelled
+     * @return boolean Cancelled
+     */
 
     @Override
     public boolean isCancelled() {
         return cancelled;
     }
 
+    /**
+     * Sets whether this event should be cancelled
+     *
+     * @param cancel boolean
+     */
+
     @Override
     public void setCancelled(boolean cancel) {
         this.cancelled = cancel;
     }
 
+    /**
+     * Gets the handler list, idk bukkit requires 2 of these or I'm just doing it wrong
+     *
+     * @return HandlerList
+     */
+
     public @NotNull HandlerList getHandlers() {
         return handlers;
     }
@@ -42,18 +59,39 @@ public static HandlerList getHandlerList() {
         return handlers;
     }
 
+    /**
+     * Gets the UUID of the player who requested to unblock someone
+     *
+     * @return UUID
+     */
     public UUID getInitiatorUuid() {
         return initiatorUuid;
     }
 
+    /**
+     * Sets the UUID of the person who will request to unblock someone
+     *
+     * @param initiatorUuid UUID
+     */
+
     public void setInitiatorUuid(UUID initiatorUuid) {
         this.initiatorUuid = initiatorUuid;
     }
 
+    /**
+     * Gets the UUID of the player who will be unblocked
+     *
+     * @return UUID
+     */
     public UUID getBlockedPlayerUuid() {
         return blockedPlayerUuid;
     }
 
+    /**
+     * Sets the UUID of the player who will be unblocked
+     *
+     * @param blockedPlayerUuid UUID
+     */
     public void setBlockedPlayerUuid(UUID blockedPlayerUuid) {
         this.blockedPlayerUuid = blockedPlayerUuid;
     }

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

@@ -1,6 +1,5 @@
 package simplexity.simplepms.listeners;
 
-import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
 import org.bukkit.event.player.PlayerLoginEvent;
@@ -11,14 +10,9 @@
 public class LoginListener implements Listener {
 
     @EventHandler
-    public void onLogin(PlayerLoginEvent event) {
-        Player player = event.getPlayer();
-        Cache.addPlayerSettingsToCache(player.getUniqueId());
-        Cache.addBlockListToCache(player.getUniqueId());
-        PlayerSettings playerSettings = Cache.getPlayerSettings(player.getUniqueId());
-        if (playerSettings.isSocialSpyEnabled()) {
-            SimplePMs.getSpyingPlayers().add(player);
-        }
-    }
+    public void onLogin(PlayerLoginEvent loginEvent) {
+        PlayerSettings settings = Cache.getPlayerSettings(loginEvent.getPlayer().getUniqueId());
+        if (settings.isSocialSpyEnabled()) SimplePMs.getSpyingPlayers().add(loginEvent.getPlayer());
 
+    }
 }

src/main/java/simplexity/simplepms/listeners/PreLoginListener.java

@@ -0,0 +1,18 @@
+package simplexity.simplepms.listeners;
+
+import com.destroystokyo.paper.profile.PlayerProfile;
+import org.bukkit.event.EventHandler;
+import org.bukkit.event.Listener;
+import org.bukkit.event.player.AsyncPlayerPreLoginEvent;
+import simplexity.simplepms.saving.Cache;
+
+public class PreLoginListener implements Listener {
+
+    @EventHandler
+    public void onPreLogin(AsyncPlayerPreLoginEvent event) {
+        PlayerProfile player = event.getPlayerProfile();
+        Cache.addPlayerSettingsToCache(player.getId());
+        Cache.addBlockListToCache(player.getId());
+    }
+
+}