io.github.mrblobman.nbt

Class NBTCompoundTag

java.lang.Object

io.github.mrblobman.nbt.NBTBaseTag<NBTCompoundTag>

io.github.mrblobman.nbt.NBTCompoundTag

public abstract class NBTCompoundTag
extends NBTBaseTag<NBTCompoundTag>

An NBTCompoundTag is a mapping of String -> NBTBaseTag. It is a special NBTBaseTag in the sense that its value (returned by NBTBaseTag.get()) is itself. This is generally the top level tag for most operations.

Method Summary

Modifier and Type	Method and Description
NBTCompoundTag	get()
abstract <T> T	get(java.lang.String key, NBTType<T> type) Retrieve a value from this map at the given key.
abstract boolean	getBoolean(java.lang.String key) Get a boolean value from this tag at the given key.
byte	getByte(java.lang.String key) Retrieve a byte value from the map.
byte[]	getByteArray(java.lang.String key) Retrieve a byte[] value from the map.
NBTCompoundTag	getCompound(java.lang.String key) Retrieve a compound value from the map.
double	getDouble(java.lang.String key) Retrieve a double value from the map.
float	getFloat(java.lang.String key) Retrieve a float value from the map.
int	getInt(java.lang.String key) Retrieve a int value from the map.
int[]	getIntArray(java.lang.String key) Retrieve a int[] value from the map.
NBTListTag	getList(java.lang.String key) Retrieve a list value from the map.
long	getLong(java.lang.String key) Retrieve a long value from the map.
short	getShort(java.lang.String key) Retrieve a short value from the map.
java.lang.String	getString(java.lang.String key) Retrieve a String value from the map.
abstract NBTBaseTag	getTag(java.lang.String key) Retrieve a tag from this map at the given key.
java.util.UUID	getUUID(java.lang.String key) Retrieve a UUID value from the map.
abstract boolean	hasKey(java.lang.String key) Check if the key is a mapping to a non-null value in this map.
abstract boolean	hasKeyOfType(java.lang.String key, NBTType type) Check if the key is a mapping to a non-null value of the given type.
boolean	hasKeyOfUUID(java.lang.String key) Check if there is a UUID stored in this mapping at the given key.
abstract java.util.Set<java.lang.String>	keys() Get a Set containing the names of all of the named tags inside this tag.
java.lang.String	prettyPrint() Print this tag with newline and tabs for an easier to read string for a human.
abstract void	put(java.lang.String key, NBTBaseTag value) Put a new mapping into this tag.
abstract void	putAll(NBTCompoundTag tag) Put all of the mappings from tag into this tag.
abstract void	putBoolean(java.lang.String key, boolean value) Put a boolean in the map at the specified key.
void	putByte(java.lang.String key, byte value) Put a byte in the map that can be retrieved with getByte(String).
void	putByteArray(java.lang.String key, byte[] value) Put a byte[] in the map that can be retrieved with getByteArray(String).
void	putCompound(java.lang.String key, NBTCompoundTag value) Put a compound tag in the map that can be retrieved with getCompound(String).
void	putDouble(java.lang.String key, double value) Put a double in the map that can be retrieved with getDouble(String).
void	putFloat(java.lang.String key, float value) Put a float in the map that can be retrieved with getFloat(String).
void	putInt(java.lang.String key, int value) Put an int in the map that can be retrieved with getInt(String).
void	putIntArray(java.lang.String key, int[] value) Put an int[] in the map that can be retrieved with getIntArray(String).
void	putList(java.lang.String key, NBTListTag value) Put a list of tags in the map that can be retrieved with getList(String).
void	putLong(java.lang.String key, long value) Put a long in the map that can be retrieved with getLong(String).
void	putShort(java.lang.String key, short value) Put a short in the map that can be retrieved with getShort(String).
void	putString(java.lang.String key, java.lang.String value) Put a String in the map that can be retrieved with getString(String).
void	putUUID(java.lang.String key, java.util.UUID value) Put a UUID in the map that can be retrieved with getUUID(String).
abstract void	remove(java.lang.String key) Remove the mapping for the given key.
void	removeUUID(java.lang.String key) Remove the mapping for a UUID key.
abstract int	size() Get the number of tags inside this tag.
NBTType<NBTCompoundTag>	type()

Methods inherited from class io.github.mrblobman.nbt.NBTBaseTag

equals, getHandle, hashCode, isCompound, isNumber, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

prettyPrint

public final java.lang.String prettyPrint()

Print this tag with newline and tabs for an easier to read string for a human.

Returns:

the pretty printed tag

put

public abstract void put(java.lang.String key,
                         NBTBaseTag value)

Put a new mapping into this tag.

Parameters:

key - the key of the mapping that can be used later to retrieve the value via one of the get methods.

value - the value to put at the specified key

putAll

public abstract void putAll(NBTCompoundTag tag)

Put all of the mappings from tag into this tag.

Parameters:

tag - the

get

public abstract <T> T get(java.lang.String key,
                          NBTType<T> type)

Retrieve a value from this map at the given key.

Type Parameters:

T - the return type of the value tag

Parameters:

key - the key that the value is located at.

type - the expected type of the value tag.

Returns:

the value represented by the tag at the key. null if the mapping does not exist or is of a different type then specified.

getTag

public abstract NBTBaseTag getTag(java.lang.String key)

Retrieve a tag from this map at the given key.

Parameters:

key - the key that the desired value is located at.

Returns:

the tag at the given key or null if there is no mapping for the given key.

remove

public abstract void remove(java.lang.String key)

Remove the mapping for the given key. Remove UUID tags with: removeUUID(String).

Parameters:

key - the key of the mapping to remove from this tag.

hasKey

public abstract boolean hasKey(java.lang.String key)

Check if the key is a mapping to a non-null value in this map.

Parameters:

key - the key who's existence is being checked

Returns:

true if the key exists in the map and getTag(String) will not return null for the checked key.

hasKeyOfType

public abstract boolean hasKeyOfType(java.lang.String key,
                                     NBTType type)

Check if the key is a mapping to a non-null value of the given type.

Parameters:

key - the key who's existence is being checked.

type - the type that the key should point to

Returns:

true if the key exists in the map and get(String, NBTType) will not return null for the checked key and type.

size

public abstract int size()

Get the number of tags inside this tag. This only counts tags that are one level deep (doesn't count the size of compound children).

Returns:

the number of mappings that exist in this map.

keys

public abstract java.util.Set<java.lang.String> keys()

Get a Set containing the names of all of the named tags inside this tag.

Returns:

a set containing all of the keys that exist in this map

putBoolean

public abstract void putBoolean(java.lang.String key,
                                boolean value)

Put a boolean in the map at the specified key. Note that there is no boolean tag type, this is represented as a byte.

Parameters:

key - the key pointing to the boolean

value - the value to store

getBoolean

public abstract boolean getBoolean(java.lang.String key)

Get a boolean value from this tag at the given key.

Parameters:

key - the key pointing to the boolean to retrieve.

Returns:

the value in the map pointed to by key. This will return false if the key doesn't exist in the map or points to a tag of an incompatible type.

type

public NBTType<NBTCompoundTag> type()

Specified by:

type in class NBTBaseTag<NBTCompoundTag>

Returns:

the type of this tag

get

public NBTCompoundTag get()

Specified by:

get in class NBTBaseTag<NBTCompoundTag>

Returns:

the value this tag has

putByte

public void putByte(java.lang.String key,
                    byte value)

Put a byte in the map that can be retrieved with getByte(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the byte value to store.

getByte

public byte getByte(java.lang.String key)

Retrieve a byte value from the map. This is equivalent to calling

     get(key, NBTType.BYTE)
 

but returning a 0 byte instead of null.

Parameters:

key - the key that the byte value was put at.

Returns:

the byte value stored at the given key or 0 if they key does not exist or points to a value of a different type

putShort

public void putShort(java.lang.String key,
                     short value)

Put a short in the map that can be retrieved with getShort(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the short value to store.

getShort

public short getShort(java.lang.String key)

Retrieve a short value from the map. This is equivalent to calling

     get(key, NBTType.SHORT)
 

but returning a 0 short instead of null.

Parameters:

key - the key that the short value was put at.

Returns:

the short value stored at the given key or 0 if they key does not exist or points to a value of a different type

putInt

public void putInt(java.lang.String key,
                   int value)

Put an int in the map that can be retrieved with getInt(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the int value to store.

getInt

public int getInt(java.lang.String key)

Retrieve a int value from the map. This is equivalent to calling

     get(key, NBTType.INT)
 

but returning a 0 int instead of null.

Parameters:

key - the key that the int value was put at.

Returns:

the int value stored at the given key or 0 if they key does not exist or points to a value of a different type

putLong

public void putLong(java.lang.String key,
                    long value)

Put a long in the map that can be retrieved with getLong(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the long value to store.

getLong

public long getLong(java.lang.String key)

Retrieve a long value from the map. This is equivalent to calling

     get(key, NBTType.LONG)
 

but returning a 0 long instead of null.

Parameters:

key - the key that the long value was put at.

Returns:

the long value stored at the given key or 0 if they key does not exist or points to a value of a different type

putFloat

public void putFloat(java.lang.String key,
                     float value)

Put a float in the map that can be retrieved with getFloat(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the float value to store.

getFloat

public float getFloat(java.lang.String key)

Retrieve a float value from the map. This is equivalent to calling

     get(key, NBTType.FLOAT)
 

but returning a 0 float instead of null.

Parameters:

key - the key that the float value was put at.

Returns:

the float value stored at the given key or 0 if they key does not exist or points to a value of a different type

putDouble

public void putDouble(java.lang.String key,
                      double value)

Put a double in the map that can be retrieved with getDouble(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the double value to store.

getDouble

public double getDouble(java.lang.String key)

Retrieve a double value from the map. This is equivalent to calling

     get(key, NBTType.DOUBLE)
 

but returning a 0 double instead of null.

Parameters:

key - the key that the double value was put at.

Returns:

the double value stored at the given key or 0 if they key does not exist or points to a value of a different type

putByteArray

public void putByteArray(java.lang.String key,
                         byte[] value)

Put a byte[] in the map that can be retrieved with getByteArray(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the byte[] value to store.

getByteArray

public byte[] getByteArray(java.lang.String key)

Retrieve a byte[] value from the map. This is equivalent to calling

     get(key, NBTType.BYTE_ARRAY)
 

but returning an empty byte array instead of null.

Parameters:

key - the key that the byte[] value was put at.

Returns:

the byte[] value stored at the given key or an empty byte[] if they key does not exist or points to a value of a different type

putString

public void putString(java.lang.String key,
                      java.lang.String value)

Put a String in the map that can be retrieved with getString(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the String value to store.

getString

public java.lang.String getString(java.lang.String key)

Retrieve a String value from the map. This is equivalent to calling

     get(key, NBTType.STRING)
 

but returning an empty String instead of null. ("")

Parameters:

key - the key that the String value was put at.

Returns:

the String value stored at the given key or an empty String if they key does not exist or points to a value of a different type

putList

public void putList(java.lang.String key,
                    NBTListTag value)

Put a list of tags in the map that can be retrieved with getList(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the list value to store.

getList

public NBTListTag getList(java.lang.String key)

Retrieve a list value from the map. This is equivalent to calling

     get(key, NBTType.LIST)
 

but returning a new list instead of null.

Parameters:

key - the key that the list value was put at.

Returns:

the list value stored at the given key or a new list if they key does not exist or points to a value of a different type

putCompound

public void putCompound(java.lang.String key,
                        NBTCompoundTag value)

Put a compound tag in the map that can be retrieved with getCompound(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the compound value to store.

getCompound

public NBTCompoundTag getCompound(java.lang.String key)

Retrieve a compound value from the map. This is equivalent to calling

     get(key, NBTType.COMPOUND)
 

but returning a new compound instead of null.

Parameters:

key - the key that the compound value was put at.

Returns:

the compound value stored at the given key or a new compound if they key does not exist or points to a value of a different type

putIntArray

public void putIntArray(java.lang.String key,
                        int[] value)

Put an int[] in the map that can be retrieved with getIntArray(String). This will overwrite any existing mappings for the given key.

Parameters:

key - the key at which to store the value

value - the int[] value to store.

getIntArray

public int[] getIntArray(java.lang.String key)

Retrieve a int[] value from the map. This is equivalent to calling

     get(key, NBTType.INT_ARRAY)
 

but returning an empty int array instead of null.

Parameters:

key - the key that the int[] value was put at.

Returns:

the int[] value stored at the given key or an empty int[] if they key does not exist or points to a value of a different type

putUUID

public void putUUID(java.lang.String key,
                    java.util.UUID value)

Put a UUID in the map that can be retrieved with getUUID(String). This will overwrite any existing mappings for the given key. This is really just putting 2 longs in the map that can be used to reconstruct the UUID.

Parameters:

key - the key at which to store the value

value - the UUID value to store.

See Also:

hasKeyOfUUID(String)

getUUID

public java.util.UUID getUUID(java.lang.String key)

Retrieve a UUID value from the map. This combines 2 getLong(String) calls to build the UUID. If parts of the serialized UUID are missing this method will still return a UUID with 0 for the least significant bits, most significant bits or both. Check the existence of a UUID with hasKeyOfUUID(String) to be safe.

Parameters:

key - the key that the UUID value was put at.

Returns:

the UUID value stored at the given key or a new list if they key does not exist or points to a value of a different type

hasKeyOfUUID

public boolean hasKeyOfUUID(java.lang.String key)

Check if there is a UUID stored in this mapping at the given key.

Parameters:

key - the key that the UUID was put into the map with.

Returns:

true if there is a UUID in this tag at the given key, false otherwise.

removeUUID

public void removeUUID(java.lang.String key)

Remove the mapping for a UUID key. UUIDs are stored as 2 longs and so removal must remove multiple tags. Regular tag removal can be accomplished with remove(String).

Parameters:

key - the key of the mapping to remove from this tag.