All Superinterfaces:: java.lang.Iterable<ItemStack>

All Known Subinterfaces:: AnvilInventory, BeaconInventory, BrewerInventory, CraftingInventory, DoubleChestInventory, EnchantingInventory, FurnaceInventory, HorseInventory, MerchantInventory, PlayerInventory

public interface Inventory
extends java.lang.Iterable<ItemStack>

Interface to the various inventories. Behavior relating to Material.AIR is unspecified.

Method Summary

Modifier and Type	Method	Description
`java.util.HashMap<java.lang.Integer,ItemStack>`	`addItem(ItemStack... items)`	Stores the given ItemStacks in the inventory.
`java.util.HashMap<java.lang.Integer,? extends ItemStack>`	`all(int materialId)`	Deprecated. Magic value
`java.util.HashMap<java.lang.Integer,? extends ItemStack>`	`all(ItemStack item)`	Finds all slots in the inventory containing any ItemStacks with the given ItemStack.
`java.util.HashMap<java.lang.Integer,? extends ItemStack>`	`all(Material material)`	Returns a HashMap with all slots and ItemStacks in the inventory with the given Material.
`void`	`clear()`	Clears out the whole Inventory.
`void`	`clear(int index)`	Clears out a particular slot in the index.
`boolean`	`contains(int materialId)`	Deprecated. Magic value
`boolean`	`contains(int materialId, int amount)`	Deprecated. Magic value
`boolean`	`contains(ItemStack item)`	Checks if the inventory contains any ItemStacks matching the given ItemStack.
`boolean`	`contains(ItemStack item, int amount)`	Checks if the inventory contains at least the minimum amount specified of exactly matching ItemStacks.
`boolean`	`contains(Material material)`	Checks if the inventory contains any ItemStacks with the given material.
`boolean`	`contains(Material material, int amount)`	Checks if the inventory contains any ItemStacks with the given material, adding to at least the minimum amount specified.
`boolean`	`containsAtLeast(ItemStack item, int amount)`	Checks if the inventory contains ItemStacks matching the given ItemStack whose amounts sum to at least the minimum amount specified.
`int`	`first(int materialId)`	Deprecated. Magic value
`int`	`first(ItemStack item)`	Returns the first slot in the inventory containing an ItemStack with the given stack.
`int`	`first(Material material)`	Finds the first slot in the inventory containing an ItemStack with the given material
`int`	`firstEmpty()`	Returns the first empty Slot.
`ItemStack[]`	`getContents()`	Returns all ItemStacks from the inventory
`InventoryHolder`	`getHolder()`	Gets the block or entity belonging to the open inventory
`ItemStack`	`getItem(int index)`	Returns the ItemStack found in the slot at the given index
`int`	`getMaxStackSize()`	Returns the maximum stack size for an ItemStack in this inventory.
`java.lang.String`	`getName()`	Returns the name of the inventory
`int`	`getSize()`	Returns the size of the inventory
`java.lang.String`	`getTitle()`	Returns the title of this inventory.
`InventoryType`	`getType()`	Returns what type of inventory this is.
`java.util.List<HumanEntity>`	`getViewers()`	Gets a list of players viewing the inventory.
`java.util.ListIterator<ItemStack>`	`iterator()`
`java.util.ListIterator<ItemStack>`	`iterator(int index)`	Returns an iterator starting at the given index.
`void`	`remove(int materialId)`	Deprecated. Magic value
`void`	`remove(ItemStack item)`	Removes all stacks in the inventory matching the given stack.
`void`	`remove(Material material)`	Removes all stacks in the inventory matching the given material.
`java.util.HashMap<java.lang.Integer,ItemStack>`	`removeItem(ItemStack... items)`	Removes the given ItemStacks from the inventory.
`void`	`setContents(ItemStack[] items)`	Completely replaces the inventory's contents.
`void`	`setItem(int index, ItemStack item)`	Stores the ItemStack at the given index of the inventory.
`void`	`setMaxStackSize(int size)`	This method allows you to change the maximum stack size for an inventory.

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Method Details
- getSize
  
  int getSize()
  
  Returns the size of the inventory
  
  Returns:
  
  The size of the inventory
- getMaxStackSize
  
  int getMaxStackSize()
  
  Returns the maximum stack size for an ItemStack in this inventory.
  
  Returns:
  
  The maximum size for an ItemStack in this inventory.
- setMaxStackSize
  
  void setMaxStackSize(int size)
  This method allows you to change the maximum stack size for an inventory.
  Caveats:
  
  Not all inventories respect this value.
  Stacks larger than 127 may be clipped when the world is saved.
  This value is not guaranteed to be preserved; be sure to set it before every time you want to set a slot over the max stack size.
  Stacks larger than the default max size for this type of inventory may not display correctly in the client.
  Parameters:
  
  size - The new maximum stack size for items in this inventory.
- getName
  
  java.lang.String getName()
  
  Returns the name of the inventory
  
  Returns:
  
  The String with the name of the inventory
- getItem
  
  ItemStack getItem(int index)
  
  Returns the ItemStack found in the slot at the given index
  
  Parameters:
  
  index - The index of the Slot's ItemStack to return
  
  Returns:
  
  The ItemStack in the slot
- setItem
  
  void setItem(int index, ItemStack item)
  
  Stores the ItemStack at the given index of the inventory.
  
  Parameters:
  
  index - The index where to put the ItemStack
  
  item - The ItemStack to set
- addItem
  
  java.util.HashMap<java.lang.Integer,ItemStack> addItem(ItemStack... items) throws java.lang.IllegalArgumentException
  
  Stores the given ItemStacks in the inventory. This will try to fill existing stacks and empty slots as well as it can.
  The returned HashMap contains what it couldn't store, where the key is the index of the parameter, and the value is the ItemStack at that index of the varargs parameter. If all items are stored, it will return an empty HashMap.
  If you pass in ItemStacks which exceed the maximum stack size for the Material, first they will be added to partial stacks where Material.getMaxStackSize() is not exceeded, up to Material.getMaxStackSize(). When there are no partial stacks left stacks will be split on Inventory.getMaxStackSize() allowing you to exceed the maximum stack size for that material.
  
  Parameters:
  
  items - The ItemStacks to add
  
  Returns:
  
  A HashMap containing items that didn't fit.
  
  Throws:
  
  java.lang.IllegalArgumentException - if items or any element in it is null
- removeItem
  
  java.util.HashMap<java.lang.Integer,ItemStack> removeItem(ItemStack... items) throws java.lang.IllegalArgumentException
  
  Removes the given ItemStacks from the inventory.
  It will try to remove 'as much as possible' from the types and amounts you give as arguments.
  The returned HashMap contains what it couldn't remove, where the key is the index of the parameter, and the value is the ItemStack at that index of the varargs parameter. If all the given ItemStacks are removed, it will return an empty HashMap.
  
  Parameters:
  
  items - The ItemStacks to remove
  
  Returns:
  
  A HashMap containing items that couldn't be removed.
  
  Throws:
  
  java.lang.IllegalArgumentException - if items is null
- getContents
  
  ItemStack[] getContents()
  
  Returns all ItemStacks from the inventory
  
  Returns:
  
  An array of ItemStacks from the inventory.
- setContents
  
  void setContents(ItemStack[] items) throws java.lang.IllegalArgumentException
  
  Completely replaces the inventory's contents. Removes all existing contents and replaces it with the ItemStacks given in the array.
  
  Parameters:
  
  items - A complete replacement for the contents; the length must be less than or equal to getSize().
  
  Throws:
  
  java.lang.IllegalArgumentException - If the array has more items than the inventory.
- contains
  
  @Deprecated boolean contains(int materialId)
  
  Deprecated.
  Magic value
  
  Checks if the inventory contains any ItemStacks with the given materialId
  
  Parameters:
  
  materialId - The materialId to check for
  
  Returns:
  
  true if an ItemStack in this inventory contains the materialId
- contains
  
  boolean contains(Material material) throws java.lang.IllegalArgumentException
  
  Checks if the inventory contains any ItemStacks with the given material.
  
  Parameters:
  
  material - The material to check for
  
  Returns:
  
  true if an ItemStack is found with the given Material
  
  Throws:
  
  java.lang.IllegalArgumentException - if material is null
- contains
  
  boolean contains(ItemStack item)
  
  Checks if the inventory contains any ItemStacks matching the given ItemStack.
  This will only return true if both the type and the amount of the stack match.
  
  Parameters:
  
  item - The ItemStack to match against
  
  Returns:
  
  false if item is null, true if any exactly matching ItemStacks were found
- contains
  
  @Deprecated boolean contains(int materialId, int amount)
  
  Deprecated.
  Magic value
  
  Checks if the inventory contains any ItemStacks with the given materialId, adding to at least the minimum amount specified.
  
  Parameters:
  
  materialId - The materialId to check for
  
  amount - The minimum amount to look for
  
  Returns:
  
  true if this contains any matching ItemStack with the given materialId and amount
- contains
  
  boolean contains(Material material, int amount) throws java.lang.IllegalArgumentException
  
  Checks if the inventory contains any ItemStacks with the given material, adding to at least the minimum amount specified.
  
  Parameters:
  
  material - The material to check for
  
  amount - The minimum amount
  
  Returns:
  
  true if amount is less than 1, true if enough ItemStacks were found to add to the given amount
  
  Throws:
  
  java.lang.IllegalArgumentException - if material is null
- contains
  
  boolean contains(ItemStack item, int amount)
  
  Checks if the inventory contains at least the minimum amount specified of exactly matching ItemStacks.
  An ItemStack only counts if both the type and the amount of the stack match.
  
  Parameters:
  
  item - the ItemStack to match against
  
  amount - how many identical stacks to check for
  
  Returns:
  
  false if item is null, true if amount less than 1, true if amount of exactly matching ItemStacks were found
  
  See Also:
  
  containsAtLeast(ItemStack, int)
- containsAtLeast
  
  boolean containsAtLeast(ItemStack item, int amount)
  
  Checks if the inventory contains ItemStacks matching the given ItemStack whose amounts sum to at least the minimum amount specified.
  
  Parameters:
  
  item - the ItemStack to match against
  
  amount - the minimum amount
  
  Returns:
  
  false if item is null, true if amount less than 1, true if enough ItemStacks were found to add to the given amount
- all
  
  @Deprecated java.util.HashMap<java.lang.Integer,? extends ItemStack> all(int materialId)
  
  Deprecated.
  Magic value
  
  Returns a HashMap with all slots and ItemStacks in the inventory with given materialId.
  The HashMap contains entries where, the key is the slot index, and the value is the ItemStack in that slot. If no matching ItemStack with the given materialId is found, an empty map is returned.
  
  Parameters:
  
  materialId - The materialId to look for
  
  Returns:
  
  A HashMap containing the slot index, ItemStack pairs
- all
  
  java.util.HashMap<java.lang.Integer,? extends ItemStack> all(Material material) throws java.lang.IllegalArgumentException
  
  Returns a HashMap with all slots and ItemStacks in the inventory with the given Material.
  The HashMap contains entries where, the key is the slot index, and the value is the ItemStack in that slot. If no matching ItemStack with the given Material is found, an empty map is returned.
  
  Parameters:
  
  material - The material to look for
  
  Returns:
  
  A HashMap containing the slot index, ItemStack pairs
  
  Throws:
  
  java.lang.IllegalArgumentException - if material is null
- all
  
  java.util.HashMap<java.lang.Integer,? extends ItemStack> all(ItemStack item)
  
  Finds all slots in the inventory containing any ItemStacks with the given ItemStack. This will only match slots if both the type and the amount of the stack match
  The HashMap contains entries where, the key is the slot index, and the value is the ItemStack in that slot. If no matching ItemStack with the given Material is found, an empty map is returned.
  
  Parameters:
  
  item - The ItemStack to match against
  
  Returns:
  
  A map from slot indexes to item at index
- first
  
  @Deprecated int first(int materialId)
  
  Deprecated.
  Magic value
  
  Finds the first slot in the inventory containing an ItemStack with the given materialId.
  
  Parameters:
  
  materialId - The materialId to look for
  
  Returns:
  
  The slot index of the given materialId or -1 if not found
- first
  
  int first(Material material) throws java.lang.IllegalArgumentException
  
  Finds the first slot in the inventory containing an ItemStack with the given material
  
  Parameters:
  
  material - The material to look for
  
  Returns:
  
  The slot index of the given Material or -1 if not found
  
  Throws:
  
  java.lang.IllegalArgumentException - if material is null
- first
  
  int first(ItemStack item)
  
  Returns the first slot in the inventory containing an ItemStack with the given stack. This will only match a slot if both the type and the amount of the stack match
  
  Parameters:
  
  item - The ItemStack to match against
  
  Returns:
  
  The slot index of the given ItemStack or -1 if not found
- firstEmpty
  
  int firstEmpty()
  
  Returns the first empty Slot.
  
  Returns:
  
  The first empty Slot found, or -1 if no empty slots.
- remove
  
  @Deprecated void remove(int materialId)
  
  Deprecated.
  Magic value
  
  Removes all stacks in the inventory matching the given materialId.
  
  Parameters:
  
  materialId - The material to remove
- remove
  
  void remove(Material material) throws java.lang.IllegalArgumentException
  
  Removes all stacks in the inventory matching the given material.
  
  Parameters:
  
  material - The material to remove
  
  Throws:
  
  java.lang.IllegalArgumentException - if material is null
- remove
  
  void remove(ItemStack item)
  
  Removes all stacks in the inventory matching the given stack.
  This will only match a slot if both the type and the amount of the stack match
  
  Parameters:
  
  item - The ItemStack to match against
- clear
  
  void clear(int index)
  
  Clears out a particular slot in the index.
  
  Parameters:
  
  index - The index to empty.
- clear
  
  void clear()
  
  Clears out the whole Inventory.
- getViewers
  
  java.util.List<HumanEntity> getViewers()
  
  Gets a list of players viewing the inventory. Note that a player is considered to be viewing their own inventory and internal crafting screen even when said inventory is not open. They will normally be considered to be viewing their inventory even when they have a different inventory screen open, but it's possible for customized inventory screens to exclude the viewer's inventory, so this should never be assumed to be non-empty.
  
  Returns:
  
  A list of HumanEntities who are viewing this Inventory.
- getTitle
  
  java.lang.String getTitle()
  
  Returns the title of this inventory.
  
  Returns:
  
  A String with the title.
- getType
  
  InventoryType getType()
  
  Returns what type of inventory this is.
  
  Returns:
  
  The InventoryType representing the type of inventory.
- getHolder
  
  InventoryHolder getHolder()
  
  Gets the block or entity belonging to the open inventory
  
  Returns:
  
  The holder of the inventory; null if it has no holder.
- iterator
  
  java.util.ListIterator<ItemStack> iterator()
  
  Specified by:
  
  iterator in interface java.lang.Iterable<ItemStack>
- iterator
  
  java.util.ListIterator<ItemStack> iterator(int index)
  
  Returns an iterator starting at the given index. If the index is positive, then the first call to next() will return the item at that index; if it is negative, the first call to previous will return the item at index (getSize() + index).
  
  Parameters:
  
  index - The index.
  
  Returns:
  
  An iterator.

Interface Inventory

Method Summary

Methods inherited from interface java.lang.Iterable

Method Details