4.1.3

Author: KodySimpson

docs/me/kodysimpson/simpapi/menu/AbstractPlayerMenuUtility.html

@@ -101,7 +101,7 @@ <h2 title="Class AbstractPlayerMenuUtility" class="title">Class AbstractPlayerMe
 <li><a href="https://docs.oracle.com/javase/8/docs/api/java/lang/Object.html?is-external=true" title="class or interface in java.lang">java.lang.Object</a></li>
 <li>
 <ul class="inheritance">
-<li>me.kodysimpson.simpapi.menu.AbstractPlayerMenuUtility</li>
+<li>me.kodysimpson.simpapi.menu.PlayerMenuUtility</li>
 </ul>
 </li>
 </ul>

docs/me/kodysimpson/simpapi/menu/class-use/AbstractPlayerMenuUtility.html

@@ -71,7 +71,7 @@
 </a></div>
 <!-- ========= END OF TOP NAVBAR ========= -->
 <div class="header">
-<h2 title="Uses of Class me.kodysimpson.simpapi.menu.AbstractPlayerMenuUtility" class="title">Uses of Class<br>me.kodysimpson.simpapi.menu.AbstractPlayerMenuUtility</h2>
+<h2 title="Uses of Class me.kodysimpson.simpapi.menu.PlayerMenuUtility" class="title">Uses of Class<br>me.kodysimpson.simpapi.menu.AbstractPlayerMenuUtility</h2>
 </div>
 <div class="classUseContainer">
 <ul class="blockList">

pom.xml

@@ -6,7 +6,7 @@
 
     <groupId>me.kodysimpson</groupId>
     <artifactId>SimpAPI</artifactId>
-    <version>4.1.2</version>
+    <version>4.1.3</version>
     <packaging>jar</packaging>
 
     <name>SimpAPI</name>

src/main/java/me/kodysimpson/simpapi/menu/AbstractPlayerMenuUtility.java

@@ -19,14 +19,14 @@
 public abstract class Menu implements InventoryHolder {
 
     //Protected values that can be accessed in the menus
-    protected AbstractPlayerMenuUtility pmu;
+    protected PlayerMenuUtility pmu;
     protected Inventory inventory;
     protected ItemStack FILLER_GLASS = makeItem(Material.GRAY_STAINED_GLASS_PANE, " ");
 
     //Constructor for Menu. Pass in a PlayerMenuUtility so that
     // we have information on who's menu this is and
     // what info is to be transferred
-    public Menu(AbstractPlayerMenuUtility pmu) {
+    public Menu(PlayerMenuUtility pmu) {
         this.pmu = pmu;
     }
 
@@ -64,6 +64,9 @@ public void open() {
         return inventory;
     }
 
+    /**
+     * This will fill all of the empty slots with "filler glass"
+     */
     //Helpful utility method to fill all remaining slots with "filler glass"
     public void setFillerGlass(){
         for (int i = 0; i < getSlots(); i++) {
@@ -86,7 +89,7 @@ public ItemStack makeItem(Material material, String displayName, String... lore)
         return item;
     }
 
-    public <T> T PMUCaster(AbstractPlayerMenuUtility abstractPlayerMenuUtility, Class<T> t) {
+    public <T> T PMUCaster(PlayerMenuUtility abstractPlayerMenuUtility, Class<T> t) {
         return t.cast(abstractPlayerMenuUtility);
     }
 

src/main/java/me/kodysimpson/simpapi/menu/Menu.java

@@ -18,8 +18,8 @@
 public class MenuManager {
 
     //each player will be assigned their own PlayerMenuUtility object
-    private static final HashMap<Player, AbstractPlayerMenuUtility> playerMenuUtilityMap = new HashMap<>();
-    private static Class<? extends AbstractPlayerMenuUtility> pmuClass;
+    private static final HashMap<Player, PlayerMenuUtility> playerMenuUtilityMap = new HashMap<>();
+    private static Class<? extends PlayerMenuUtility> pmuClass;
     private static boolean isSetup = false;
     //private static Class<? extends Menu>[] menus;
 
@@ -51,7 +51,7 @@ private static void registerMenuListener(Server server, Plugin plugin) {
 
     }
 
-    private static void registerPlayerMenuUtility(Class<? extends AbstractPlayerMenuUtility> playerMenuUtilityClass) {
+    private static void registerPlayerMenuUtility(Class<? extends PlayerMenuUtility> playerMenuUtilityClass) {
 
         MenuManager.pmuClass = playerMenuUtilityClass;
 
@@ -62,7 +62,7 @@ private static void registerPlayerMenuUtility(Class<? extends AbstractPlayerMenu
      * @param plugin The instance of the plugin using this API. Can provide in plugin class by passing this keyword
      * @param playerMenuUtilityClass The class reference of your concrete defined PlayerMenuUtility subclass of AbstractPlayerMenuUtility
      */
-    public static void setup(Server server, Plugin plugin, Class<? extends AbstractPlayerMenuUtility> playerMenuUtilityClass) {
+    public static void setup(Server server, Plugin plugin, Class<? extends PlayerMenuUtility> playerMenuUtilityClass) {
 
         System.out.println("MENU MANAGER HAS BEEN SETUP");
 
@@ -86,27 +86,27 @@ public static void openMenu(Class<? extends Menu> menuClass, Player player) thro
      * @param menuClass The class reference of the Menu you want to open for a player
      * @param abstractPlayerMenuUtility Usually used to pass in a custom PlayerMenuUtility, for data transfer
      */
-    public static void openMenu(Class<? extends Menu> menuClass, AbstractPlayerMenuUtility abstractPlayerMenuUtility) throws MenuManagerException {
+    public static void openMenu(Class<? extends Menu> menuClass, PlayerMenuUtility abstractPlayerMenuUtility) throws MenuManagerException {
 
         try {
-            menuClass.getConstructor(AbstractPlayerMenuUtility.class).newInstance(abstractPlayerMenuUtility).open();
+            menuClass.getConstructor(PlayerMenuUtility.class).newInstance(abstractPlayerMenuUtility).open();
         } catch (InstantiationException | IllegalAccessException | InvocationTargetException | NoSuchMethodException e) {
             throw new MenuManagerException();
         }
 
     }
 
-    public static AbstractPlayerMenuUtility getPlayerMenuUtility(Player p) throws MenuManagerException, MenuManagerNotSetupException {
+    public static PlayerMenuUtility getPlayerMenuUtility(Player p) throws MenuManagerException, MenuManagerNotSetupException {
 
         if (!isSetup){
             throw new MenuManagerNotSetupException();
         }
 
-        AbstractPlayerMenuUtility playerMenuUtility;
+        PlayerMenuUtility playerMenuUtility;
         if (!(playerMenuUtilityMap.containsKey(p))) { //See if the player has a pmu "saved" for them
 
             //Construct PMU using reflection
-            Constructor<? extends AbstractPlayerMenuUtility> constructor;
+            Constructor<? extends PlayerMenuUtility> constructor;
             try {
                 constructor = pmuClass.getConstructor(Player.class);
 
@@ -131,12 +131,12 @@ public static AbstractPlayerMenuUtility getPlayerMenuUtility(Player p) throws Me
      */
     public static <T> T getPlayerMenuUtility(Player p, Class<T> t) throws MenuManagerException {
 
-        AbstractPlayerMenuUtility playerMenuUtility;
+        PlayerMenuUtility playerMenuUtility;
         if (!(playerMenuUtilityMap.containsKey(p))) { //See if the player has a PMU "saved" for them
 
             try{
                 //Construct PMU using reflection
-                Constructor<? extends AbstractPlayerMenuUtility> constructor = pmuClass.getConstructor(Player.class);
+                Constructor<? extends PlayerMenuUtility> constructor = pmuClass.getConstructor(Player.class);
 
                 playerMenuUtility = constructor.newInstance(p);
                 playerMenuUtilityMap.put(p, playerMenuUtility);

src/main/java/me/kodysimpson/simpapi/menu/MenuManager.java

@@ -0,0 +1,44 @@
+package me.kodysimpson.simpapi.menu;
+
+/*
+Companion class to all menus. This is needed to pass information across the entire
+ menu system no matter how many inventories are opened or closed.
+
+ Each player has one of these objects, and only one.
+ */
+
+import org.bukkit.entity.Player;
+
+import java.util.HashMap;
+
+public class PlayerMenuUtility {
+
+    private final Player owner;
+    private final HashMap<String, Object> dataMap = new HashMap<>();
+
+    public PlayerMenuUtility(Player p) {
+        this.owner = p;
+    }
+
+    public Player getOwner() {
+        return owner;
+    }
+
+    /**
+     * @param identifier A key to store the data by
+     * @param data The data itself to be stored
+     */
+    public void setData(String identifier, Object data){
+        this.dataMap.put(identifier, data);
+    }
+
+    /**
+     * @param identifier The key for the data stored in the PMC
+     * @return The retrieved value or null if not found
+     */
+    public Object getData(String identifier){
+        return this.dataMap.get(identifier);
+    }
+
+}
+