Package me.eddie.inventoryguiapi.gui.session

Class GUIState

java.lang.Object
me.eddie.inventoryguiapi.gui.session.AbstractAttributable
me.eddie.inventoryguiapi.gui.session.GUIState
All Implemented Interfaces:
Attributable
public class GUIState extends AbstractAttributable
This class represents the current state of an InventoryGUI being displayed. It keeps track of all the pages of the GUI and their respective InventoryStates

  • Constructor Details

    • GUIState

      public GUIState()
      Create a new GUIState

  • Method Details

    • getInventoryStatesByPage

      public Map<Integer,InventoryState> getInventoryStatesByPage()

    • hasInventoryState

      public boolean hasInventoryState(int page)
      Check if an InventoryState exists for a given page
      Parameters:
      page - The page to check if an inventory state exists for
      Returns:
      True if one exists or false if not

    • getOrCreateInventoryState

      public InventoryState getOrCreateInventoryState(int page)
      Get the InventoryState for the given page, creating a new one if none existed
      Parameters:
      page - The page to get the state of
      Returns:
      The Inventory State

    • removeInventoryState

      public void removeInventoryState(int page)
      Remove the inventory state for a given page
      Parameters:
      page - The page to remove it for

    • updateInventoryState

      public void updateInventoryState(int page, InventoryState state)
      Update the inventory state for a given page
      Parameters:
      page - The page to update the inventory state for
      state - The InventoryState of the given page

    • getExistingInventoryState

      public InventoryState getExistingInventoryState(int page)
      Get the InventoryState for the given page, or null if none exists
      Parameters:
      page - The page to get the state of
      Returns:
      The Inventory State