some javadoc on new stuff & move some methods

Author: brachy84

src/main/java/com/cleanroommc/modularui/factory/inventory/Inventory.java

@@ -4,6 +4,9 @@
 import net.minecraft.inventory.IInventory;
 import net.minecraft.item.ItemStack;
 
+/**
+ * A {@link InventoryType} implementation for {@link IInventory}.
+ */
 public abstract class Inventory extends InventoryType {
 
     public Inventory(String id) {

src/main/java/com/cleanroommc/modularui/factory/inventory/InventoryType.java

@@ -9,7 +9,6 @@
 import net.minecraftforge.items.ItemHandlerHelper;
 
 import it.unimi.dsi.fastutil.objects.Object2ObjectOpenHashMap;
-import org.apache.commons.lang3.tuple.Pair;
 
 import java.util.Collection;
 import java.util.Collections;
@@ -50,6 +49,13 @@ public boolean isActive() {
 
     public abstract int getSlotCount(EntityPlayer player);
 
+    /**
+     * Returns the first stackable slot index for the given item
+     *
+     * @param player player of which inventory to visit
+     * @param stack stack which should be checked stackability with
+     * @return index of slot with stackable item or -1 if none found
+     */
     public int findFirstStackable(EntityPlayer player, ItemStack stack) {
         for (int i = 0, n = getSlotCount(player); i < n; ++i) {
             ItemStack stackInSlot = getStackInSlot(player, i);
@@ -66,6 +72,15 @@ public int findFirstStackable(EntityPlayer player, ItemStack stack) {
         return -1;
     }
 
+    /**
+     * Visits all slots which item is stackable with the given item in the inventory with the given visitor function.
+     * Two empty items also count as stackable.
+     *
+     * @param player player of which inventory to visit
+     * @param stack stack which should be checked stackability with
+     * @param visitor visit function
+     * @return if the visitor function returned true on a slot
+     */
     public boolean visitAllStackable(EntityPlayer player, ItemStack stack, InventoryVisitor visitor) {
         for (int i = 0, n = getSlotCount(player); i < n; ++i) {
             ItemStack stackInSlot = getStackInSlot(player, i);
@@ -86,6 +101,13 @@ public boolean visitAllStackable(EntityPlayer player, ItemStack stack, Inventory
         return false;
     }
 
+    /**
+     * Visits all slots in the inventory with the given visitor function.
+     *
+     * @param player player of which inventory to visit
+     * @param visitor visit function
+     * @return if the visitor function returned true on a slot
+     */
     public boolean visitAll(EntityPlayer player, InventoryVisitor visitor) {
         for (int i = 0, n = getSlotCount(player); i < n; ++i) {
             ItemStack stackInSlot = getStackInSlot(player, i);
@@ -111,28 +133,4 @@ public static InventoryType getFromId(String id) {
     public static Collection<InventoryType> getAll() {
         return Collections.unmodifiableCollection(inventoryTypes.values());
     }
-
-    public static Pair<InventoryType, Integer> findFirstStackableInAll(EntityPlayer player, ItemStack stack) {
-        for (InventoryType type : getAll()) {
-            int i = type.findFirstStackable(player, stack);
-            if (i >= 0) return Pair.of(type, i);
-        }
-        return null;
-    }
-
-    public static void visitAllStackableInAll(EntityPlayer player, ItemStack stack, InventoryVisitor visitor) {
-        for (InventoryType type : getAll()) {
-            if (type.visitAllStackable(player, stack, visitor)) {
-                return;
-            }
-        }
-    }
-
-    public static void visitAllInAll(EntityPlayer player, InventoryVisitor visitor) {
-        for (InventoryType type : getAll()) {
-            if (type.visitAll(player, visitor)) {
-                return;
-            }
-        }
-    }
 }

src/main/java/com/cleanroommc/modularui/factory/inventory/InventoryTypes.java

@@ -4,9 +4,13 @@
 
 import net.minecraft.entity.player.EntityPlayer;
 import net.minecraft.inventory.IInventory;
+import net.minecraft.item.ItemStack;
 import net.minecraftforge.items.IItemHandlerModifiable;
 
 import baubles.api.BaublesApi;
+import org.apache.commons.lang3.tuple.Pair;
+
+import java.util.Collection;
 
 public class InventoryTypes {
 
@@ -32,4 +36,32 @@ public IItemHandlerModifiable getInventory(EntityPlayer player) {
             throw new IllegalArgumentException("Tried to receive bauble item, but bauble is not loaded");
         }
     };
+
+    public static Collection<InventoryType> getAll() {
+        return InventoryType.getAll();
+    }
+
+    public static Pair<InventoryType, Integer> findFirstStackable(EntityPlayer player, ItemStack stack) {
+        for (InventoryType type : getAll()) {
+            int i = type.findFirstStackable(player, stack);
+            if (i >= 0) return Pair.of(type, i);
+        }
+        return null;
+    }
+
+    public static void visitAllStackable(EntityPlayer player, ItemStack stack, InventoryVisitor visitor) {
+        for (InventoryType type : getAll()) {
+            if (type.visitAllStackable(player, stack, visitor)) {
+                return;
+            }
+        }
+    }
+
+    public static void visitAll(EntityPlayer player, InventoryVisitor visitor) {
+        for (InventoryType type : getAll()) {
+            if (type.visitAll(player, visitor)) {
+                return;
+            }
+        }
+    }
 }

src/main/java/com/cleanroommc/modularui/factory/inventory/InventoryVisitor.java

@@ -2,7 +2,18 @@
 
 import net.minecraft.item.ItemStack;
 
+/**
+ * A function to visit a slot in a player bound inventory.
+ */
 public interface InventoryVisitor {
 
+    /**
+     * Called on visiting a slot in a player bound inventory.
+     *
+     * @param type type of the current inventory
+     * @param index index of the slot
+     * @param stack content of the slot
+     * @return true if no further slots should be visited
+     */
     boolean visit(InventoryType type, int index, ItemStack stack);
 }

src/main/java/com/cleanroommc/modularui/factory/inventory/ItemHandler.java

@@ -4,6 +4,9 @@
 import net.minecraft.item.ItemStack;
 import net.minecraftforge.items.IItemHandlerModifiable;
 
+/**
+ * A {@link InventoryType} implementation for {@link IItemHandlerModifiable}.
+ */
 public abstract class ItemHandler extends InventoryType {
 
     public ItemHandler(String id) {