de.tr7zw.changeme.nbtapi

Class NBTItem

java.lang.Object

de.tr7zw.changeme.nbtapi.NBTCompound

de.tr7zw.changeme.nbtapi.NBTItem

All Implemented Interfaces:

ReadableItemNBT, ReadableNBT, ReadWriteItemNBT, ReadWriteNBT

public class NBTItem
extends NBTCompound
implements ReadWriteItemNBT

NBT class to access vanilla/custom tags on ItemStacks. This class doesn't autosave to the Itemstack, use getItem to get the changed ItemStack

Author:

tr7zw

Constructor Summary

Constructors

Modifier	Constructor and Description
	NBTItem(org.bukkit.inventory.ItemStack item) Deprecated.
	NBTItem(org.bukkit.inventory.ItemStack item, boolean directApply) Deprecated.
protected	NBTItem(org.bukkit.inventory.ItemStack item, boolean directApply, boolean readOnly, boolean finalizer)

Method Summary

Modifier and Type	Method and Description
void	applyNBT(org.bukkit.inventory.ItemStack item) Deprecated.
void	clearCustomNBT() Deprecated.
static NBTContainer	convertItemArraytoNBT(org.bukkit.inventory.ItemStack[] items) Deprecated.
static NBTContainer	convertItemtoNBT(org.bukkit.inventory.ItemStack item) Deprecated.
static org.bukkit.inventory.ItemStack	convertNBTtoItem(NBTCompound comp) Deprecated.
static org.bukkit.inventory.ItemStack[]	convertNBTtoItemArray(NBTCompound comp) Deprecated.
protected void	finalizeChanges()
Object	getCompound()
org.bukkit.inventory.ItemStack	getItem()
boolean	hasCustomNbtData() Deprecated.
boolean	hasNBTData() Returns true if the item has NBT data.
protected boolean	isClosed()
void	mergeCustomNBT(org.bukkit.inventory.ItemStack item) Deprecated.
void	mergeNBT(org.bukkit.inventory.ItemStack item) Deprecated.
void	modifyMeta(BiConsumer<ReadableNBT,org.bukkit.inventory.meta.ItemMeta> handler) Gives save access to the ItemMeta of the internal ItemStack.
<T extends org.bukkit.inventory.meta.ItemMeta> void	modifyMeta(Class<T> type, BiConsumer<ReadableNBT,T> handler) Gives save access to the ItemMeta of the internal ItemStack.
protected void	saveCompound()
protected void	setClosed()
protected void	setCompound(Object compound)
protected void	setItem(org.bukkit.inventory.ItemStack item)

Methods inherited from class de.tr7zw.changeme.nbtapi.NBTCompound

addCompound, asNBTString, clearNBT, equals, get, getBoolean, getByte, getByteArray, getCompound, getCompoundList, getDouble, getDoubleList, getEnum, getFloat, getFloatList, getIntArray, getIntArrayList, getInteger, getIntegerList, getItemStack, getItemStackArray, getKeys, getListType, getLong, getLongArray, getLongList, getName, getObject, getOrCreateCompound, getOrDefault, getOrNull, getParent, getReadLock, getResolvedObject, getShort, getString, getStringList, getType, getUUID, getUUIDList, getWriteLock, hashCode, hasKey, hasTag, isReadOnly, mergeCompound, mergeCompound, removeKey, resolveCompound, resolveOrCreateCompound, resolveOrDefault, resolveOrNull, set, set, setBoolean, setByte, setByteArray, setDouble, setEnum, setFloat, setIntArray, setInteger, setItemStack, setItemStackArray, setLong, setLongArray, setObject, setResolvedObject, setShort, setString, setUUID, toString, toString, writeCompound

Methods inherited from class java.lang.Object

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

Methods inherited from interface de.tr7zw.changeme.nbtapi.iface.ReadWriteNBT

clearNBT, getCompound, getCompoundList, getDoubleList, getFloatList, getIntArrayList, getIntegerList, getLongList, getOrCreateCompound, getStringList, getUUIDList, mergeCompound, removeKey, resolveCompound, resolveOrCreateCompound, set, setBoolean, setByte, setByteArray, setDouble, setEnum, setFloat, setIntArray, setInteger, setItemStack, setItemStackArray, setLong, setLongArray, setShort, setString, setUUID

Methods inherited from interface de.tr7zw.changeme.nbtapi.iface.ReadableNBT

get, getBoolean, getByte, getByteArray, getDouble, getEnum, getFloat, getIntArray, getInteger, getItemStack, getItemStackArray, getKeys, getListType, getLong, getLongArray, getOrDefault, getOrNull, getShort, getString, getType, getUUID, hasTag, hasTag, resolveOrDefault, resolveOrNull, toString, writeCompound

Constructor Detail

NBTItem

@Deprecated
public NBTItem(org.bukkit.inventory.ItemStack item)

Deprecated.

Constructor for NBTItems. The ItemStack will be cloned! Deprecated: Please use the NBT class to work with items. It's up to 400% faster and provides less ways to mess up code.

Parameters:

item -

NBTItem

protected NBTItem(org.bukkit.inventory.ItemStack item,
                  boolean directApply,
                  boolean readOnly,
                  boolean finalizer)

Parameters:

item -

directApply -

readOnly - When turned on, no copy of the source item is created. Modifying the stack in that case is not valid! Also overwrites directApply

NBTItem

@Deprecated
public NBTItem(org.bukkit.inventory.ItemStack item,
                           boolean directApply)

Deprecated.

Constructor for NBTItems. The ItemStack will be cloned! If directApply is true, all changed will be mapped to the original item. Changes to the NBTItem will overwrite changes done to the original item in that case.

Parameters:

item -

directApply -

Method Detail

getCompound

public Object getCompound()

Overrides:

getCompound in class NBTCompound

Returns:

The NMS Compound behind this Object

finalizeChanges

protected void finalizeChanges()

setClosed

protected void setClosed()

Overrides:

setClosed in class NBTCompound

isClosed

protected boolean isClosed()

Overrides:

isClosed in class NBTCompound

setCompound

protected void setCompound(Object compound)

Overrides:

setCompound in class NBTCompound

applyNBT

@Deprecated
public void applyNBT(org.bukkit.inventory.ItemStack item)

Deprecated.

Apply stored NBT tags to the provided ItemStack.

Note: This will completely override current item's ItemMeta. If you still want to keep the original item's NBT tags, see mergeNBT(ItemStack) and mergeCustomNBT(ItemStack).

Parameters:

item - ItemStack that should get the new NBT data

mergeNBT

@Deprecated
public void mergeNBT(org.bukkit.inventory.ItemStack item)

Deprecated.

Merge all NBT tags to the provided ItemStack.

Parameters:

item - ItemStack that should get the new NBT data

mergeCustomNBT

@Deprecated
public void mergeCustomNBT(org.bukkit.inventory.ItemStack item)

Deprecated.

Merge only custom (non-vanilla) NBT tags to the provided ItemStack.

Parameters:

item - ItemStack that should get the new NBT data

hasCustomNbtData

@Deprecated
public boolean hasCustomNbtData()

Deprecated.

True, if the item has any tags now known for this item type.

Specified by:

hasCustomNbtData in interface ReadWriteItemNBT

Returns:

true when custom tags are present

clearCustomNBT

@Deprecated
public void clearCustomNBT()

Deprecated.

Remove all custom (non-vanilla) NBT tags from the NBTItem.

Specified by:

clearCustomNBT in interface ReadWriteItemNBT

getItem

public org.bukkit.inventory.ItemStack getItem()

Returns:

The modified ItemStack

setItem

protected void setItem(org.bukkit.inventory.ItemStack item)

hasNBTData

public boolean hasNBTData()

Returns true if the item has NBT data. This needs to be checked before calling methods like remove, otherwise the value might be wrong!

Specified by:

hasNBTData in interface ReadableItemNBT

Returns:

Does the ItemStack have a NBTCompound.

modifyMeta

public void modifyMeta(BiConsumer<ReadableNBT,org.bukkit.inventory.meta.ItemMeta> handler)

Gives save access to the ItemMeta of the internal ItemStack. Supported operations while inside this scope: - any get/set method of ItemMeta - any getter on NBTItem All changes made to the NBTItem during this scope will be reverted at the end.

Specified by:

modifyMeta in interface ReadWriteItemNBT

Parameters:

handler -

modifyMeta

public <T extends org.bukkit.inventory.meta.ItemMeta> void modifyMeta(Class<T> type,
                                                                      BiConsumer<ReadableNBT,T> handler)

Gives save access to the ItemMeta of the internal ItemStack. Supported operations while inside this scope: - any get/set method of ItemMeta - any getter on NBTItem All changes made to the NBTItem during this scope will be reverted at the end.

Specified by:

modifyMeta in interface ReadWriteItemNBT

Parameters:

handler -

convertItemtoNBT

@Deprecated
public static NBTContainer convertItemtoNBT(org.bukkit.inventory.ItemStack item)

Deprecated.

Helper method that converts ItemStack to NBTContainer with all it's data like Material, Damage, Amount and Tags.

Parameters:

item -

Returns:

Standalone NBTContainer with the Item's data

convertNBTtoItem

@Nullable
 @Deprecated
public static org.bukkit.inventory.ItemStack convertNBTtoItem(NBTCompound comp)

Deprecated.

Helper method to do the inverse of "convertItemtoNBT". Creates an ItemStack using the NBTCompound

Parameters:

comp -

Returns:

ItemStack using the NBTCompound's data

convertItemArraytoNBT

@Deprecated
public static NBTContainer convertItemArraytoNBT(org.bukkit.inventory.ItemStack[] items)

Deprecated.

Helper method that converts ItemStack[] to NBTContainer with all its data like Material, Damage, Amount and Tags. This is a custom implementation and won't work with vanilla code(Shulker content etc).

Parameters:

items -

Returns:

Standalone NBTContainer with the Item's data

convertNBTtoItemArray

@Nullable
 @Deprecated
public static org.bukkit.inventory.ItemStack[] convertNBTtoItemArray(NBTCompound comp)

Deprecated.

Helper method to do the inverse of "convertItemArraytoNBT". Creates an ItemStack[] using the NBTCompound. This is a custom implementation and won't work with vanilla code (Shulker content, etc.). Will return null for invalid data. Empty slots in the array are filled with AIR Stacks!

Parameters:

comp -

Returns:

ItemStack[] using the NBTCompound's data

saveCompound

protected void saveCompound()

Overrides:

saveCompound in class NBTCompound