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,INbtTag>>, net.lenni0451.mcstructs.core.ICopyable<INbtTag>, INbtTag

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

Constructor Summary

Constructors

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

Method Summary

Modifier and Type	Method and Description
void	add(java.lang.String key, INbtTag tag) Add a tag to the map.
void	add(java.lang.String key, java.lang.Object o) Add a tag from its raw value to the map.
void	addByte(java.lang.String key, byte b) Add a byte to the map.
void	addByteArray(java.lang.String key, byte... bytes) Add a byte array to the map.
void	addCompound(java.lang.String key, CompoundTag compound) Add a compound to the map.
void	addDouble(java.lang.String key, double d) Add a double to the map.
void	addFloat(java.lang.String key, float f) Add a float to the map.
void	addInt(java.lang.String key, int i) Add an int to the map.
void	addIntArray(java.lang.String key, int... ints) Add an int array to the map.
void	addList(java.lang.String key, ListTag<?> list) Add a list to the map.
void	addList(java.lang.String key, java.lang.Object... items) Add a list to the map.
<T extends INbtTag> void	addList(java.lang.String key, T... items) Add a list to the map.
void	addLong(java.lang.String key, long l) Add a long to the map.
void	addLongArray(java.lang.String key, long... longs) Add a long array to the map.
void	addShort(java.lang.String key, short s) Add a short to the map.
void	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.
INbtTag	copy()
boolean	equals(java.lang.Object o)
<T extends INbtTag> T	get(java.lang.String key) Get a tag from the map.
byte	getByte(java.lang.String key) Get a byte from the map.
byte[]	getByteArray(java.lang.String key) Get a byte array from the map.
CompoundTag	getCompound(java.lang.String key) Get a compound from the map.
double	getDouble(java.lang.String key) Get a double from the map.
float	getFloat(java.lang.String key) Get a float from the map.
int	getInt(java.lang.String key) Get an int from the map.
int[]	getIntArray(java.lang.String key) Get an int array from the map.
<T extends INbtTag> ListTag<T>	getList(java.lang.String key) Get a list from the map.
<T extends INbtTag> ListTag<T>	getList(java.lang.String key, NbtType type) Get a list from the map with the given type.
long	getLong(java.lang.String key) Get a long from the map.
long[]	getLongArray(java.lang.String key) Get a long array from the map.
NbtType	getNbtType()
short	getShort(java.lang.String key) Get a short from the map.
java.lang.String	getString(java.lang.String key) Get a string from the map.
java.util.Map<java.lang.String,INbtTag>	getValue()
int	hashCode()
boolean	isEmpty()
java.util.Iterator<java.util.Map.Entry<java.lang.String,INbtTag>>	iterator()
INbtTag	remove(java.lang.String key) Remove a tag from the map.
void	setValue(java.util.Map<java.lang.String,INbtTag> 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.INbtTag

asByteArrayTag, asByteTag, asCompoundTag, asDoubleTag, asFloatTag, asIntArrayTag, asIntTag, asListTag, asLongArrayTag, asLongTag, asShortTag, asStringTag

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,INbtTag> value)

Create a compound tag from a map.

Parameters:

value - The map

Method Detail

getValue

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

Returns:

The map value

setValue

public void setValue(java.util.Map<java.lang.String,INbtTag> value)

Set the map value.

Parameters:

value - The new value

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 INbtNumber 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 INbtTag> 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

add

public void add(java.lang.String key,
                INbtTag tag)

Add a tag to the map.

Parameters:

key - The key

tag - The tag

add

public void 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

Throws:

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

remove

@Nullable
public INbtTag 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

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

addByte

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

Add a byte to the map.

Parameters:

key - The key

b - The byte

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

addShort

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

Add a short to the map.

Parameters:

key - The key

s - The short

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

addInt

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

Add an int to the map.

Parameters:

key - The key

i - The int

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

addLong

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

Add a long to the map.

Parameters:

key - The key

l - The long

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

addFloat

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

Add a float to the map.

Parameters:

key - The key

f - The float

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

addDouble

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

Add a double to the map.

Parameters:

key - The key

d - The double

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

addByteArray

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

Add a byte array to the map.

Parameters:

key - The key

bytes - The byte array

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

addString

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

Add a string to the map.

Parameters:

key - The key

s - The string

getList

public <T extends INbtTag> 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 INbtTag> 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

addList

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

Add a list to the map.

Parameters:

key - The key

list - The list

addList

public <T extends INbtTag> 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 void addList(java.lang.String key,
                    java.lang.Object... items)

Add a list to the map.

Parameters:

key - The key

items - The raw items

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

addCompound

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

Add a compound to the map.

Parameters:

key - The key

compound - The compound

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

addIntArray

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

Add an int array to the map.

Parameters:

key - The key

ints - The int array

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

addLongArray

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

Add a long array to the map.

Parameters:

key - The key

longs - The long array

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 INbtTag

Returns:

The type of this tag

copy

public INbtTag copy()

Specified by:

copy in interface net.lenni0451.mcstructs.core.ICopyable<INbtTag>

Specified by:

copy in interface INbtTag

iterator

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

Specified by:

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

equals

public boolean equals(java.lang.Object o)

Specified by:

equals in interface INbtTag

Overrides:

equals in class java.lang.Object

hashCode

public int hashCode()

Specified by:

hashCode in interface INbtTag

Overrides:

hashCode in class java.lang.Object

toString

public java.lang.String toString()

Specified by:

toString in interface INbtTag

Overrides:

toString in class java.lang.Object