General cleanup (deprecated+whitespace)

By: Erik Broes <erikbroes@grum.nl>
This commit is contained in:
Bukkit/Spigot
2011-02-02 00:02:08 +01:00
parent b01fc3ffa8
commit 474817bf11
27 changed files with 224 additions and 244 deletions

View File

@@ -9,21 +9,21 @@ import org.bukkit.Material;
public interface Inventory {
/**
* Returns the size of the inventory
*
*
* @return The inventory size
*/
public int getSize();
/**
* Return the name of the inventory
*
*
* @return The inventory name
*/
public String getName();
/**
* Get the ItemStack found in the slot at the given index
*
*
* @param index The index of the Slot's ItemStack to return
* @return The ItemStack in the slot
*/
@@ -31,7 +31,7 @@ public interface Inventory {
/**
* Stores the ItemStack at the given index
*
*
* @param index The index where to put the ItemStack
* @param item The ItemStack to set
*/
@@ -39,60 +39,60 @@ public interface Inventory {
/**
* Stores the given ItemStacks in the inventory.
*
*
* This will try to fill existing stacks and empty slots as good as it can.
* It will return a HashMap of what it couldn't fit.
*
*
* @param items The ItemStacks to add
* @return
* @return
*/
public HashMap<Integer, ItemStack> addItem(ItemStack... items);
/**
* 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. It will return a HashMap of what it couldn't remove.
*
*
* @param items The ItemStacks to remove
* @return
* @return
*/
public HashMap<Integer, ItemStack> removeItem(ItemStack... items);
/**
* Get all ItemStacks from the inventory
*
*
* @return All the ItemStacks from all slots
*/
public ItemStack[] getContents();
/**
* Set the inventory's contents
*
*
* @return All the ItemStacks from all slots
*/
public void setContents(ItemStack[] items);
/**
* Check if the inventory contains any ItemStacks with the given materialId
*
*
* @param materialId The materialId to check for
* @return If any ItemStacks were found
*/
public boolean contains(int materialId);
public boolean contains(int materialId);
/**
* Check if the inventory contains any ItemStacks with the given material
*
*
* @param material The material to check for
* @return If any ItemStacks were found
*/
public boolean contains(Material material);
public boolean contains(Material material);
/**
* Check if the inventory contains any ItemStacks matching the given ItemStack
* This will only match if both the type and the amount of the stack match
*
*
* @param item The ItemStack to match against
* @return If any matching ItemStacks were found
*/
@@ -100,24 +100,24 @@ public interface Inventory {
/**
* Find all slots in the inventory containing any ItemStacks with the given materialId
*
*
* @param materialId The materialId to look for
* @return The Slots found.
*/
public HashMap<Integer, ? extends ItemStack> all(int materialId);
public HashMap<Integer, ? extends ItemStack> all(int materialId);
/**
* Find all slots in the inventory containing any ItemStacks with the given material
*
*
* @param materialId The material to look for
* @return The Slots found.
*/
public HashMap<Integer, ? extends ItemStack> all(Material material);
public HashMap<Integer, ? extends ItemStack> all(Material material);
/**
* Find 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
*
*
* @param item The ItemStack to match against
* @return The Slots found.
*/
@@ -125,7 +125,7 @@ public interface Inventory {
/**
* Find the first slot in the inventory containing an ItemStack with the given materialId
*
*
* @param materialId The materialId to look for
* @return The Slot found.
*/
@@ -133,7 +133,7 @@ public interface Inventory {
/**
* Find the first slot in the inventory containing an ItemStack with the given material
*
*
* @param materialId The material to look for
* @return The Slot found.
*/
@@ -142,7 +142,7 @@ public interface Inventory {
/**
* Find 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
*
*
* @param item The ItemStack to match against
* @return The Slot found.
*/
@@ -150,21 +150,21 @@ public interface Inventory {
/**
* Find the first empty Slot.
*
*
* @return The first empty Slot found.
*/
public int firstEmpty();
/**
* Remove all stacks in the inventory matching the given materialId.
*
*
* @param materialId The material to remove
*/
public void remove(int materialId);
/**
* Remove all stacks in the inventory matching the given material.
*
*
* @param material The material to remove
*/
public void remove(Material material);
@@ -172,14 +172,14 @@ public interface Inventory {
/**
* Remove 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
*
*
* @param item The ItemStack to match against
*/
public void remove(ItemStack item);
/**
* Clear out a particular slot in the index
*
*
* @param index The index to empty.
*/
public void clear(int index);

View File

@@ -6,21 +6,21 @@ package org.bukkit.inventory;
public interface Slot {
/**
* Gets the inventory this slot belongs to
*
*
* @return The inventory
*/
public Inventory getInventory();
/**
* Get the index this slot belongs to
*
*
* @return Index of the slot
*/
public int getIndex();
/**
* Get the item from the slot.
*
*
* @return ItemStack in the slot.
*/
public ItemStack getItem();