de.tr7zw.changeme.nbtapi.iface

Interface ReadWriteNBT

All Superinterfaces:

ReadableNBT

All Known Subinterfaces:

NBTFileHandle, ReadWriteItemNBT

All Known Implementing Classes:

NBTCompound, NBTContainer, NBTEntity, NBTFile, NBTItem, NBTListCompound, NBTPersistentDataContainer, NBTTileEntity

public interface ReadWriteNBT
extends ReadableNBT

Method Summary

Modifier and Type	Method and Description
void	clearNBT() Remove all keys from this compound
ReadWriteNBT	getCompound(String name)
ReadWriteNBTCompoundList	getCompoundList(String name)
ReadWriteNBTList<Double>	getDoubleList(String name)
ReadWriteNBTList<Float>	getFloatList(String name)
ReadWriteNBTList<int[]>	getIntArrayList(String name)
ReadWriteNBTList<Integer>	getIntegerList(String name)
ReadWriteNBTList<Long>	getLongList(String name)
ReadWriteNBT	getOrCreateCompound(String name) The same as addCompound, just with a name that better reflects what it does
ReadWriteNBTList<String>	getStringList(String name)
ReadWriteNBTList<UUID>	getUUIDList(String name)
void	mergeCompound(ReadableNBT comp) Merges all data from comp into this compound.
void	removeKey(String key)
ReadWriteNBT	resolveCompound(String key) Returns the resolved Compound if exists, or null.
ReadWriteNBT	resolveOrCreateCompound(String key) Returns the resolved and creates compounds as required.
<T> void	set(String key, T value, NBTHandler<T> handler) Set an Object to a key via the provided handler.
void	setBoolean(String key, Boolean value) Setter
void	setByte(String key, Byte value) Setter
void	setByteArray(String key, byte[] value) Setter
void	setDouble(String key, Double value) Setter
<E extends Enum<?>> void	setEnum(String key, E value) Set a key to the given Enum value.
void	setFloat(String key, Float value) Setter
void	setIntArray(String key, int[] value) Setter
void	setInteger(String key, Integer value) Setter
void	setItemStack(String key, org.bukkit.inventory.ItemStack item) Save an ItemStack as a compound under a given key
void	setItemStackArray(String key, org.bukkit.inventory.ItemStack[] items) Save an ItemStack Array as a compound under a given key
void	setLong(String key, Long value) Setter
void	setLongArray(String key, long[] value) Setter Requires 1.16+
void	setShort(String key, Short value) Setter
void	setString(String key, String value) Setter
void	setUUID(String key, UUID value) Setter

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

Method Detail

mergeCompound

void mergeCompound(ReadableNBT comp)

Merges all data from comp into this compound. This is done in one action, so it also works with Tiles/Entities

Parameters:

comp -

setString

void setString(String key,
               String value)

Setter

Parameters:

key -

value -

setInteger

void setInteger(String key,
                Integer value)

Setter

Parameters:

key -

value -

setDouble

void setDouble(String key,
               Double value)

Setter

Parameters:

key -

value -

setByte

void setByte(String key,
             Byte value)

Setter

Parameters:

key -

value -

setShort

void setShort(String key,
              Short value)

Setter

Parameters:

key -

value -

setLong

void setLong(String key,
             Long value)

Setter

Parameters:

key -

value -

setFloat

void setFloat(String key,
              Float value)

Setter

Parameters:

key -

value -

setByteArray

void setByteArray(String key,
                  byte[] value)

Setter

Parameters:

key -

value -

setIntArray

void setIntArray(String key,
                 int[] value)

Setter

Parameters:

key -

value -

setLongArray

void setLongArray(String key,
                  long[] value)

Setter Requires 1.16+

Parameters:

key -

value -

setBoolean

void setBoolean(String key,
                Boolean value)

Setter

Parameters:

key -

value -

setItemStack

void setItemStack(String key,
                  org.bukkit.inventory.ItemStack item)

Save an ItemStack as a compound under a given key

Parameters:

key -

item -

setItemStackArray

void setItemStackArray(String key,
                       org.bukkit.inventory.ItemStack[] items)

Save an ItemStack Array as a compound under a given key

Parameters:

key -

items -

setUUID

void setUUID(String key,
             UUID value)

Setter

Parameters:

key -

value -

removeKey

void removeKey(String key)

Parameters:

key - Deletes the given Key

getOrCreateCompound

ReadWriteNBT getOrCreateCompound(String name)

The same as addCompound, just with a name that better reflects what it does

Parameters:

name -

Returns:

getCompound

@Nullable
ReadWriteNBT getCompound(String name)

Specified by:

getCompound in interface ReadableNBT

Parameters:

name -

Returns:

The Compound instance or null

resolveOrCreateCompound

ReadWriteNBT resolveOrCreateCompound(String key)

Returns the resolved and creates compounds as required.

Parameters:

key - Path key, seperated by '.'. For example: "foo.bar.baz". Dots can be escaped with a backslash.

Returns:

The resolved compound.

set

<T> void set(String key,
             T value,
             NBTHandler<T> handler)

Set an Object to a key via the provided handler.

Type Parameters:

T -

Parameters:

key -

value -

handler -

setEnum

<E extends Enum<?>> void setEnum(String key,
                                 E value)

Set a key to the given Enum value. It gets stored as a String. Passing null as value will call removeKey(key) instead.

Type Parameters:

E -

Parameters:

key -

value -

getStringList

ReadWriteNBTList<String> getStringList(String name)

Specified by:

getStringList in interface ReadableNBT

Returns:

The retrieved String List

getIntegerList

ReadWriteNBTList<Integer> getIntegerList(String name)

Specified by:

getIntegerList in interface ReadableNBT

Returns:

The retrieved Integer List

getIntArrayList

ReadWriteNBTList<int[]> getIntArrayList(String name)

Specified by:

getIntArrayList in interface ReadableNBT

Returns:

The retrieved Integer List

getUUIDList

ReadWriteNBTList<UUID> getUUIDList(String name)

Specified by:

getUUIDList in interface ReadableNBT

Returns:

The retrieved Integer List

getFloatList

ReadWriteNBTList<Float> getFloatList(String name)

Specified by:

getFloatList in interface ReadableNBT

Returns:

The retrieved Float List

getDoubleList

ReadWriteNBTList<Double> getDoubleList(String name)

Specified by:

getDoubleList in interface ReadableNBT

Returns:

The retrieved Double List

getLongList

ReadWriteNBTList<Long> getLongList(String name)

Specified by:

getLongList in interface ReadableNBT

Returns:

The retrieved Long List

getCompoundList

ReadWriteNBTCompoundList getCompoundList(String name)

Specified by:

getCompoundList in interface ReadableNBT

Returns:

The retrieved Compound List

resolveCompound

@Nullable
ReadWriteNBT resolveCompound(String key)

Description copied from interface: ReadableNBT

Returns the resolved Compound if exists, or null.

Specified by:

resolveCompound in interface ReadableNBT

Parameters:

key - Path key, seperated by '.'. For example: "foo.bar.baz". Dots can be escaped with a backslash.

Returns:

The resolved value if exists, or null.

clearNBT

void clearNBT()

Remove all keys from this compound