Optimized GUI storage

Author: Sentropic

src/main/java/com/sentropic/guiapi/GUIAPI.java

@@ -1,9 +1,8 @@
 package com.sentropic.guiapi;
 
 import com.sentropic.guiapi.command.ReloadCommand;
-import com.sentropic.guiapi.gui.GUIManager;
-import com.sentropic.guiapi.packet.PacketManager;
 import com.sentropic.guiapi.gui.GUI;
+import com.sentropic.guiapi.packet.PacketManager;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.HandlerList;
@@ -84,18 +83,21 @@ private void setProtocolLib(boolean enabled) {
 
     /**
      * Gets the singleton {@link GUIAPI} object loaded by the server
+     *
      * @return the singleton {@link GUIAPI} object
      */
     public static GUIAPI getPlugin() { return singleton; }
 
     /**
      * Gets the singleton {@link GUIManager} loaded by the plugin. Use this to access a {@link Player}s' {@link GUI}
+     *
      * @return the {@link GUIManager} instance loaded by the plugin
      */
     public static GUIManager getGUIManager() { return guiManager; }
 
     /**
      * Gets the singleton {@link GUIConfig} loaded by the plugin
+     *
      * @return the {@link GUIConfig} instance loaded by the plugin
      */
     public static GUIConfig getGUIConfig() { return config; }

src/main/java/com/sentropic/guiapi/GUIConfig.java

@@ -70,7 +70,7 @@ public void reload() {
                     } catch (NullPointerException | IllegalArgumentException ignored) { }
                 }
             }
-            GUIAPI.getGUIManager().getGUIS().values().forEach(GUI::onReload);
+            GUIAPI.getGUIManager().GUIS.forEach(GUI::onReload);
         }
     }
 

…com/sentropic/guiapi/gui/GUIManager.java …ava/com/sentropic/guiapi/GUIManager.javasrc/main/java/com/sentropic/guiapi/gui/GUIManager.java renamed to src/main/java/com/sentropic/guiapi/GUIManager.java src/main/java/com/sentropic/guiapi/gui/GUIManager.java renamed to src/main/java/com/sentropic/guiapi/GUIManager.java

@@ -1,23 +1,24 @@
-package com.sentropic.guiapi.gui;
+package com.sentropic.guiapi;
 
-import com.sentropic.guiapi.GUIAPI;
+import com.sentropic.guiapi.gui.GUI;
 import org.bukkit.entity.Player;
 import org.bukkit.event.EventHandler;
 import org.bukkit.event.Listener;
 import org.bukkit.event.player.PlayerQuitEvent;
+import org.bukkit.metadata.FixedMetadataValue;
 import org.bukkit.scheduler.BukkitRunnable;
 
-import java.util.Collections;
-import java.util.HashMap;
-import java.util.Map;
+import java.util.HashSet;
+import java.util.Set;
 
 /**
  * Class in charge of storing, accessing and updating the {@link Player}s' {@link GUI}
  * To access the instance used by the plugin, use {@link GUIAPI#getGUIManager()}
  */
 public class GUIManager implements Listener {
-    private final Map<Player,GUI> GUIS = new HashMap<>();
-    private final Map<Player,GUI> GUIS_READ = Collections.unmodifiableMap(GUIS);
+    private static final String METADATA_KEY = "guiapi:gui";
+
+    final Set<GUI> GUIS = new HashSet<>();
     private final Task task = new Task();
 
     /**
@@ -28,40 +29,41 @@ public class GUIManager implements Listener {
     /**
      * For internal use only. Used to clear the stored {@link GUI}s from memory and cancel GUI updating
      */
-    public void disable() {
+    void disable() {
         try {
             task.cancel();
+            for (GUI gui : GUIS) {
+                gui.getPlayer().removeMetadata(METADATA_KEY, GUIAPI.getPlugin());
+            }
             GUIS.clear();
         } catch (IllegalStateException ignored) { }
     }
 
     /**
      * Gets the {@link GUI} of a given {@link Player}
+     *
      * @param player the {@link Player} to get the {@link GUI} for
      * @return the existing {@link GUI} of the {@link Player}, or a new one if nonexistent
      */
     public GUI getGUI(Player player) {
-        GUI gui = GUIS.get(player);
-        if (gui == null) {
+        GUI gui;
+        if (player.hasMetadata(METADATA_KEY)) {
+            gui = (GUI) player.getMetadata(METADATA_KEY).get(0).value();
+        } else {
             gui = new GUI(player);
-            GUIS.put(player, gui);
+            GUIS.add(gui);
+            player.setMetadata(METADATA_KEY, new FixedMetadataValue(GUIAPI.getPlugin(), gui));
         }
         return gui;
     }
 
-    /**
-     * @return a read-only {@link Map} containing all {@link Player}s who have a {@link GUI},
-     *      * and the respective GUIs
-     */
-    public Map<Player,GUI> getGUIS() { return GUIS_READ; }
-
     @EventHandler
-    public void onPlayerLeave(PlayerQuitEvent event) { GUIS.remove(event.getPlayer()); }
+    public void onPlayerLeave(PlayerQuitEvent event) { GUIS.remove(this.getGUI(event.getPlayer())); }
 
     private class Task extends BukkitRunnable {
         @Override
         public void run() {
-            GUIS.values().forEach(GUI::play);
+            GUIS.forEach(GUI::play);
         }
     }
 }

src/main/java/com/sentropic/guiapi/command/ReloadCommand.java

@@ -23,7 +23,7 @@ public boolean onCommand(@NotNull CommandSender sender, @NotNull Command command
                 GUI gui = GUIAPI.getGUIManager().getGUI((Player) sender);
                 gui.setDebug(!gui.isDebugging());
                 return true;
-            } else { sender.sendMessage("Command only runnable ingame"); }
+            } else { sender.sendMessage("Command only runnable in-game"); }
         }
         return false;
     }

src/main/java/com/sentropic/guiapi/gui/Font.java

@@ -56,6 +56,7 @@ public class Font {
 
     /**
      * Gets a registered font by its ID
+     *
      * @param id the id of the font
      * @return the font for the given ID, or null if was not found
      */
@@ -64,6 +65,7 @@ public class Font {
 
     /**
      * Registers a Font to be accessed statically later, through {@link Font#getRegistered(String)}
+     *
      * @param font the Font to be registered
      * @throws IllegalArgumentException if a font with the same ID already is registered
      */
@@ -77,6 +79,7 @@ public static void register(Font font) {
 
     /**
      * Unregisters a Font from the static context
+     *
      * @param font the font to unregister
      * @return true if the font was unregistered, false if it was not previously registered
      */
@@ -95,7 +98,7 @@ public static boolean unregister(Font font) {
     private Map<Character,Integer> widths;
 
     /**
-     * @param id the namespaced ID of the font, as used by the resource pack (i.e. "minecraft:default")
+     * @param id     the namespaced ID of the font, as used by the resource pack (i.e. "minecraft:default")
      * @param height the default height of the characters in the font, as specified in the resource pack
      */
     public Font(@NotNull String id, int height) {
@@ -106,7 +109,8 @@ public Font(@NotNull String id, int height) {
     /**
      * Creates a font that inherits its character widths from a parent font
      * Used for fonts that share the same textures with another one
-     * @param id the namespaced ID of the font, as used by the resource pack (i.e. "minecraft:default")
+     *
+     * @param id     the namespaced ID of the font, as used by the resource pack (i.e. "minecraft:default")
      * @param height the default height of the characters in the font, as specified in the resource pack
      * @param parent the font to inherit its character widths from
      */
@@ -118,8 +122,9 @@ public Font(@NotNull String id, int height, Font parent) {
 
     /**
      * Registers the width of a character for this font, if different from the default of 6
+     *
      * @param character the character to register the width for
-     * @param width the width of the character
+     * @param width     the width of the character
      */
     public void registerWidth(char character, int width) {
         if (widths == null) { widths = new HashMap<>(); }
@@ -128,8 +133,9 @@ public void registerWidth(char character, int width) {
 
     /**
      * Gets the width of a given character for this font
+     *
      * @param character the character to get the width for
-     * @param scale whether to scale the width according to the font's height
+     * @param scale     whether to scale the width according to the font's height
      * @return the width of the character
      */
     public int getWidth(char character, boolean scale) {
@@ -151,7 +157,8 @@ public int getWidth(char character, boolean scale) {
 
     /**
      * Calculates the width of a given {@link String} for this font
-     * @param text the String to calculate the width for
+     *
+     * @param text  the String to calculate the width for
      * @param scale whether to scale the width according to the font's height
      * @return the calculated width of the character
      */

src/main/java/com/sentropic/guiapi/gui/GUI.java

@@ -1,6 +1,7 @@
 package com.sentropic.guiapi.gui;
 
 import com.sentropic.guiapi.GUIAPI;
+import com.sentropic.guiapi.GUIManager;
 import net.md_5.bungee.api.ChatMessageType;
 import net.md_5.bungee.api.chat.BaseComponent;
 import net.md_5.bungee.api.chat.TextComponent;
@@ -63,13 +64,22 @@ public class GUI {
     private final Player player;
     private final List<GUIComponent> guiComponents = new ArrayList<>();
 
-    GUI(Player player) {
+
+    /**
+     * Important: If you need to get a player's GUI, use {@link GUIManager#getGUI(Player)},
+     * since GUIs created through this constructor will not be processed.
+     *
+     * @param player the player the GUI belongs to.
+     */
+    @Deprecated
+    public GUI(Player player) {
         this.player = player;
         guiComponents.add(defaultComponent);
     }
 
     /**
      * Gets the owner of this GUI
+     *
      * @return the {@link Player} to whom this GUI belongs to
      */
     @SuppressWarnings("unused")
@@ -80,6 +90,7 @@ public class GUI {
     /**
      * Adds the given {@link GUIComponent} to the GUI after all previously added GUIComponents,
      * and removes any other component with the same ID as the given one
+     *
      * @param component the GUIComponent to add to the GUI
      */
     public void putOnTop(@NotNull GUIComponent component) {
@@ -92,6 +103,7 @@ public void putOnTop(@NotNull GUIComponent component) {
     /**
      * Adds the given {@link GUIComponent} to the GUI before all previously added GUIComponents,
      * and removes any other component with the same ID as the given one
+     *
      * @param component the GUIComponent to add to the GUI
      */
     @SuppressWarnings("unused")
@@ -105,6 +117,7 @@ public void putUnderneath(@NotNull GUIComponent component) {
     /**
      * If a {@link GUIComponent} exists with an ID matching the one of the given component,
      * removes it and puts the given one in its place
+     *
      * @param component the GUIComponent to add to the GUI
      * @return whether the component could be added
      */
@@ -130,6 +143,7 @@ public boolean update(@NotNull GUIComponent component) {
     /**
      * If a {@link GUIComponent} exists with an ID matching the given id,
      * adds the provided component after it, and removes any other component with the same ID as it
+     *
      * @param component the GUIComponent to add to the GUI
      * @return whether the component could be added
      */
@@ -154,6 +168,7 @@ public boolean putAfter(String id, @NotNull GUIComponent component) {
     /**
      * If a {@link GUIComponent} exists with an ID matching the given id,
      * adds the provided component} before it, and removes any other component with the same ID as it
+     *
      * @param component the GUIComponent to add to the GUI
      * @return whether the component could be added
      */
@@ -177,6 +192,7 @@ public boolean putBefore(String before, @NotNull GUIComponent component) {
 
     /**
      * If a {@link GUIComponent} exists with an ID matching the given id, removes it from the GUI
+     *
      * @return whether a component with a matching id was removed
      */
     @SuppressWarnings("UnusedReturnValue")
@@ -187,6 +203,7 @@ public boolean remove(String id) {
 
     /**
      * Removes any {@link GUIComponent}s that meet a given predicate from the GUI
+     *
      * @param predicate the predicate that to-be-removed {@link GUIComponent}s must meet
      * @return whether any {@link GUIComponent}s were removed
      */
@@ -218,12 +235,14 @@ private static void checkID(String id) {
 
     /**
      * Gets whether this GUI is in debug mode (displaying the debug {@link GUIComponent}s defined in the plugin's config)
+     *
      * @return whether this GUI is in debug mode
      */
     public boolean isDebugging() { return debug; }
 
     /**
      * Sets this GUI to debug mode if debug is true, or disables it otherwise
+     *
      * @param debug whether to put the GUI in debug mode or not
      */
     public void setDebug(boolean debug) {
@@ -308,6 +327,7 @@ public void onReload() {
      * Adds an {@link AnonComponent} containing the given baseComponent
      * Because the content of other {@link BaseComponent} implementations are unknown to the server,
      * only supports {@link TextComponent} at this moment
+     *
      * @param baseComponent the anonymous chat component to add to the GUI
      * @return whether the given baseComponent was of the supported types and could be added
      */
@@ -334,6 +354,7 @@ public boolean addAnonComponent(BaseComponent baseComponent) {
 
     /**
      * Removes the given anonymous component from the GUI
+     *
      * @param component the anonymous component to remove
      */
     public void removeAnonComponent(AnonComponent component) {
@@ -394,13 +415,15 @@ private void reschedule() {
 
     /**
      * Used to distinguish between action bar text sent by {@link GUIAPI} and those send anonymously
+     *
      * @return whether {@link GUIAPI} is sending an action bar packet at the moment of calling
      */
     public static boolean isSending() { return sending; }
 
     /**
      * Builds a {@link String} containing the specified amount of space,
      * from space characters provided by AmberW's Negative Space resource pack
+     *
      * @param amount the amount of space to generate the string for, whether positive, negative or zero
      * @return the built {@link String} containing the specified amount of space
      */