de.tr7zw.changeme.nbtapi

Class NBTReflectionUtil

java.lang.Object

de.tr7zw.changeme.nbtapi.NBTReflectionUtil

public class NBTReflectionUtil
extends Object

Utility class for translating NBTApi calls to reflections into NMS code All methods are allowed to throw NbtApiException

Author:

tr7zw

Method Summary

Modifier and Type	Method and Description
static void	addNBTTagCompound(NBTCompound comp, String name) Creates a subCompound with a given name in the given NMS Compound
static Object	convertNBTCompoundtoNMSItem(NBTCompound nbtcompound) Converts NBTCompound to NMS ItemStacks
static NBTContainer	convertNMSItemtoNBTCompound(Object nmsitem) Converts NMS ItemStacks to NBTContainer
static Object	getCraftItemHandle(org.bukkit.inventory.ItemStack item) Gets the nms handle ItemStack from a CraftItemStack.
static Object	getData(NBTCompound comp, ReflectionMethod type, String key) Gets data from the Compound
static Object	getEntityNBTTagCompound(Object nmsEntity) Gets the Vanilla NBT Compound from a given NMS Entity
static Object	getEntry(NBTCompound comp, String key)
static Object	getItemRootNBTTagCompound(Object nmsitem) Simulates getOrCreateTag.
static Set<String>	getKeys(NBTCompound comp) Gets the Keyset inside this Compound
static <T> NBTList<T>	getList(NBTCompound comp, String key, NBTType type, Class<T> clazz) Returns the List saved with a given key.
static NBTType	getListType(NBTCompound comp, String key)
static Object	getNMSEntity(org.bukkit.entity.Entity entity) Gets the NMS Entity for a given Bukkit Entity
static <T> T	getObject(NBTCompound comp, String key, Class<T> type) Uses Gson to load back a Serializable object from the Compound
static Object	getSubNBTTagCompound(Object compound, String name) Gets the subCompound with a given name from a NMS Compound
static Object	getTileEntityNBTTagCompound(org.bukkit.block.BlockState tile) Gets the NMS Compound from a given TileEntity
static Object	getToCompount(Object nbttag, NBTCompound comp)
static Map<String,Object>	getUnhandledNBTTags(org.bukkit.inventory.meta.ItemMeta meta) Deprecated.
static void	mergeOtherNBTCompound(NBTCompound comp, NBTCompound nbtcompoundSrc) Merges the second NBTCompound into the first one
static Object	readNBT(InputStream stream) Reads in a InputStream as NMS Compound
static void	remove(NBTCompound comp, String key) Deletes the given key
static void	set(NBTCompound comp, String key, Object val) Sets a key in a NBTCompound to a given value
static void	setData(NBTCompound comp, ReflectionMethod type, String key, Object data) Sets data inside the Compound
static Object	setEntityNBTTag(Object nbtTag, Object nmsEntity) Loads all Vanilla tags from a NMS Compound into a NMS Entity
static void	setItemStackCompound(Object nmsItem, Object compound) Set the Compound as the Items NBT or CustomData
static void	setObject(NBTCompound comp, String key, Object value) Uses Gson to set a Serializable value in a Compound
static void	setTileEntityNBTTagCompound(org.bukkit.block.BlockState tile, Object comp) Sets Vanilla tags from a NMS Compound to a TileEntity
static boolean	valideCompound(NBTCompound comp) Checks if the Compound is correctly linked to it's roots
static void	writeApiNBT(NBTCompound comp, OutputStream stream) Writes a Compound to an OutputStream
static Object	writeNBT(Object nbt, OutputStream stream) Writes a NMS Compound to an OutputStream

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Method Detail

getNMSEntity

public static Object getNMSEntity(org.bukkit.entity.Entity entity)

Gets the NMS Entity for a given Bukkit Entity

Parameters:

entity - Bukkit Entity

Returns:

NMS Entity

readNBT

public static Object readNBT(InputStream stream)

Reads in a InputStream as NMS Compound

Parameters:

stream - InputStream of any NBT file

Returns:

NMS Compound

writeNBT

public static Object writeNBT(Object nbt,
                              OutputStream stream)

Writes a NMS Compound to an OutputStream

Parameters:

nbt - NMS Compound

stream - Stream to write to

Returns:

???

getCraftItemHandle

public static Object getCraftItemHandle(org.bukkit.inventory.ItemStack item)

Gets the nms handle ItemStack from a CraftItemStack. Passing Spigot ItemStacks will cause an error!

Parameters:

item -

Returns:

writeApiNBT

public static void writeApiNBT(NBTCompound comp,
                               OutputStream stream)

Writes a Compound to an OutputStream

Parameters:

comp - Compound

stream - Stream to write to

getItemRootNBTTagCompound

public static Object getItemRootNBTTagCompound(Object nmsitem)

Simulates getOrCreateTag. If an Item doesn't yet have a Tag, it will return a new empty tag.

Parameters:

nmsitem -

Returns:

NMS Compound

setItemStackCompound

public static void setItemStackCompound(Object nmsItem,
                                        Object compound)

Set the Compound as the Items NBT or CustomData

Parameters:

nmsItem -

compound -

convertNBTCompoundtoNMSItem

public static Object convertNBTCompoundtoNMSItem(NBTCompound nbtcompound)

Converts NBTCompound to NMS ItemStacks

Parameters:

nbtcompound - Any valid NBTCompound

Returns:

NMS ItemStack

convertNMSItemtoNBTCompound

public static NBTContainer convertNMSItemtoNBTCompound(Object nmsitem)

Converts NMS ItemStacks to NBTContainer

Parameters:

nmsitem - NMS ItemStack

Returns:

NBTContainer with all the data

getUnhandledNBTTags

@Deprecated
public static Map<String,Object> getUnhandledNBTTags(org.bukkit.inventory.meta.ItemMeta meta)

Deprecated.

Gets a live copy of non-vanilla NBT tags.

Parameters:

meta - ItemMeta from which tags should be retrieved

Returns:

Map containing unhandled (custom) NBT tags

getEntityNBTTagCompound

public static Object getEntityNBTTagCompound(Object nmsEntity)

Gets the Vanilla NBT Compound from a given NMS Entity

Parameters:

nmsEntity -

Returns:

NMS NBT Compound

setEntityNBTTag

public static Object setEntityNBTTag(Object nbtTag,
                                     Object nmsEntity)

Loads all Vanilla tags from a NMS Compound into a NMS Entity

Parameters:

nbtTag -

nmsEntity -

Returns:

The NMS Entity

getTileEntityNBTTagCompound

public static Object getTileEntityNBTTagCompound(org.bukkit.block.BlockState tile)

Gets the NMS Compound from a given TileEntity

Parameters:

tile -

Returns:

NMS Compound with the Vanilla data

setTileEntityNBTTagCompound

public static void setTileEntityNBTTagCompound(org.bukkit.block.BlockState tile,
                                               Object comp)

Sets Vanilla tags from a NMS Compound to a TileEntity

Parameters:

tile -

comp -

getSubNBTTagCompound

public static Object getSubNBTTagCompound(Object compound,
                                          String name)

Gets the subCompound with a given name from a NMS Compound

Parameters:

compound -

name -

Returns:

NMS Compound or null

addNBTTagCompound

public static void addNBTTagCompound(NBTCompound comp,
                                     String name)

Creates a subCompound with a given name in the given NMS Compound

Parameters:

comp -

name -

valideCompound

public static boolean valideCompound(NBTCompound comp)

Checks if the Compound is correctly linked to it's roots

Parameters:

comp -

Returns:

true if this is a valide Compound, else false

getToCompount

public static Object getToCompount(Object nbttag,
                                   NBTCompound comp)

mergeOtherNBTCompound

public static void mergeOtherNBTCompound(NBTCompound comp,
                                         NBTCompound nbtcompoundSrc)

Merges the second NBTCompound into the first one

Parameters:

comp - Target for the merge

nbtcompoundSrc - Data to merge

set

public static void set(NBTCompound comp,
                       String key,
                       Object val)

Sets a key in a NBTCompound to a given value

Parameters:

comp -

key -

val -

getList

public static <T> NBTList<T> getList(NBTCompound comp,
                                     String key,
                                     NBTType type,
                                     Class<T> clazz)

Returns the List saved with a given key.

Parameters:

comp -

key -

type -

clazz -

Returns:

The list at that key. Null if it's an invalid type

getListType

public static NBTType getListType(NBTCompound comp,
                                  String key)

getEntry

public static Object getEntry(NBTCompound comp,
                              String key)

setObject

public static void setObject(NBTCompound comp,
                             String key,
                             Object value)

Uses Gson to set a Serializable value in a Compound

Parameters:

comp -

key -

value -

getObject

public static <T> T getObject(NBTCompound comp,
                              String key,
                              Class<T> type)

Uses Gson to load back a Serializable object from the Compound

Parameters:

comp -

key -

type -

Returns:

The loaded Object or null, if not found

remove

public static void remove(NBTCompound comp,
                          String key)

Deletes the given key

Parameters:

comp -

key -

getKeys

public static Set<String> getKeys(NBTCompound comp)

Gets the Keyset inside this Compound

Parameters:

comp -

Returns:

Set of all keys

setData

public static void setData(NBTCompound comp,
                           ReflectionMethod type,
                           String key,
                           Object data)

Sets data inside the Compound

Parameters:

comp -

type -

key -

data -

getData

public static Object getData(NBTCompound comp,
                             ReflectionMethod type,
                             String key)

Gets data from the Compound

Parameters:

comp -

type -

key -

Returns:

The value or default fallback from NMS