io.github.mrblobman.nbt

Class NBTListTag

java.lang.Object

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

io.github.mrblobman.nbt.NBTListTag

public abstract class NBTListTag
extends NBTBaseTag<NBTListTag>

An NBTListTag is a collection of NBTBaseTags of the same type. It is a special NBTBaseTag in the sense that its value (returned by NBTBaseTag.get()) is itself. The value is determined

Method Summary

Modifier and Type	Method and Description
void	add(NBTBaseTag tag) Append an element to the end of this list.
abstract NBTBaseTag	get(int pos) Gets the tag at pos from the list.
abstract boolean	isEmpty() A shorthand for size() == 0.
abstract NBTBaseTag	remove(int pos) Removes the tag at pos from the list and returns it.
void	set(int pos, NBTBaseTag tag) Replace the element at index pos with tag.
abstract int	size() Get the number of tags in this list
NBTType<NBTListTag>	type()
int	valueType() Get the type id of the tags that go inside this list.

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

equals, get, getHandle, hashCode, isCompound, isNumber, toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Method Detail

valueType

public int valueType()

Get the type id of the tags that go inside this list.

Returns:

the type id or 0 if the list isEmpty()

type

public NBTType<NBTListTag> type()

Specified by:

type in class NBTBaseTag<NBTListTag>

Returns:

the type of this tag

size

public abstract int size()

Get the number of tags in this list

Returns:

the size of the list

add

public void add(NBTBaseTag tag)

Append an element to the end of this list.

Parameters:

tag - the tag to add to this list

Throws:

java.lang.ClassCastException - if the list contains one or more tags and the tag to add does not share the same type ID.

set

public void set(int pos,
                NBTBaseTag tag)

Replace the element at index pos with tag.

Parameters:

pos - the index in the list to set

tag - the tag to put into the list

Throws:

java.lang.IndexOutOfBoundsException - if the pos is not an index in the list.

java.lang.ClassCastException - if the list contains one or more tags and the tag to add does not share the same type ID.

remove

public abstract NBTBaseTag remove(int pos)

Removes the tag at pos from the list and returns it. All of the following elements are shifted 1 position down to fill the gap.

Parameters:

pos - the index of the tag to remove

Returns:

the removed tag

Throws:

java.lang.IndexOutOfBoundsException - if the pos is not an index in the list.

isEmpty

public abstract boolean isEmpty()

A shorthand for size() == 0. It checks if this list contains any elements.

Returns:

true if there are no elements in this list (size() == 0) and false otherwise

get

public abstract NBTBaseTag get(int pos)

Gets the tag at pos from the list.

Parameters:

pos - the index of the tag to get

Returns:

the tag at index pos

Throws:

java.lang.IndexOutOfBoundsException - if the pos is not an index in the list.