Class InventoryMock
java.lang.Object
be.seeseemelk.mockbukkit.inventory.InventoryMock
- Direct Known Subclasses:
AbstractHorseInventoryMock
,AnvilInventoryMock
,BarrelInventoryMock
,BeaconInventoryMock
,BrewerInventoryMock
,CartographyInventoryMock
,ChestInventoryMock
,DispenserInventoryMock
,DropperInventoryMock
,EnchantingInventoryMock
,EnderChestInventoryMock
,FurnaceInventoryMock
,GrindstoneInventoryMock
,HopperInventoryMock
,LecternInventoryMock
,LoomInventoryMock
,PlayerInventoryMock
,ShulkerBoxInventoryMock
,SimpleInventoryMock
,SmithingInventoryMock
,StonecutterInventoryMock
,WorkbenchInventoryMock
Mock implementation of an
Inventory
.-
Constructor Summary
ConstructorDescriptionInventoryMock
(@Nullable InventoryHolder holder, int size, @NotNull InventoryType type) Constructs a newInventoryMock
for the given holder, with a specific size andInventoryType
.InventoryMock
(@Nullable InventoryHolder holder, @NotNull InventoryType type) Constructs a newInventoryMock
for the given holder with a specificInventoryType
. -
Method Summary
Modifier and TypeMethodDescription@Nullable ItemStack
Adds a single item to the inventory.void
addViewer
(@NotNull HumanEntity viewer) Adds a viewer to this inventory.void
addViewers
(@NotNull List<HumanEntity> viewers) Adds the given viewers to this inventory.void
addViewers
(@NotNull HumanEntity... viewers) Adds the given viewers to this inventory.void
assertContainsAny
(@NotNull ItemStack item) Asserts that the inventory contains at least one itemstack that is compatible with the given itemstack.void
assertContainsAtLeast
(@NotNull ItemStack item, int amount) Asserts that the inventory contains at least a specific amount of items that are compatible with the given itemstack.void
assertTrueForAll
(@NotNull Predicate<ItemStack> condition) Asserts that a certain condition is true for all items, evennulls
, in this inventory.void
assertTrueForNonNulls
(@NotNull Predicate<ItemStack> condition) Assets that a certain condition is true for all items in this inventory that aren't null.void
assertTrueForSome
(@NotNull Predicate<ItemStack> condition) Asserts that a certain condition is true for at least one item in this inventory.void
clear()
void
clear
(int index) int
close()
boolean
boolean
boolean
boolean
boolean
containsAtLeast
(@NotNull ItemStack item, int amount) int
int
int
ItemStack @NotNull []
@Nullable InventoryHolder
@Nullable InventoryHolder
getHolder
(boolean useSnapshot) getItem
(int index) int
int
getNumberOfItems
(@NotNull ItemStack item) Get the number of times a certain item is in the inventory.int
getSize()
@NotNull Inventory
Creates a snapshot of the inventory.ItemStack @NotNull []
@NotNull InventoryType
getType()
@NotNull List<HumanEntity>
boolean
isEmpty()
@NotNull ListIterator<ItemStack>
iterator()
@NotNull ListIterator<ItemStack>
iterator
(int index) void
void
removeItem
(ItemStack... items) removeItemAnySlot
(@NotNull ItemStack... items) void
removeViewer
(@NotNull HumanEntity viewer) Removes a viewer from this inventory.void
setContents
(ItemStack @NotNull [] items) void
void
setMaxStackSize
(int size) void
setStorageContents
(ItemStack @NotNull [] items) Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait
Methods inherited from interface java.lang.Iterable
forEach, spliterator
-
Constructor Details
-
InventoryMock
public InventoryMock(@Nullable @Nullable InventoryHolder holder, int size, @NotNull @NotNull InventoryType type) Constructs a newInventoryMock
for the given holder, with a specific size andInventoryType
.- Parameters:
holder
- The holder of the inventory.size
- The size of the inventory. Must be 2, or a multiple of 9 between 9 and 54.type
- The type of the inventory.
-
InventoryMock
public InventoryMock(@Nullable @Nullable InventoryHolder holder, @NotNull @NotNull InventoryType type) Constructs a newInventoryMock
for the given holder with a specificInventoryType
. The size will beInventoryType.getDefaultSize()
.- Parameters:
holder
- The holder of the inventory.type
- The type of the inventory.
-
-
Method Details
-
assertTrueForAll
Asserts that a certain condition is true for all items, evennulls
, in this inventory.- Parameters:
condition
- The condition to check for.
-
assertTrueForNonNulls
Assets that a certain condition is true for all items in this inventory that aren't null.- Parameters:
condition
- The condition to check for.
-
assertTrueForSome
Asserts that a certain condition is true for at least one item in this inventory. It will skip any null items.- Parameters:
condition
- The condition to check for.
-
assertContainsAny
Asserts that the inventory contains at least one itemstack that is compatible with the given itemstack.- Parameters:
item
- The itemstack to compare everything to.
-
assertContainsAtLeast
Asserts that the inventory contains at least a specific amount of items that are compatible with the given itemstack.- Parameters:
item
- The itemstack to search for.amount
- The minimum amount of items that one should have.
-
getNumberOfItems
Get the number of times a certain item is in the inventory.- Parameters:
item
- The item to check for.- Returns:
- The number of times the item is present in this inventory.
-
addViewer
Adds a viewer to this inventory.- Parameters:
viewer
- The viewer to add.
-
addViewers
Adds the given viewers to this inventory.- Parameters:
viewers
- The viewers to add.
-
addViewers
Adds the given viewers to this inventory.- Parameters:
viewers
- TheList
of viewers to add.
-
removeViewer
Removes a viewer from this inventory.- Parameters:
viewer
- The viewer to remove.
-
getSize
public int getSize() -
getItem
-
setItem
-
addItem
Adds a single item to the inventory. Returns whatever item it couldn't add.- Parameters:
item
- The item to add.- Returns:
- The remaining stack that couldn't be added. If it's empty it just returns
null
.
-
addItem
@NotNull public @NotNull HashMap<Integer,ItemStack> addItem(ItemStack @NotNull ... items) throws IllegalArgumentException - Specified by:
addItem
in interfaceInventory
- Throws:
IllegalArgumentException
-
getContents
- Specified by:
getContents
in interfaceInventory
-
setContents
- Specified by:
setContents
in interfaceInventory
-
getHolder
-
getHolder
-
iterator
-
getType
-
getMaxStackSize
public int getMaxStackSize()- Specified by:
getMaxStackSize
in interfaceInventory
-
setMaxStackSize
public void setMaxStackSize(int size) - Specified by:
setMaxStackSize
in interfaceInventory
-
removeItem
@NotNull public @NotNull HashMap<Integer,ItemStack> removeItem(ItemStack... items) throws IllegalArgumentException - Specified by:
removeItem
in interfaceInventory
- Throws:
IllegalArgumentException
-
removeItemAnySlot
@NotNull public @NotNull HashMap<Integer,ItemStack> removeItemAnySlot(@NotNull @NotNull ItemStack... items) throws IllegalArgumentException - Specified by:
removeItemAnySlot
in interfaceInventory
- Throws:
IllegalArgumentException
-
getStorageContents
- Specified by:
getStorageContents
in interfaceInventory
-
setStorageContents
- Specified by:
setStorageContents
in interfaceInventory
- Throws:
IllegalArgumentException
-
contains
- Specified by:
contains
in interfaceInventory
- Throws:
IllegalArgumentException
-
contains
-
contains
public boolean contains(@Nullable @Nullable Material material, int amount) throws IllegalArgumentException - Specified by:
contains
in interfaceInventory
- Throws:
IllegalArgumentException
-
contains
-
containsAtLeast
- Specified by:
containsAtLeast
in interfaceInventory
-
all
@NotNull public @NotNull HashMap<Integer,? extends ItemStack> all(@NotNull @NotNull Material material) throws IllegalArgumentException - Specified by:
all
in interfaceInventory
- Throws:
IllegalArgumentException
-
all
-
first
- Specified by:
first
in interfaceInventory
- Throws:
IllegalArgumentException
-
first
-
firstEmpty
public int firstEmpty()- Specified by:
firstEmpty
in interfaceInventory
-
remove
- Specified by:
remove
in interfaceInventory
- Throws:
IllegalArgumentException
-
remove
-
clear
public void clear(int index) -
clear
public void clear() -
close
public int close() -
getViewers
- Specified by:
getViewers
in interfaceInventory
-
iterator
-
getLocation
- Specified by:
getLocation
in interfaceInventory
-
isEmpty
public boolean isEmpty() -
getSnapshot
Creates a snapshot of the inventory.- Returns:
- An inventory snapshot.
-