eu.wauz.wauzcore.items

Class InventoryItemRemover

java.lang.Object

eu.wauz.wauzcore.items.InventoryItemRemover

public class InventoryItemRemover
extends java.lang.Object

A class to count and remove specific items from a player inventory.

Author:

Wauzmons

Field Summary

Fields

Modifier and Type	Field and Description
private org.bukkit.inventory.Inventory	inventory The inventory, to count and remove items from.
private java.util.Map<java.lang.String,java.lang.Integer>	itemNameAmountMap A map of the amounts to remove, indexed by item name.

Constructor Summary

Constructors

Constructor and Description
InventoryItemRemover(org.bukkit.inventory.Inventory inventory) Creates a new inventory item remover for the given inventory.

Method Summary

Modifier and Type	Method and Description
void	addItemNameToRemove(java.lang.String itemName, java.lang.Integer itemAmount) Adds an item to remove from the inventory.
org.bukkit.inventory.Inventory	execute() Removes all the registered items from the inventory.
private void	findAndRemoveItems(java.lang.String itemName, java.lang.Integer itemAmount) Removes the given amount of the given item from the inventory.
private java.lang.Integer	removeItemsGetRemaining(org.bukkit.inventory.ItemStack itemStack, java.lang.Integer itemAmount) Removes items from a stack, till the stack is empty or the given amount is reached.

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

inventory

private org.bukkit.inventory.Inventory inventory

The inventory, to count and remove items from.

itemNameAmountMap

private java.util.Map<java.lang.String,java.lang.Integer> itemNameAmountMap

A map of the amounts to remove, indexed by item name.

Constructor Detail

InventoryItemRemover

public InventoryItemRemover(org.bukkit.inventory.Inventory inventory)

Creates a new inventory item remover for the given inventory.

Parameters:

inventory - The inventory, to count and remove items from.

Method Detail

addItemNameToRemove

public void addItemNameToRemove(java.lang.String itemName,
                                java.lang.Integer itemAmount)

Adds an item to remove from the inventory.

Parameters:

itemName - The name of the item.

itemAmount - The amount to remove.

execute

public org.bukkit.inventory.Inventory execute()

Removes all the registered items from the inventory.

Returns:

The cleaned up inventory.

See Also:

findAndRemoveItems(String, Integer)

findAndRemoveItems

private void findAndRemoveItems(java.lang.String itemName,
                                java.lang.Integer itemAmount)

Removes the given amount of the given item from the inventory.

Parameters:

itemName - The name of the item.

itemAmount - The amount to remove.

See Also:

removeItemsGetRemaining(ItemStack, Integer)

removeItemsGetRemaining

private java.lang.Integer removeItemsGetRemaining(org.bukkit.inventory.ItemStack itemStack,
                                                  java.lang.Integer itemAmount)

Removes items from a stack, till the stack is empty or the given amount is reached.

Parameters:

itemStack - The item stack to remove from.

itemAmount - The amount to remove.

Returns:

The amount left to remove from another stack.