org.bukkit.inventory

Class ItemStack

java.lang.Object

org.bukkit.inventory.ItemStack

All Implemented Interfaces:

Cloneable, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowItem>, ConfigurationSerializable

public class ItemStack
extends Object
implements Cloneable, ConfigurationSerializable, net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowItem>

Represents a stack of items.

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

Constructors

Modifier	Constructor and Description
protected	ItemStack()
	ItemStack(@NotNull ItemStack stack) Creates a new item stack derived from the specified stack
	ItemStack(@NotNull Material type) Defaults stack size to 1, with no extra data.
	ItemStack(@NotNull Material type, int amount) An item stack with no extra data.
	ItemStack(@NotNull Material type, int amount, short damage) Deprecated. see setDurability(short)
	ItemStack(@NotNull Material type, int amount, short damage, @Nullable Byte data) Deprecated. this method uses an ambiguous data byte object

Method Summary

Modifier and Type	Method and Description
@NotNull ItemStack	add() Adds 1 to this itemstack.
@NotNull ItemStack	add(int qty) Adds quantity to this itemstack.
void	addEnchantment(@NotNull Enchantment ench, int level) Adds the specified Enchantment to this item stack.
void	addEnchantments(@NotNull Map<Enchantment,Integer> enchantments) Adds the specified enchantments to this item stack.
void	addItemFlags(ItemFlag... itemFlags) Set itemflags which should be ignored when rendering a ItemStack in the Client.
void	addUnsafeEnchantment(@NotNull Enchantment ench, int level) Adds the specified Enchantment to this item stack.
void	addUnsafeEnchantments(@NotNull Map<Enchantment,Integer> enchantments) Adds the specified enchantments to this item stack in an unsafe manner.
net.kyori.adventure.text.event.HoverEvent<net.kyori.adventure.text.event.HoverEvent.ShowItem>	asHoverEvent(UnaryOperator<net.kyori.adventure.text.event.HoverEvent.ShowItem> op)
@NotNull ItemStack	asOne() Clones the itemstack and returns it a single quantity.
@NotNull ItemStack	asQuantity(int qty) Clones the itemstack and returns it as the specified quantity
boolean	canRepair(@NotNull ItemStack toBeRepaired) Checks if this itemstack can repair another.
@NotNull ItemStack	clone()
boolean	containsEnchantment(@NotNull Enchantment ench) Checks if this ItemStack contains the given Enchantment
static @NotNull ItemStack	deserialize(@NotNull Map<String,Object> args) Required method for configuration serialization
static @NotNull ItemStack	deserializeBytes(@NotNull byte[] bytes) Deserializes this itemstack from raw NBT bytes.
net.kyori.adventure.text.Component	displayName() Get the formatted display name of the ItemStack.
@NotNull ItemStack	ensureServerConversions() Minecart updates are converting simple item stacks into more complex NBT oriented Item Stacks.
boolean	equals(Object obj)
int	getAmount() Gets the amount of items in this stack
@Nullable MaterialData	getData() Gets the MaterialData for this stack of items
short	getDurability() Deprecated. see setDurability(short)
int	getEnchantmentLevel(@NotNull Enchantment ench) Gets the level of the specified enchantment on this item stack
@NotNull Map<Enchantment,Integer>	getEnchantments() Gets a map containing all enchantments and their levels on this item.
@Nullable String	getI18NDisplayName() Gets the Display name as seen in the Client.
@NotNull Set<ItemFlag>	getItemFlags() Get current set itemFlags.
ItemMeta	getItemMeta() Get a copy of this ItemStack's ItemMeta.
@Nullable List<String>	getLore() Deprecated. in favor of lore()
int	getMaxItemUseDuration()
int	getMaxStackSize() Get the maximum stacksize for the material hold in this ItemStack.
ItemRarity	getRarity() Gets the item rarity of the itemstack.
@NotNull String	getTranslationKey() Gets the translation key for this itemstack.
@NotNull Material	getType() Gets the type of this item
int	hashCode()
boolean	hasItemFlag(@NotNull ItemFlag flag) Check if the specified flag is present on this item.
boolean	hasItemMeta() Checks to see if any meta data has been defined.
boolean	isRepairableBy(@NotNull ItemStack repairMaterial) Checks if an itemstack can repair this itemstack.
boolean	isSimilar(@Nullable ItemStack stack) This method is the same as equals, but does not consider stack size (amount).
@Nullable List<net.kyori.adventure.text.Component>	lore() If the item has lore, returns it, else it will return null
void	lore(@Nullable List<net.kyori.adventure.text.Component> lore) Sets the lore for this item.
int	removeEnchantment(@NotNull Enchantment ench) Removes the specified Enchantment if it exists on this ItemStack
void	removeItemFlags(ItemFlag... itemFlags) Remove specific set of itemFlags.
@NotNull Map<String,Object>	serialize() Creates a Map representation of this class.
@NotNull byte[]	serializeAsBytes() Serializes this itemstack to raw bytes in NBT.
void	setAmount(int amount) Sets the amount of items in this stack
void	setData(@Nullable MaterialData data) Sets the MaterialData for this stack of items
void	setDurability(short durability) Deprecated. durability is now part of ItemMeta. To avoid confusion and misuse, getItemMeta(), setItemMeta(ItemMeta) and Damageable.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.
boolean	setItemMeta(@Nullable ItemMeta itemMeta) Set the ItemMeta of this ItemStack.
void	setLore(@Nullable List<String> lore) Deprecated. in favour of lore(List)
void	setType(@NotNull Material type) Sets the type of this item
@NotNull ItemStack	subtract() Subtracts 1 to this itemstack.
@NotNull ItemStack	subtract(int qty) Subtracts quantity to this itemstack.
String	toString()

Methods inherited from class java.lang.Object

finalize, getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface net.kyori.adventure.text.event.HoverEventSource

asHoverEvent, unbox

Constructor Detail

ItemStack

protected ItemStack()

ItemStack

public ItemStack(@NotNull
                 @NotNull Material type)

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

public ItemStack(@NotNull
                 @NotNull Material type,
                 int amount)

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 material

amount - stack size

ItemStack

public ItemStack(@NotNull
                 @NotNull Material type,
                 int amount,
                 short damage)

Deprecated. see setDurability(short)

An item stack with the specified damage / durability

Parameters:

type - item material

amount - stack size

damage - durability / damage

ItemStack

@Deprecated
public ItemStack(@NotNull
                             @NotNull Material type,
                             int amount,
                             short damage,
                             @Nullable
                             @Nullable Byte data)

Deprecated. this method uses an ambiguous data byte object

Parameters:

type - the type

amount - the amount in the stack

damage - the damage value of the item

data - the data value or null

ItemStack

public ItemStack(@NotNull
                 @NotNull ItemStack stack)
          throws IllegalArgumentException

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 Detail

getType

@NotNull
public @NotNull Material getType()

Gets the type of this item

Returns:

Type of the items in this stack

setType

public void setType(@NotNull
                    @NotNull Material type)

Sets the type of this item

Note 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

@Nullable
public @Nullable MaterialData getData()

Gets the MaterialData for this stack of items

Returns:

MaterialData for this item

setData

public void setData(@Nullable
                    @Nullable MaterialData data)

Sets the MaterialData for this stack of items

Parameters:

data - New MaterialData for this item

setDurability

@Deprecated
public void setDurability(short durability)

Deprecated. durability is now part of ItemMeta. To avoid confusion and misuse, getItemMeta(), setItemMeta(ItemMeta) and Damageable.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
public short getDurability()

Deprecated. see setDurability(short)

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

public String toString()

Overrides:

toString in class Object

equals

public boolean equals(Object obj)

Overrides:

equals in class Object

isSimilar

public boolean isSimilar(@Nullable
                         @Nullable ItemStack stack)

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

@NotNull
public @NotNull ItemStack clone()

Overrides:

clone in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

containsEnchantment

public boolean containsEnchantment(@NotNull
                                   @NotNull Enchantment ench)

Checks if this ItemStack contains the given Enchantment

Parameters:

ench - Enchantment to test

Returns:

True if this has the given enchantment

getEnchantmentLevel

public int getEnchantmentLevel(@NotNull
                               @NotNull Enchantment ench)

Gets the level of the specified enchantment on this item stack

Parameters:

ench - Enchantment to check

Returns:

Level of the enchantment, or 0

getEnchantments

@NotNull
public @NotNull Map<Enchantment,Integer> getEnchantments()

Gets a map containing all enchantments and their levels on this item.

Returns:

Map of enchantments.

addEnchantments

public void addEnchantments(@NotNull
                            @NotNull Map<Enchantment,Integer> enchantments)

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 null

IllegalArgumentException - if any specific enchantment or level is null. Warning: Some enchantments may be added before this exception is thrown.

addEnchantment

public void addEnchantment(@NotNull
                           @NotNull Enchantment ench,
                           int level)

Adds the specified Enchantment to this item stack.

If this item stack already contained the given enchantment (at any level), it will be replaced.

Parameters:

ench - Enchantment to add

level - Level of the enchantment

Throws:

IllegalArgumentException - if enchantment null, or enchantment is not applicable

addUnsafeEnchantments

public void addUnsafeEnchantments(@NotNull
                                  @NotNull Map<Enchantment,Integer> enchantments)

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

public void addUnsafeEnchantment(@NotNull
                                 @NotNull Enchantment ench,
                                 int level)

Adds the specified Enchantment 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 add

level - Level of the enchantment

removeEnchantment

public int removeEnchantment(@NotNull
                             @NotNull Enchantment ench)

Removes the specified Enchantment if it exists on this ItemStack

Parameters:

ench - Enchantment to remove

Returns:

Previous level, or 0

serialize

@NotNull
public @NotNull Map<String,Object> 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 interface ConfigurationSerializable

Returns:

Map containing the current state of this class

deserialize

@NotNull
public static @NotNull ItemStack deserialize(@NotNull
                                                      @NotNull Map<String,Object> args)

Required method for configuration serialization

Parameters:

args - map to deserialize

Returns:

deserialized item stack

See Also:

ConfigurationSerializable

getItemMeta

public ItemMeta getItemMeta()

Get a copy of this ItemStack's ItemMeta.

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

public boolean setItemMeta(@Nullable
                           @Nullable ItemMeta itemMeta)

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 the ItemFactory

asHoverEvent

@NotNull
public net.kyori.adventure.text.event.HoverEvent<net.kyori.adventure.text.event.HoverEvent.ShowItem> asHoverEvent(@NotNull
                                                                                                                           UnaryOperator<net.kyori.adventure.text.event.HoverEvent.ShowItem> op)

Specified by:

asHoverEvent in interface net.kyori.adventure.text.event.HoverEventSource<net.kyori.adventure.text.event.HoverEvent.ShowItem>

displayName

@NotNull
public net.kyori.adventure.text.Component displayName()

Get the formatted display name of the ItemStack.

Returns:

display name of the ItemStack

ensureServerConversions

@NotNull
public @NotNull ItemStack ensureServerConversions()

Minecart updates are converting simple item stacks into more complex NBT oriented Item Stacks. Use this method to to ensure any desired data conversions are processed. The input itemstack will not be the same as the returned itemstack.

Returns:

A potentially Data Converted ItemStack

deserializeBytes

@NotNull
public static @NotNull ItemStack deserializeBytes(@NotNull
                                                           @NotNull byte[] bytes)

Deserializes this itemstack from raw NBT bytes. NBT is safer for data migrations as it will use the built in data converter instead of bukkits dangerous serialization system. This expects that the DataVersion was stored on the root of the Compound, as saved from the serializeAsBytes() API returned.

Parameters:

bytes - bytes representing an item in NBT

Returns:

ItemStack migrated to this version of Minecraft if needed.

serializeAsBytes

@NotNull
public @NotNull byte[] serializeAsBytes()

Serializes this itemstack to raw bytes in NBT. NBT is safer for data migrations as it will use the built in data converter instead of bukkits dangerous serialization system.

Returns:

bytes representing this item in NBT.

getI18NDisplayName

@Nullable
public @Nullable String getI18NDisplayName()

Gets the Display name as seen in the Client. Currently the server only supports the English language. To override this, You must replace the language file embedded in the server jar.

Returns:

Display name of Item

getMaxItemUseDuration

public int getMaxItemUseDuration()

asOne

@NotNull
public @NotNull ItemStack asOne()

Clones the itemstack and returns it a single quantity.

Returns:

The new itemstack with 1 quantity

asQuantity

@NotNull
public @NotNull ItemStack asQuantity(int qty)

Clones the itemstack and returns it as the specified quantity

Parameters:

qty - The quantity of the cloned item

Returns:

The new itemstack with specified quantity

add

@NotNull
public @NotNull ItemStack add()

Adds 1 to this itemstack. Will not go over the items max stack size.

Returns:

The same item (not a clone)

add

@NotNull
public @NotNull ItemStack add(int qty)

Adds quantity to this itemstack. Will not go over the items max stack size.

Parameters:

qty - The amount to add

Returns:

The same item (not a clone)

subtract

@NotNull
public @NotNull ItemStack subtract()

Subtracts 1 to this itemstack. Going to 0 or less will invalidate the item.

Returns:

The same item (not a clone)

subtract

@NotNull
public @NotNull ItemStack subtract(int qty)

Subtracts quantity to this itemstack. Going to 0 or less will invalidate the item.

Parameters:

qty - The amount to add

Returns:

The same item (not a clone)

getLore

@Deprecated
 @Nullable
public @Nullable List<String> getLore()

Deprecated. in favor of lore()

If the item has lore, returns it, else it will return null

Returns:

The lore, or null

lore

@Nullable
public @Nullable List<net.kyori.adventure.text.Component> lore()

If the item has lore, returns it, else it will return null

Returns:

The lore, or null

setLore

@Deprecated
public void setLore(@Nullable
                                @Nullable List<String> lore)

Deprecated. in favour of lore(List)

Sets the lore for this item. Removes lore when given null.

Parameters:

lore - the lore that will be set

lore

public void lore(@Nullable
                 @Nullable List<net.kyori.adventure.text.Component> lore)

Sets the lore for this item. Removes lore when given null.

Parameters:

lore - the lore that will be set

addItemFlags

public void addItemFlags(@NotNull
                         ItemFlag... itemFlags)

Set itemflags which should be ignored when rendering a ItemStack in the Client. This Method does silently ignore double set itemFlags.

Parameters:

itemFlags - The hideflags which shouldn't be rendered

removeItemFlags

public void removeItemFlags(@NotNull
                            ItemFlag... itemFlags)

Remove specific set of itemFlags. This tells the Client it should render it again. This Method does silently ignore double removed itemFlags.

Parameters:

itemFlags - Hideflags which should be removed

getItemFlags

@NotNull
public @NotNull Set<ItemFlag> getItemFlags()

Get current set itemFlags. The collection returned is unmodifiable.

Returns:

A set of all itemFlags set

hasItemFlag

public boolean hasItemFlag(@NotNull
                           @NotNull ItemFlag flag)

Check if the specified flag is present on this item.

Parameters:

flag - the flag to check

Returns:

if it is present

getTranslationKey

@NotNull
public @NotNull String getTranslationKey()

Gets the translation key for this itemstack. This is not the same as getting the translation key for the material of this itemstack.

Returns:

the translation key

getRarity

@NotNull
public ItemRarity getRarity()

Gets the item rarity of the itemstack. The rarity can change based on enchantements.

Returns:

the itemstack rarity

isRepairableBy

public boolean isRepairableBy(@NotNull
                              @NotNull ItemStack repairMaterial)

Checks if an itemstack can repair this itemstack. Returns false if this or repairMaterial's type is not an item (Material.isItem()).

Parameters:

repairMaterial - the repair material

Returns:

true if it is repairable by, false if not

canRepair

public boolean canRepair(@NotNull
                         @NotNull ItemStack toBeRepaired)

Checks if this itemstack can repair another. Returns false if this or toBeRepaired's type is not an item (Material.isItem()).

Parameters:

toBeRepaired - the itemstack to be repaired

Returns:

true if it can repair, false if not