[1.2.0] New inventory system

dough-api/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.github.baked-libs</groupId>
         <artifactId>dough</artifactId>
-        <version>1.1.3</version>
+        <version>1.2.0</version>
     </parent>
 
     <artifactId>dough-api</artifactId>

dough-chat/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.github.baked-libs</groupId>
         <artifactId>dough</artifactId>
-        <version>1.1.3</version>
+        <version>1.2.0</version>
     </parent>
 
     <artifactId>dough-chat</artifactId>

dough-common/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.github.baked-libs</groupId>
         <artifactId>dough</artifactId>
-        <version>1.1.3</version>
+        <version>1.2.0</version>
     </parent>
 
     <artifactId>dough-common</artifactId>

dough-config/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.github.baked-libs</groupId>
         <artifactId>dough</artifactId>
-        <version>1.1.3</version>
+        <version>1.2.0</version>
     </parent>
 
     <artifactId>dough-config</artifactId>

dough-data/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.github.baked-libs</groupId>
         <artifactId>dough</artifactId>
-        <version>1.1.3</version>
+        <version>1.2.0</version>
     </parent>
 
     <artifactId>dough-data</artifactId>

dough-inventories/pom.xml

@@ -7,7 +7,7 @@
     <parent>
         <groupId>io.github.baked-libs</groupId>
         <artifactId>dough</artifactId>
-        <version>1.1.3</version>
+        <version>1.2.0</version>
     </parent>
 
     <artifactId>dough-inventories</artifactId>

dough-inventories/src/main/java/io/github/bakedlibs/dough/inventory/InvUtils.java

@@ -202,6 +202,7 @@ public static boolean fitAll(@Nonnull Inventory inv, @Nonnull ItemStack[] items,
      *            Whether to replace consumables, e.g. turn potions into glass bottles etc...
      * @param predicate
      *            The Predicate that tests the item
+     * 
      * @return Whether the operation was successful
      */
     public static boolean removeItem(@Nonnull Inventory inv, int amount, boolean replaceConsumables, @Nonnull Predicate<ItemStack> predicate) {

dough-inventories/src/main/java/io/github/bakedlibs/dough/inventory/Menu.java

@@ -0,0 +1,86 @@
+package io.github.bakedlibs.dough.inventory;
+
+import java.util.Iterator;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+import javax.annotation.ParametersAreNonnullByDefault;
+
+import org.apache.commons.lang.Validate;
+import org.bukkit.entity.HumanEntity;
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.Inventory;
+import org.bukkit.inventory.InventoryHolder;
+import org.bukkit.inventory.InventoryView;
+import org.bukkit.inventory.ItemStack;
+
+import io.github.bakedlibs.dough.inventory.factory.MenuFactory;
+
+public interface Menu extends InventoryHolder {
+
+    /**
+     * This method returns the {@link MenuFactory} which was used
+     * to create this {@link Menu}.
+     * 
+     * @return The original {@link MenuFactory}
+     */
+    @Nonnull
+    MenuFactory getFactory();
+
+    /**
+     * This returns the {@link MenuLayout} which was used to create
+     * this {@link Menu}.
+     * 
+     * @return The {@link MenuLayout}
+     */
+    @Nonnull
+    MenuLayout getLayout();
+
+    /**
+     * This returns the title of this {@link Menu}.
+     * If no title was set, null will be returned.
+     * 
+     * @return The title of this {@link Menu} or null
+     */
+    @Nullable
+    String getTitle();
+
+    void setAll(@Nonnull SlotGroup group, @Nullable ItemStack item);
+
+    default void clear(@Nonnull SlotGroup group) {
+        setAll(group, null);
+    }
+
+    @ParametersAreNonnullByDefault
+    @Nullable
+    ItemStack addItem(SlotGroup group, ItemStack item);
+
+    void setItem(int slot, @Nullable ItemStack item);
+
+    @Nullable
+    ItemStack getItem(int slot);
+
+    default @Nonnull InventoryView open(@Nonnull Player player) {
+        Validate.notNull(player, "The Player must not be null");
+        return player.openInventory(getInventory());
+    }
+
+    default void closeAllViews() {
+        Inventory inv = getInventory();
+        Iterator<HumanEntity> iterator = inv.getViewers().iterator();
+
+        while (iterator.hasNext()) {
+            iterator.next().closeInventory();
+        }
+    }
+
+    /**
+     * This returns the size of this {@link Menu}.
+     * 
+     * @return The size of the {@link Menu}.
+     */
+    default int getSize() {
+        return getInventory().getSize();
+    }
+
+}

dough-inventories/src/main/java/io/github/bakedlibs/dough/inventory/MenuLayout.java

@@ -0,0 +1,92 @@
+package io.github.bakedlibs.dough.inventory;
+
+import java.util.Set;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+import org.bukkit.inventory.Inventory;
+
+import io.github.bakedlibs.dough.inventory.builders.MenuLayoutBuilder;
+
+/**
+ * The {@link MenuLayout} covers the different {@link SlotGroup}s and basic characteristics
+ * of a {@link Menu}.
+ * 
+ * @author TheBusyBiscuit
+ *
+ * @see Menu
+ * @see SlotGroup
+ * @see MenuLayoutBuilder
+ * 
+ */
+public interface MenuLayout {
+
+    /**
+     * This returns all defined {@link SlotGroup}s for this
+     * {@link MenuLayout}.
+     * 
+     * @return A {@link Set} containing every {@link SlotGroup}
+     */
+    @Nonnull
+    Set<SlotGroup> getSlotGroups();
+
+    /**
+     * This returns the size of the resulting {@link Inventory}.
+     * 
+     * @return The {@link Inventory} size
+     */
+    int getSize();
+
+    /**
+     * This returns the title to be set for the resulting {@link Menu}.
+     * If no title was set, this will return null.
+     * 
+     * @return The title or null
+     */
+    @Nullable
+    String getTitle();
+
+    /**
+     * This returns the {@link SlotGroup} with the given identifier.
+     * <p>
+     * If no corresponding {@link SlotGroup} was found, it will throw an
+     * {@link IllegalArgumentException}.
+     * 
+     * @param identifier
+     *            The unique identifier for this {@link SlotGroup}.
+     * 
+     * @return The corresponding {@link SlotGroup}
+     */
+    @Nonnull
+    SlotGroup getGroup(char identifier);
+
+    /**
+     * This returns the {@link SlotGroup} present at the given slot.
+     * <p>
+     * If no corresponding {@link SlotGroup} was found, it will throw an
+     * {@link IllegalArgumentException}.
+     * 
+     * @param slot
+     *            The slot
+     * 
+     * @return The corresponding {@link SlotGroup}
+     */
+    @Nonnull
+    SlotGroup getGroup(int slot);
+
+    /**
+     * This returns the {@link SlotGroup} with the given name.
+     * <p>
+     * If no corresponding {@link SlotGroup} was found, it will throw an
+     * {@link IllegalArgumentException}.
+     * 
+     * @param name
+     *            The unique name of this {@link SlotGroup}.
+     * 
+     * @return The corresponding {@link SlotGroup}
+     */
+    @Nonnull
+    SlotGroup getGroup(@Nonnull String name);
+
+}

dough-inventories/src/main/java/io/github/bakedlibs/dough/inventory/SlotGroup.java

@@ -0,0 +1,102 @@
+package io.github.bakedlibs.dough.inventory;
+
+import java.util.Iterator;
+
+import javax.annotation.Nonnull;
+import javax.annotation.Nullable;
+
+import org.bukkit.entity.Player;
+import org.bukkit.inventory.Inventory;
+import org.bukkit.inventory.ItemStack;
+
+import io.github.bakedlibs.dough.inventory.builders.SlotGroupBuilder;
+import io.github.bakedlibs.dough.inventory.handlers.MenuClickHandler;
+
+/**
+ * A {@link SlotGroup} groups slots together and divides an {@link Inventory}
+ * into distinct regions which can be used for easy access.
+ * 
+ * @author TheBusyBiscuit
+ * 
+ * @see MenuLayout
+ * @see SlotGroupBuilder
+ *
+ */
+public interface SlotGroup extends Iterable<Integer> {
+
+    /**
+     * This returns the unique identifier for this {@link SlotGroup},
+     * we use a {@link Character} for this.
+     * 
+     * @return The unique identifier of this {@link SlotGroup}
+     */
+    @Nonnull
+    char getIdentifier();
+
+    /**
+     * This method returns whether this {@link SlotGroup} is interactable.
+     * An interactable {@link SlotGroup} allows the {@link Player} to take
+     * and store items from/in slots of this group.
+     * <p>
+     * If {@link #isInteractable()} returns <code>false</code>, the click event will
+     * be cancelled.
+     * 
+     * @return Whether this {@link SlotGroup} is interactable
+     */
+    boolean isInteractable();
+
+    /**
+     * This returns the name or label of this {@link SlotGroup}, names help
+     * to make a {@link SlotGroup} easier to identify instead of relying on the
+     * {@link Character} identifier all the time.
+     * 
+     * @return The name of this {@link SlotGroup}
+     */
+    @Nonnull
+    String getName();
+
+    /**
+     * This method returns an array containing all the individual slots of
+     * this {@link SlotGroup}.
+     * 
+     * @return An array with all slots of this {@link SlotGroup}
+     */
+    @Nonnull
+    int[] getSlots();
+
+    /**
+     * This returns the size of this {@link SlotGroup}.
+     * 
+     * @return The size of this {@link SlotGroup}
+     */
+    default int size() {
+        return getSlots().length;
+    }
+
+    /**
+     * This returns the default {@link ItemStack} for this {@link SlotGroup}.
+     * 
+     * @return The default {@link ItemStack}, can be null
+     */
+    @Nullable
+    ItemStack getDefaultItemStack();
+
+    /**
+     * This method returns the {@link MenuClickHandler} belonging to this {@link SlotGroup}.
+     * If no {@link MenuClickHandler} was added, this will return null.
+     * 
+     * @return The {@link MenuClickHandler} or null
+     */
+    @Nullable
+    MenuClickHandler getClickHandler();
+
+    /**
+     * This returns an {@link Iterator} allowing you to iterate through
+     * all slots within this {@link SlotGroup}.
+     */
+    @Override
+    default @Nonnull Iterator<Integer> iterator() {
+        return new SlotGroupIterator(this);
+    }
+
+}

dough-inventories/src/main/java/io/github/bakedlibs/dough/inventory/SlotGroupIterator.java

@@ -0,0 +1,51 @@
+package io.github.bakedlibs.dough.inventory;
+
+import java.util.Iterator;
+import java.util.NoSuchElementException;
+
+import javax.annotation.Nonnull;
+
+/**
+ * This {@link Iterator} implementation iterates through all slots within a {@link SlotGroup}.
+ * 
+ * @author TheBusyBiscuit
+ *
+ */
+class SlotGroupIterator implements Iterator<Integer> {
+
+    private final int[] slots;
+    private int index = 0;
+
+    /**
+     * This creates a new {@link SlotGroupIterator} for the given
+     * {@link SlotGroup}.
+     * 
+     * @param slotGroup
+     *            The {@link SlotGroup}
+     */
+    SlotGroupIterator(@Nonnull SlotGroup slotGroup) {
+        this.slots = slotGroup.getSlots();
+    }
+
+    @Override
+    public boolean hasNext() {
+        return index < slots.length;
+    }
+
+    @Override
+    public Integer next() {
+        if (index < slots.length) {
+            int slot = slots[index];
+            index++;
+            return slot;
+        } else {
+            throw new NoSuchElementException("No more slots available.");
+        }
+    }
+
+    @Override
+    public void remove() {
+        throw new UnsupportedOperationException("Iterator#remove() is not supported!");
+    }
+
+}