Pulling all pending Bukkit-JavaDoc changes
By: Wesley Wolfe <weswolf@aol.com>
This commit is contained in:
@@ -1,6 +1,7 @@
|
||||
package org.bukkit.inventory;
|
||||
|
||||
public interface BeaconInventory extends Inventory {
|
||||
|
||||
/**
|
||||
* Set the item powering the beacon.
|
||||
*
|
||||
|
||||
@@ -3,6 +3,7 @@ package org.bukkit.inventory;
|
||||
import org.bukkit.block.BrewingStand;
|
||||
|
||||
public interface BrewerInventory extends Inventory {
|
||||
|
||||
/**
|
||||
* Get the current ingredient for brewing.
|
||||
*
|
||||
|
||||
@@ -4,6 +4,7 @@ package org.bukkit.inventory;
|
||||
* Interface to the crafting inventories
|
||||
*/
|
||||
public interface CraftingInventory extends Inventory {
|
||||
|
||||
/**
|
||||
* Check what item is in the result slot of this crafting inventory.
|
||||
*
|
||||
|
||||
@@ -3,6 +3,7 @@ package org.bukkit.inventory;
|
||||
import org.bukkit.block.DoubleChest;
|
||||
|
||||
public interface DoubleChestInventory extends Inventory {
|
||||
|
||||
/**
|
||||
* Get the left half of this double chest.
|
||||
*
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package org.bukkit.inventory;
|
||||
|
||||
public interface EnchantingInventory extends Inventory {
|
||||
|
||||
/**
|
||||
* Set the item being enchanted.
|
||||
*
|
||||
|
||||
@@ -6,6 +6,7 @@ import org.bukkit.entity.Entity;
|
||||
* An interface to a creatures inventory
|
||||
*/
|
||||
public interface EntityEquipment {
|
||||
|
||||
/**
|
||||
* Gets a copy of the item the entity is currently holding
|
||||
*
|
||||
|
||||
@@ -3,6 +3,7 @@ package org.bukkit.inventory;
|
||||
import org.bukkit.block.Furnace;
|
||||
|
||||
public interface FurnaceInventory extends Inventory {
|
||||
|
||||
/**
|
||||
* Get the current item in the result slot.
|
||||
*
|
||||
|
||||
@@ -171,21 +171,28 @@ public interface Inventory extends Iterable<ItemStack> {
|
||||
public boolean contains(Material material, int amount) throws IllegalArgumentException;
|
||||
|
||||
/**
|
||||
* Checks if the inventory contains any ItemStacks matching the given ItemStack and at least the minimum amount specified
|
||||
* This will only match if both the type and the amount of the stack match
|
||||
* Checks if the inventory contains at least the minimum amount specified
|
||||
* of exactly matching ItemStacks.
|
||||
* <p>
|
||||
* An ItemStack only counts if both the type and the amount of the stack
|
||||
* match.
|
||||
*
|
||||
* @param item The ItemStack to match against
|
||||
* @param amount The amount of stacks to find
|
||||
* @return false if item is null, true if amount less than 1, true if amount of exactly matching ItemStacks were found.
|
||||
* @param item the ItemStack to match against
|
||||
* @param amount how many identical stacks to check for
|
||||
* @return false if item is null, true if amount less than 1, true if
|
||||
* amount of exactly matching ItemStacks were found
|
||||
* @see #containsAtLeast(ItemStack, int)
|
||||
*/
|
||||
public boolean contains(ItemStack item, int amount);
|
||||
|
||||
/**
|
||||
* Checks if the inventory contains any ItemStacks matching the given ItemStack and at least the minimum amount specified
|
||||
* Checks if the inventory contains ItemStacks matching the given
|
||||
* ItemStack whose amounts sum to at least the minimum amount specified.
|
||||
*
|
||||
* @param item The ItemStack to match against
|
||||
* @param amount The minimum amount
|
||||
* @return false if item is null, true if amount less than 1, true if enough ItemStacks were found to add to the given amount
|
||||
* @param item the ItemStack to match against
|
||||
* @param amount the minimum amount
|
||||
* @return false if item is null, true if amount less than 1, true if
|
||||
* enough ItemStacks were found to add to the given amount
|
||||
*/
|
||||
public boolean containsAtLeast(ItemStack item, int amount);
|
||||
|
||||
|
||||
@@ -1,6 +1,7 @@
|
||||
package org.bukkit.inventory;
|
||||
|
||||
public interface InventoryHolder {
|
||||
|
||||
/**
|
||||
* Get the object's inventory.
|
||||
*
|
||||
|
||||
Reference in New Issue
Block a user