net.lenni0451.mcstructs.nbt.tags

Class CompoundTag

java.lang.Object

net.lenni0451.mcstructs.nbt.tags.CompoundTag

All Implemented Interfaces:

java.lang.Iterable<java.util.Map.Entry<java.lang.String,NbtTag>>, net.lenni0451.mcstructs.core.Copyable<NbtTag>, NbtTag

public class CompoundTag
extends java.lang.Object
implements NbtTag, java.lang.Iterable<java.util.Map.Entry<java.lang.String,NbtTag>>

Constructor Summary

Constructors

Constructor	Description
CompoundTag()	Create an empty compound tag.
CompoundTag(java.util.Map<java.lang.String,NbtTag> value)	Create a compound tag from a map.

Method Summary

Modifier and Type	Method	Description
CompoundTag	add(java.lang.String key, NbtTag tag)	Add a tag to the map.
CompoundTag	add(java.lang.String key, java.lang.Object o)	Add a tag from its raw value to the map.
CompoundTag	addAll(CompoundTag tag)	Add all tags from the given compound tag to the map.
CompoundTag	addBoolean(java.lang.String key, boolean b)	Add a boolean to the map.
CompoundTag	addByte(java.lang.String key, byte b)	Add a byte to the map.
CompoundTag	addByteArray(java.lang.String key, byte... bytes)	Add a byte array to the map.
CompoundTag	addCompound(java.lang.String key, CompoundTag compound)	Add a compound to the map.
CompoundTag	addDouble(java.lang.String key, double d)	Add a double to the map.
CompoundTag	addFloat(java.lang.String key, float f)	Add a float to the map.
CompoundTag	addInt(java.lang.String key, int i)	Add an int to the map.
CompoundTag	addIntArray(java.lang.String key, int... ints)	Add an int array to the map.
CompoundTag	addList(java.lang.String key, ListTag<?> list)	Add a list to the map.
CompoundTag	addList(java.lang.String key, java.lang.Object... items)	Add a list to the map.
<T extends NbtTag> void	addList(java.lang.String key, T... items)	Add a list to the map.
CompoundTag	addLong(java.lang.String key, long l)	Add a long to the map.
CompoundTag	addLongArray(java.lang.String key, long... longs)	Add a long array to the map.
CompoundTag	addShort(java.lang.String key, short s)	Add a short to the map.
CompoundTag	addString(java.lang.String key, java.lang.String s)	Add a string to the map.
boolean	contains(java.lang.String key)	Get if the map contains a tag with the given name.
boolean	contains(java.lang.String key, NbtType type)	Get if the map contains a tag with the given name and type.
boolean	containsExact(java.lang.String key, NbtType type)	Get if the map contains a tag with the given name and exact type.
CompoundTag	copy()
boolean	equals(java.lang.Object o)
<T extends NbtTag> T	get(java.lang.String key)	Get a tag from the map.
<T extends NbtTag> T	get(java.lang.String key, T def)	Get a tag from the map or the default value.
boolean	getBoolean(java.lang.String key)	Get a boolean from the map.
boolean	getBoolean(java.lang.String key, boolean def)	Get a boolean from the map or the default value.
byte	getByte(java.lang.String key)	Get a byte from the map.
byte	getByte(java.lang.String key, byte def)	Get a byte from the map or the default value.
byte[]	getByteArray(java.lang.String key)	Get a byte array from the map.
byte[]	getByteArray(java.lang.String key, byte[] def)	Get a byte array from the map or the default value.
CompoundTag	getCompound(java.lang.String key)	Get a compound from the map.
CompoundTag	getCompound(java.lang.String key, CompoundTag def)	Get a compound from the map or the default value.
double	getDouble(java.lang.String key)	Get a double from the map.
double	getDouble(java.lang.String key, double def)	Get a double from the map or the default value.
float	getFloat(java.lang.String key)	Get a float from the map.
float	getFloat(java.lang.String key, float def)	Get a float from the map or the default value.
int	getInt(java.lang.String key)	Get an int from the map.
int	getInt(java.lang.String key, int def)	Get an int from the map or the default value.
int[]	getIntArray(java.lang.String key)	Get an int array from the map.
int[]	getIntArray(java.lang.String key, int[] def)	Get an int array from the map or the default value.
<T extends NbtTag> ListTag<T>	getList(java.lang.String key)	Get a list from the map.
<T extends NbtTag> ListTag<T>	getList(java.lang.String key, ListTag<T> def)	Get a list from the map or the default value.
<T extends NbtTag> ListTag<T>	getList(java.lang.String key, NbtType type)	Get a list from the map with the given type.
<T extends NbtTag> ListTag<T>	getList(java.lang.String key, NbtType type, ListTag<T> def)	Get a list from the map with the given type or the default value.
long	getLong(java.lang.String key)	Get a long from the map.
long	getLong(java.lang.String key, long def)	Get a long from the map or the default value.
long[]	getLongArray(java.lang.String key)	Get a long array from the map.
long[]	getLongArray(java.lang.String key, long[] def)	Get a long array from the map or the default value.
NbtType	getNbtType()
short	getShort(java.lang.String key)	Get a short from the map.
short	getShort(java.lang.String key, short def)	Get a short from the map or the default value.
java.lang.String	getString(java.lang.String key)	Get a string from the map.
java.lang.String	getString(java.lang.String key, java.lang.String def)	Get a string from the map or the default value.
java.util.Map<java.lang.String,NbtTag>	getValue()
int	hashCode()
boolean	isEmpty()
java.util.Iterator<java.util.Map.Entry<java.lang.String,NbtTag>>	iterator()
NbtTag	remove(java.lang.String key)	Remove a tag from the map.
CompoundTag	setValue(java.util.Map<java.lang.String,NbtTag> value)	Set the map value.
int	size()
java.lang.String	toString()
boolean	trim()	Trim the map by removing empty tags.

Methods inherited from class java.lang.Object

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

Methods inherited from interface net.lenni0451.mcstructs.nbt.NbtTag

asArrayTag, asByteArrayTag, asByteTag, asCompoundTag, asDoubleTag, asFloatTag, asIntArrayTag, asIntTag, asListTag, asLongArrayTag, asLongTag, asNumberTag, asShortTag, asStringTag, isArrayTag, isByteArrayTag, isByteTag, isCompoundTag, isDoubleTag, isFloatTag, isIntArrayTag, isIntTag, isListTag, isLongArrayTag, isLongTag, isNumberTag, isShortTag, isStringTag

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CompoundTag

public CompoundTag()

Create an empty compound tag.

CompoundTag

public CompoundTag(java.util.Map<java.lang.String,NbtTag> value)

Create a compound tag from a map.

Parameters:

value - The map

Method Detail

getValue

public java.util.Map<java.lang.String,NbtTag> getValue()

Returns:

The map value

setValue

public CompoundTag setValue(java.util.Map<java.lang.String,NbtTag> value)

Set the map value.

Parameters:

value - The new value

Returns:

This tag

size

public int size()

Returns:

The size of the map

isEmpty

public boolean isEmpty()

Returns:

If the map is empty

contains

public boolean contains(java.lang.String key)

Get if the map contains a tag with the given name.

Parameters:

key - The key

Returns:

If the map contains the given key

contains

public boolean contains(java.lang.String key,
                        NbtType type)

Get if the map contains a tag with the given name and type.
If the type is a NbtNumber any number type will be accepted.

Parameters:

key - The key

type - The type

Returns:

If the map contains the given key and type

containsExact

public boolean containsExact(java.lang.String key,
                             NbtType type)

Get if the map contains a tag with the given name and exact type.

Parameters:

key - The key

type - The type

Returns:

If the map contains the given key and type

get

@Nullable
public <T extends NbtTag> T get(java.lang.String key)

Get a tag from the map.

Type Parameters:

T - The tag type

Parameters:

key - The key

Returns:

The tag or null if the map does not contain the given key

get

public <T extends NbtTag> T get(java.lang.String key,
                                T def)

Get a tag from the map or the default value.

Type Parameters:

T - The tag type

Parameters:

key - The key

def - The default value

Returns:

The tag or the default value if the map does not contain the given key

add

public CompoundTag add(java.lang.String key,
                       NbtTag tag)

Add a tag to the map.

Parameters:

key - The key

tag - The tag

Returns:

This tag

add

public CompoundTag add(java.lang.String key,
                       java.lang.Object o)

Add a tag from its raw value to the map.

Parameters:

key - The key

o - The raw value

Returns:

This tag

Throws:

UnknownTagTypeException - If the raw value can not be converted to a tag

addAll

public CompoundTag addAll(CompoundTag tag)

Add all tags from the given compound tag to the map.

Parameters:

tag - The compound tag

Returns:

This tag

remove

@Nullable
public NbtTag remove(java.lang.String key)

Remove a tag from the map.

Parameters:

key - The key

Returns:

The removed tag or null if the map does not contain the given key

getBoolean

public boolean getBoolean(java.lang.String key)

Get a boolean from the map.
Booleans are stored as bytes with 0 being false and everything else being true.

Parameters:

key - The key

Returns:

The boolean or false if the map does not contain the given key or the tag is not a number

getBoolean

public boolean getBoolean(java.lang.String key,
                          boolean def)

Get a boolean from the map or the default value.
Booleans are stored as bytes with 0 being false and everything else being true.

Parameters:

key - The key

def - The default value

Returns:

The boolean or the default value if the map does not contain the given key or the tag is not a number

addBoolean

public CompoundTag addBoolean(java.lang.String key,
                              boolean b)

Add a boolean to the map.
Booleans are stored as bytes with 0 being false and everything else being true.

Parameters:

key - The key

b - The boolean

Returns:

This tag

getByte

public byte getByte(java.lang.String key)

Get a byte from the map.

Parameters:

key - The key

Returns:

The byte or 0 if the map does not contain the given key or the tag is not a number

getByte

public byte getByte(java.lang.String key,
                    byte def)

Get a byte from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The byte or the default value if the map does not contain the given key or the tag is not a number

addByte

public CompoundTag addByte(java.lang.String key,
                           byte b)

Add a byte to the map.

Parameters:

key - The key

b - The byte

Returns:

This tag

getShort

public short getShort(java.lang.String key)

Get a short from the map.

Parameters:

key - The key

Returns:

The short or 0 if the map does not contain the given key or the tag is not a number

getShort

public short getShort(java.lang.String key,
                      short def)

Get a short from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The short or the default value if the map does not contain the given key or the tag is not a number

addShort

public CompoundTag addShort(java.lang.String key,
                            short s)

Add a short to the map.

Parameters:

key - The key

s - The short

Returns:

This tag

getInt

public int getInt(java.lang.String key)

Get an int from the map.

Parameters:

key - The key

Returns:

The int or 0 if the map does not contain the given key or the tag is not a number

getInt

public int getInt(java.lang.String key,
                  int def)

Get an int from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The int or the default value if the map does not contain the given key or the tag is not a number

addInt

public CompoundTag addInt(java.lang.String key,
                          int i)

Add an int to the map.

Parameters:

key - The key

i - The int

Returns:

This tag

getLong

public long getLong(java.lang.String key)

Get a long from the map.

Parameters:

key - The key

Returns:

The long or 0 if the map does not contain the given key or the tag is not a number

getLong

public long getLong(java.lang.String key,
                    long def)

Get a long from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The long or the default value if the map does not contain the given key or the tag is not a number

addLong

public CompoundTag addLong(java.lang.String key,
                           long l)

Add a long to the map.

Parameters:

key - The key

l - The long

Returns:

This tag

getFloat

public float getFloat(java.lang.String key)

Get a float from the map.

Parameters:

key - The key

Returns:

The float or 0 if the map does not contain the given key or the tag is not a number

getFloat

public float getFloat(java.lang.String key,
                      float def)

Get a float from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The float or the default value if the map does not contain the given key or the tag is not a number

addFloat

public CompoundTag addFloat(java.lang.String key,
                            float f)

Add a float to the map.

Parameters:

key - The key

f - The float

Returns:

This tag

getDouble

public double getDouble(java.lang.String key)

Get a double from the map.

Parameters:

key - The key

Returns:

The double or 0 if the map does not contain the given key or the tag is not a number

getDouble

public double getDouble(java.lang.String key,
                        double def)

Get a double from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The double or the default value if the map does not contain the given key or the tag is not a number

addDouble

public CompoundTag addDouble(java.lang.String key,
                             double d)

Add a double to the map.

Parameters:

key - The key

d - The double

Returns:

This tag

getByteArray

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

Get a byte array from the map.

Parameters:

key - The key

Returns:

The byte array or new byte[0] if the map does not contain the given key or the tag is not a byte array

getByteArray

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

Get a byte array from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The byte array or the default value if the map does not contain the given key or the tag is not a byte array

addByteArray

public CompoundTag addByteArray(java.lang.String key,
                                byte... bytes)

Add a byte array to the map.

Parameters:

key - The key

bytes - The byte array

Returns:

This tag

getString

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

Get a string from the map.

Parameters:

key - The key

Returns:

The string or "" if the map does not contain the given key or the tag is not a string

getString

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

Get a string from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The string or the default value if the map does not contain the given key or the tag is not a string

addString

public CompoundTag addString(java.lang.String key,
                             java.lang.String s)

Add a string to the map.

Parameters:

key - The key

s - The string

Returns:

This tag

getList

public <T extends NbtTag> ListTag<T> getList(java.lang.String key)

Get a list from the map.

Type Parameters:

T - The type of the list

Parameters:

key - The key

Returns:

The list or new ListTag<>() if the map does not contain the given key or the tag is not a list

getList

public <T extends NbtTag> ListTag<T> getList(java.lang.String key,
                                             ListTag<T> def)

Get a list from the map or the default value.

Type Parameters:

T - The type of the list

Parameters:

key - The key

def - The default value

Returns:

The list or the default value if the map does not contain the given key or the tag is not a list

getList

public <T extends NbtTag> ListTag<T> getList(java.lang.String key,
                                             NbtType type)

Get a list from the map with the given type.
If the list does not contain the given type, an empty list is returned.

Type Parameters:

T - The type of the list

Parameters:

key - The key

type - The type

Returns:

The list or new ListTag<>() if the map does not contain the given key or the tag is not a list

getList

public <T extends NbtTag> ListTag<T> getList(java.lang.String key,
                                             NbtType type,
                                             ListTag<T> def)

Get a list from the map with the given type or the default value.
If the list does not contain the given type, the default value is returned.

Type Parameters:

T - The type of the list

Parameters:

key - The key

type - The type

def - The default value

Returns:

The list or the default value if the map does not contain the given key or the tag is not a list

addList

public CompoundTag addList(java.lang.String key,
                           ListTag<?> list)

Add a list to the map.

Parameters:

key - The key

list - The list

Returns:

This tag

addList

public <T extends NbtTag> void addList(java.lang.String key,
                                       T... items)

Add a list to the map.

Type Parameters:

T - The type of the items

Parameters:

key - The key

items - The items

Throws:

java.lang.IllegalArgumentException - If the type of the items is mixed

addList

public CompoundTag addList(java.lang.String key,
                           java.lang.Object... items)

Add a list to the map.

Parameters:

key - The key

items - The raw items

Returns:

This tag

Throws:

UnknownTagTypeException - If the type of the items is unknown

java.lang.IllegalArgumentException - If the type of the items is mixed

getCompound

public CompoundTag getCompound(java.lang.String key)

Get a compound from the map.

Parameters:

key - The key

Returns:

The compound or new CompoundTag() if the map does not contain the given key or the tag is not a compound

getCompound

public CompoundTag getCompound(java.lang.String key,
                               CompoundTag def)

Get a compound from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The compound or the default value if the map does not contain the given key or the tag is not a compound

addCompound

public CompoundTag addCompound(java.lang.String key,
                               CompoundTag compound)

Add a compound to the map.

Parameters:

key - The key

compound - The compound

Returns:

This tag

getIntArray

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

Get an int array from the map.

Parameters:

key - The key

Returns:

The int array or new int[0] if the map does not contain the given key or the tag is not an int array

getIntArray

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

Get an int array from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The int array or the default value if the map does not contain the given key or the tag is not an int array

addIntArray

public CompoundTag addIntArray(java.lang.String key,
                               int... ints)

Add an int array to the map.

Parameters:

key - The key

ints - The int array

Returns:

This tag

getLongArray

public long[] getLongArray(java.lang.String key)

Get a long array from the map.

Parameters:

key - The key

Returns:

The long array or new long[0] if the map does not contain the given key or the tag is not a long array

getLongArray

public long[] getLongArray(java.lang.String key,
                           long[] def)

Get a long array from the map or the default value.

Parameters:

key - The key

def - The default value

Returns:

The long array or the default value if the map does not contain the given key or the tag is not a long array

addLongArray

public CompoundTag addLongArray(java.lang.String key,
                                long... longs)

Add a long array to the map.

Parameters:

key - The key

longs - The long array

Returns:

This tag

trim

public boolean trim()

Trim the map by removing empty tags.

Returns:

If the trimmed map is empty

getNbtType

public NbtType getNbtType()

Specified by:

getNbtType in interface NbtTag

Returns:

The type of this tag

copy

public CompoundTag copy()

Specified by:

copy in interface net.lenni0451.mcstructs.core.Copyable<NbtTag>

Specified by:

copy in interface NbtTag

iterator

public java.util.Iterator<java.util.Map.Entry<java.lang.String,NbtTag>> iterator()

Specified by:

iterator in interface java.lang.Iterable<java.util.Map.Entry<java.lang.String,NbtTag>>

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface NbtTag

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface NbtTag

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface NbtTag

Overrides:

toString in class java.lang.Object