net.lenni0451.mcstructs.nbt.tags

Class ListTag<T extends NbtTag>

java.lang.Object

net.lenni0451.mcstructs.nbt.tags.ListTag<T>

All Implemented Interfaces:

java.lang.Iterable<T>, net.lenni0451.mcstructs.core.Copyable<NbtTag>, NbtTag

public class ListTag<T extends NbtTag>
extends java.lang.Object
implements NbtTag, java.lang.Iterable<T>

Constructor Summary

Constructors

Constructor and Description
ListTag() Create an empty list tag.
ListTag(java.util.List<T> list) Create a list tag from a List.
ListTag(NbtType type) Create a list tag with the given type.
ListTag(NbtType type, java.util.List<T> value) Create a list tag from a type and a List.

Method Summary

Modifier and Type	Method and Description
ListTag<T>	add(T tag) Add a tag to the list.
boolean	canAdd(NbtTag tag) Check if the tag can be added to the list.
boolean	canAdd(NbtType type) Check if the type can be added to the list.
ListTag	copy()
boolean	equals(java.lang.Object o)
T	get(int index) Get a tag from the list.
NbtType	getNbtType()
NbtType	getType()
java.util.List<T>	getValue()
int	hashCode()
boolean	isEmpty()
java.util.Iterator<T>	iterator()
ListTag<T>	remove(T tag) Remove a tag from the list.
ListTag<T>	set(int index, T tag) Set a tag in the list.
ListTag<T>	setValue(java.util.List<T> value) Set the list value.
int	size()
java.lang.String	toString()
boolean	trim() Trim the list 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

ListTag

public ListTag()

Create an empty list tag.

ListTag

public ListTag(NbtType type)

Create a list tag with the given type.

Parameters:

type - The type

ListTag

public ListTag(java.util.List<T> list)

Create a list tag from a List.

Parameters:

list - The list

Throws:

java.lang.IllegalArgumentException - If the list contains mixed types

ListTag

public ListTag(NbtType type,
               java.util.List<T> value)

Create a list tag from a type and a List.

Parameters:

type - The type

value - The list

Method Detail

getType

@Nullable
public NbtType getType()

Returns:

The type of the list. Can be null if the list is empty.

getValue

public java.util.List<T> getValue()

Returns:

The list value

setValue

public ListTag<T> setValue(java.util.List<T> value)

Set the list value.

Parameters:

value - The new value

Returns:

This tag

get

public T get(int index)

Get a tag from the list.

Parameters:

index - The index

Returns:

The tag

add

public ListTag<T> add(T tag)

Add a tag to the list.

Parameters:

tag - The tag

Returns:

This tag

Throws:

java.lang.IllegalArgumentException - If the tag is not of the same type as the list

set

public ListTag<T> set(int index,
                      T tag)

Set a tag in the list.

Parameters:

index - The index

tag - The tag

Returns:

This tag

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of bounds

java.lang.IllegalArgumentException - If the tag is not of the same type as the list

remove

public ListTag<T> remove(T tag)

Remove a tag from the list.

Parameters:

tag - The tag

Returns:

This tag

Throws:

java.lang.IllegalArgumentException - If the tag is not of the same type as the list

canAdd

public boolean canAdd(NbtTag tag)

Check if the tag can be added to the list.

Parameters:

tag - The tag

Returns:

True if the tag can be added

canAdd

public boolean canAdd(NbtType type)

Check if the type can be added to the list.

Parameters:

type - The type

Returns:

True if the type can be added

trim

public boolean trim()

Trim the list by removing empty tags.

Returns:

If the trimmed list is empty

size

public int size()

Returns:

The size of the list

isEmpty

public boolean isEmpty()

Returns:

If the list is empty

getNbtType

public NbtType getNbtType()

Specified by:

getNbtType in interface NbtTag

Returns:

The type of this tag

copy

public ListTag copy()

Specified by:

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

Specified by:

copy in interface NbtTag

iterator

public java.util.Iterator<T> iterator()

Specified by:

iterator in interface java.lang.Iterable<T extends 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