Package io.github.bakedlibs.dough.items

Class ItemStackSnapshot

java.lang.Object

org.bukkit.inventory.ItemStack

io.github.bakedlibs.dough.items.ItemStackSnapshot

All Implemented Interfaces:

Cloneable, ConfigurationSerializable

public final class ItemStackSnapshot
extends ItemStack

This ItemStack, which is not intended for actual usage, caches its ItemMeta. This significantly speeds up any ItemStack comparisons a lot. You cannot invoke equals(Object), hashCode() or any of its setter on an ItemStackSnapshot.
Please be very careful when using this.

Author:

TheBusyBiscuit, md5sha256

Method Summary

Modifier and Type	Method	Description
void	addUnsafeEnchantment(Enchantment ench, int level)
ItemStack	clone()
boolean	equals(Object obj)
static ItemStackSnapshot	forceWrap(ItemStack itemStack)	Creates an ItemStackSnapshot of an ItemStack.
int	getAmount()
ItemMeta	getItemMeta()
int	hashCode()
boolean	hasItemMeta()
void	setAmount(int amount)
boolean	setItemMeta(ItemMeta itemMeta)
void	setType(Material type)
static ItemStackSnapshot	wrap(ItemStack itemStack)	Creates an ItemStackSnapshot of an ItemStack.
static ItemStackSnapshot[]	wrapArray(ItemStack[] items)	This creates an ItemStackSnapshot array from a given ItemStack array.
static List<ItemStackSnapshot>	wrapList(List<ItemStack> items)	This creates an ItemStackSnapshot List from a given ItemStack List *

Methods inherited from class org.bukkit.inventory.ItemStack

addEnchantment, addEnchantments, addUnsafeEnchantments, containsEnchantment, deserialize, getData, getDurability, getEnchantmentLevel, getEnchantments, getMaxStackSize, getType, isSimilar, removeEnchantment, serialize, setData, setDurability, toString

Methods inherited from class java.lang.Object

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

Method Details

hasItemMeta

public boolean hasItemMeta()

Overrides:

hasItemMeta in class ItemStack

getItemMeta

public ItemMeta getItemMeta()

Overrides:

getItemMeta in class ItemStack

getAmount

public int getAmount()

Overrides:

getAmount in class ItemStack

equals

public boolean equals(Object obj)

Overrides:

equals in class ItemStack

hashCode

public int hashCode()

Overrides:

hashCode in class ItemStack

clone

public ItemStack clone()

Overrides:

clone in class ItemStack

setType

public void setType(Material type)

Overrides:

setType in class ItemStack

setAmount

public void setAmount(int amount)

Overrides:

setAmount in class ItemStack

setItemMeta

public boolean setItemMeta(ItemMeta itemMeta)

Overrides:

setItemMeta in class ItemStack

addUnsafeEnchantment

public void addUnsafeEnchantment(Enchantment ench,
 int level)

Overrides:

addUnsafeEnchantment in class ItemStack

forceWrap

@Nonnull
public static ItemStackSnapshot forceWrap(@Nonnull
 ItemStack itemStack)

Creates an ItemStackSnapshot of an ItemStack. This method will not check if the passed ItemStack has already been wrapped

Parameters:

itemStack - The ItemStack to wrap

Returns:

Returns an ItemStackSnapshot of the passed ItemStack

See Also:

• wrap(ItemStack)

wrap

@Nonnull
public static ItemStackSnapshot wrap(@Nonnull
 ItemStack itemStack)

Creates an ItemStackSnapshot of an ItemStack. This method will return the the casted reference of the passed ItemStack if it is already an ItemStackSnapshot

Parameters:

itemStack - The ItemStack to wrap

Returns:

Returns an ItemStackSnapshot of the passed ItemStack

See Also:

• forceWrap(ItemStack)

wrapArray

@Nonnull
public static ItemStackSnapshot[] wrapArray(@Nonnull
 ItemStack[] items)

This creates an ItemStackSnapshot array from a given ItemStack array.

Parameters:

items - The array of ItemStacks to transform

Returns:

An ItemStackSnapshot array

wrapList

@Nonnull
public static List<ItemStackSnapshot> wrapList(@Nonnull
 List<ItemStack> items)

This creates an ItemStackSnapshot List from a given ItemStack List *

Parameters:

items - The List of ItemStacks to transform

Returns:

An ItemStackSnapshot array