Class ItemStack
- All Implemented Interfaces:
Cloneable
,ConfigurationSerializable
IMPORTANT: An ItemStack is only designed to contain items. Do not
use this class to encapsulate Materials for which Material.isItem()
returns false.
-
Constructor Summary
ModifierConstructorDescriptionprotected
Creates a new item stack derived from the specified stackDefaults stack size to 1, with no extra data.An item stack with no extra data.Deprecated.Deprecated.this method uses an ambiguous data byte object -
Method Summary
Modifier and TypeMethodDescriptionvoid
addEnchantment(Enchantment ench, int level)
Adds the specifiedEnchantment
to this item stack.void
addEnchantments(Map<Enchantment,Integer> enchantments)
Adds the specified enchantments to this item stack.void
addUnsafeEnchantment(Enchantment ench, int level)
Adds the specifiedEnchantment
to this item stack.void
addUnsafeEnchantments(Map<Enchantment,Integer> enchantments)
Adds the specified enchantments to this item stack in an unsafe manner.clone()
boolean
containsEnchantment(Enchantment ench)
Checks if this ItemStack contains the givenEnchantment
static ItemStack
deserialize(Map<String,Object> args)
Required method for configuration serializationboolean
int
Gets the amount of items in this stackgetData()
Gets the MaterialData for this stack of itemsshort
Deprecated.int
getEnchantmentLevel(Enchantment ench)
Gets the level of the specified enchantment on this item stackGets a map containing all enchantments and their levels on this item.Get a copy of this ItemStack'sItemMeta
.int
Get the maximum stacksize for the material hold in this ItemStack.getType()
Gets the type of this itemint
hashCode()
boolean
Checks to see if any meta data has been defined.boolean
This method is the same as equals, but does not consider stack size (amount).int
removeEnchantment(Enchantment ench)
Removes the specifiedEnchantment
if it exists on this ItemStackCreates a Map representation of this class.void
setAmount(int amount)
Sets the amount of items in this stackvoid
setData(MaterialData data)
Sets the MaterialData for this stack of itemsvoid
setDurability(short durability)
Deprecated.durability is now part of ItemMeta.boolean
setItemMeta(ItemMeta itemMeta)
Set the ItemMeta of this ItemStack.void
Sets the type of this itemtoString()
-
Constructor Details
-
ItemStack
protected ItemStack() -
ItemStack
Defaults stack size to 1, with no extra data.IMPORTANT: An ItemStack is only designed to contain items. Do not use this class to encapsulate Materials for which
Material.isItem()
returns false.- Parameters:
type
- item material
-
ItemStack
An item stack with no extra data.IMPORTANT: An ItemStack is only designed to contain items. Do not use this class to encapsulate Materials for which
Material.isItem()
returns false.- Parameters:
type
- item materialamount
- stack size
-
ItemStack
Deprecated.An item stack with the specified damage / durability- Parameters:
type
- item materialamount
- stack sizedamage
- durability / damage
-
ItemStack
@Deprecated public ItemStack(@NotNull Material type, int amount, short damage, @Nullable Byte data)Deprecated.this method uses an ambiguous data byte object- Parameters:
type
- the typeamount
- the amount in the stackdamage
- the damage value of the itemdata
- the data value or null
-
ItemStack
Creates a new item stack derived from the specified stack- Parameters:
stack
- the stack to copy- Throws:
IllegalArgumentException
- if the specified stack is null or returns an item meta not created by the item factory
-
-
Method Details
-
getType
Gets the type of this item- Returns:
- Type of the items in this stack
-
setType
Sets the type of this itemNote that in doing so you will reset the MaterialData for this stack.
IMPORTANT: An ItemStack is only designed to contain items. Do not use this class to encapsulate Materials for which
Material.isItem()
returns false.- Parameters:
type
- New type to set the items in this stack to
-
getAmount
public int getAmount()Gets the amount of items in this stack- Returns:
- Amount of items in this stack
-
setAmount
public void setAmount(int amount)Sets the amount of items in this stack- Parameters:
amount
- New amount of items in this stack
-
getData
Gets the MaterialData for this stack of items- Returns:
- MaterialData for this item
-
setData
Sets the MaterialData for this stack of items- Parameters:
data
- New MaterialData for this item
-
setDurability
Deprecated.durability is now part of ItemMeta. To avoid confusion and misuse,getItemMeta()
,setItemMeta(ItemMeta)
andDamageable.setDamage(int)
should be used instead. This is because any call to this method will be overwritten by subsequent setting of ItemMeta which was created before this call.Sets the durability of this item- Parameters:
durability
- Durability of this item
-
getDurability
Deprecated.Gets the durability of this item- Returns:
- Durability of this item
-
getMaxStackSize
public int getMaxStackSize()Get the maximum stacksize for the material hold in this ItemStack. (Returns -1 if it has no idea)- Returns:
- The maximum you can stack this material to.
-
toString
-
equals
-
isSimilar
This method is the same as equals, but does not consider stack size (amount).- Parameters:
stack
- the item stack to compare to- Returns:
- true if the two stacks are equal, ignoring the amount
-
clone
-
hashCode
public int hashCode() -
containsEnchantment
Checks if this ItemStack contains the givenEnchantment
- Parameters:
ench
- Enchantment to test- Returns:
- True if this has the given enchantment
-
getEnchantmentLevel
Gets the level of the specified enchantment on this item stack- Parameters:
ench
- Enchantment to check- Returns:
- Level of the enchantment, or 0
-
getEnchantments
Gets a map containing all enchantments and their levels on this item.- Returns:
- Map of enchantments.
-
addEnchantments
Adds the specified enchantments to this item stack.This method is the same as calling
addEnchantment(org.bukkit.enchantments.Enchantment, int)
for each element of the map.- Parameters:
enchantments
- Enchantments to add- Throws:
IllegalArgumentException
- if the specified enchantments is nullIllegalArgumentException
- if any specific enchantment or level is null. Warning: Some enchantments may be added before this exception is thrown.
-
addEnchantment
Adds the specifiedEnchantment
to this item stack.If this item stack already contained the given enchantment (at any level), it will be replaced.
- Parameters:
ench
- Enchantment to addlevel
- Level of the enchantment- Throws:
IllegalArgumentException
- if enchantment null, or enchantment is not applicable
-
addUnsafeEnchantments
Adds the specified enchantments to this item stack in an unsafe manner.This method is the same as calling
addUnsafeEnchantment(org.bukkit.enchantments.Enchantment, int)
for each element of the map.- Parameters:
enchantments
- Enchantments to add
-
addUnsafeEnchantment
Adds the specifiedEnchantment
to this item stack.If this item stack already contained the given enchantment (at any level), it will be replaced.
This method is unsafe and will ignore level restrictions or item type. Use at your own discretion.
- Parameters:
ench
- Enchantment to addlevel
- Level of the enchantment
-
removeEnchantment
Removes the specifiedEnchantment
if it exists on this ItemStack- Parameters:
ench
- Enchantment to remove- Returns:
- Previous level, or 0
-
serialize
Description copied from interface:ConfigurationSerializable
Creates a Map representation of this class.This class must provide a method to restore this class, as defined in the
ConfigurationSerializable
interface javadocs.- Specified by:
serialize
in interfaceConfigurationSerializable
- Returns:
- Map containing the current state of this class
-
deserialize
Required method for configuration serialization- Parameters:
args
- map to deserialize- Returns:
- deserialized item stack
- See Also:
ConfigurationSerializable
-
getItemMeta
Get a copy of this ItemStack'sItemMeta
.- Returns:
- a copy of the current ItemStack's ItemData
-
hasItemMeta
public boolean hasItemMeta()Checks to see if any meta data has been defined.- Returns:
- Returns true if some meta data has been set for this item
-
setItemMeta
Set the ItemMeta of this ItemStack.- Parameters:
itemMeta
- new ItemMeta, or null to indicate meta data be cleared.- Returns:
- True if successfully applied ItemMeta, see
ItemFactory.isApplicable(ItemMeta, ItemStack)
- Throws:
IllegalArgumentException
- if the item meta was not created by theItemFactory
-
setDurability(short)