xyz.nickr.nbt.tags

Class ListTag

java.lang.Object

xyz.nickr.nbt.tags.NBTTag

xyz.nickr.nbt.tags.ListTag

All Implemented Interfaces:

Iterable<NBTTag>

public class ListTag
extends NBTTag
implements Iterable<NBTTag>

Represents a NBTTag containing a list of unnamed NBTTags of the same type.

Author:

Nick Robson

Nested Class Summary

Nested classes/interfaces inherited from class xyz.nickr.nbt.tags.NBTTag

NBTTag.NBTTagType

Constructor Summary

Constructors

Constructor and Description
ListTag(NBTTag... tags) Creates a ListTag containing the given NBTTags.

Method Summary

Modifier and Type	Method and Description
protected void	_print(PrintStream stream, String indent)
void	_read(io.netty.buffer.ByteBuf buf)
void	_write(io.netty.buffer.ByteBuf buf)
void	add(NBTTag tag) Adds a tag to this compound tag.
void	clear() Removes all tags contained in this compound tag.
NBTTag	get(int index) Gets the n-th NBTTag to be added to this tag.
byte[]	getAsByteArray(int n) Attempts to get the given tag as a byte array.
ByteArrayTag	getAsByteArrayTag(int n) Attempts to get the given tag as a ByteArrayTag.
CompoundTag	getAsCompoundTag(int n) Attempts to get the given tag as a compound tag.
int[]	getAsIntArray(int n) Attempts to get the given tag as an int array.
IntArrayTag	getAsIntArrayTag(int n) Attempts to get the given tag as a IntArrayTag.
ListTag	getAsListTag(int n) Attempts to get the given tag as a list tag.
Number	getAsNumber(int n) Attempts to get the given tag as a Number.
NumberTag	getAsNumberTag(int n) Attempts to get the given tag as a NumberTag.
String	getAsString(int n) Attempts to get the given tag as a string.
StringTag	getAsStringTag(int n) Attempts to get the given tag as a StringTag.
boolean	isByteArray(int n) Checks whether or not the given tag represents a byte array.
boolean	isCompoundTag(int n) Checks whether or not the given tag represents a compound tag.
boolean	isIntArray(int n) Checks whether or not the given tag represents an int array.
boolean	isListTag(int n) Checks whether or not the given tag represents a list tag.
boolean	isNumber(int n) Checks whether or not the given tag represents a number.
boolean	isString(int n) Checks whether or not the given tag represents a String.
Iterator<NBTTag>	iterator()
List<NBTTag>	list() Gets a list representation of the NBTTags in this list tag.
void	remove(int index) Removes the n-th tag from the compound tag.
void	set(List<NBTTag> tags) Sets the backing list of tags to be the given one.
int	size() Gets the number of tags added to this list tag.
Spliterator<NBTTag>	spliterator()

Methods inherited from class xyz.nickr.nbt.tags.NBTTag

getAsByteArray, getAsByteArrayTag, getAsCompoundTag, getAsIntArray, getAsIntArrayTag, getAsListTag, getAsNumber, getAsNumberTag, getAsString, getAsStringTag, getName, getTypeId, indent, isByteArray, isCompoundTag, isIntArray, isListTag, isNumber, isString, name, print, read, readString, setHasName, setName, setWriteType, toString, write, writeString

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach

Constructor Detail

ListTag

public ListTag(NBTTag... tags)

Creates a ListTag containing the given NBTTags.

Parameters:

tags - The tags.

Method Detail

iterator

public Iterator<NBTTag> iterator()

Specified by:

iterator in interface Iterable<NBTTag>

spliterator

public Spliterator<NBTTag> spliterator()

Specified by:

spliterator in interface Iterable<NBTTag>

list

public List<NBTTag> list()

Gets a list representation of the NBTTags in this list tag.

Returns:

A list representation of this compound tag.

get

public NBTTag get(int index)

Gets the n-th NBTTag to be added to this tag. If negative, gets the Math.abs(n)-th last.

Parameters:

index - The index, n.

Returns:

The tag.

isNumber

public boolean isNumber(int n)

Checks whether or not the given tag represents a number.

Parameters:

n - The index of the tag.

Returns:

True if it does, false otherwise.

getAsNumber

public Number getAsNumber(int n)

Attempts to get the given tag as a Number. A ClassCastException is thrown if it is not one.

Parameters:

n - The index of the tag.

Returns:

The given tag as a Number.

getAsNumberTag

public NumberTag getAsNumberTag(int n)

Attempts to get the given tag as a NumberTag. A ClassCastException is thrown if it is not one.

Parameters:

n - The index of the tag.

Returns:

The given tag as a NumberTag.

isString

public boolean isString(int n)

Checks whether or not the given tag represents a String.

Parameters:

n - The index of the tag.

Returns:

True if it does, false otherwise.

getAsString

public String getAsString(int n)

Attempts to get the given tag as a string. A ClassCastException is thrown if it is not one.

Parameters:

n - The index of the tag.

Returns:

The given tag as a string.

getAsStringTag

public StringTag getAsStringTag(int n)

Attempts to get the given tag as a StringTag. A ClassCastException is thrown if it is not one.

Parameters:

n - The index of the tag.

Returns:

The given tag as a StringTag.

isByteArray

public boolean isByteArray(int n)

Checks whether or not the given tag represents a byte array.

Parameters:

n - The index of the tag.

Returns:

True if it does, false otherwise.

getAsByteArray

public byte[] getAsByteArray(int n)

Attempts to get the given tag as a byte array. A ClassCastException is thrown if it is not one.

Parameters:

n - The index of the tag.

Returns:

The given tag as a byte array.

getAsByteArrayTag

public ByteArrayTag getAsByteArrayTag(int n)

Attempts to get the given tag as a ByteArrayTag. A ClassCastException is thrown if it is not one.

Parameters:

n - The index of the tag.

Returns:

The given tag as a ByteArrayTag.

isIntArray

public boolean isIntArray(int n)

Checks whether or not the given tag represents an int array.

Parameters:

n - The index of the tag.

Returns:

True if it does, false otherwise.

getAsIntArray

public int[] getAsIntArray(int n)

Attempts to get the given tag as an int array. A ClassCastException is thrown if it is not one.

Parameters:

n - The index of the tag.

Returns:

The given tag as an int array.

getAsIntArrayTag

public IntArrayTag getAsIntArrayTag(int n)

Attempts to get the given tag as a IntArrayTag. A ClassCastException is thrown if it is not one.

Parameters:

n - The index of the tag.

Returns:

The given tag as a IntArrayTag.

isListTag

public boolean isListTag(int n)

Checks whether or not the given tag represents a list tag.

Parameters:

n - The index of the tag.

Returns:

True if it does, false otherwise.

getAsListTag

public ListTag getAsListTag(int n)

Attempts to get the given tag as a list tag. A ClassCastException is thrown if it is not one.

Parameters:

n - The index of the tag.

Returns:

The given tag as a list tag.

isCompoundTag

public boolean isCompoundTag(int n)

Checks whether or not the given tag represents a compound tag.

Parameters:

n - The index of the tag.

Returns:

True if it does, false otherwise.

getAsCompoundTag

public CompoundTag getAsCompoundTag(int n)

Attempts to get the given tag as a compound tag. A ClassCastException is thrown if it is not one.

Parameters:

n - The index of the tag.

Returns:

The given tag as a compound tag.

size

public int size()

Gets the number of tags added to this list tag.

Returns:

The size.

add

public void add(NBTTag tag)

Adds a tag to this compound tag.

Parameters:

tag - The tag.

remove

public void remove(int index)

Removes the n-th tag from the compound tag.

Parameters:

index - The index, n.

clear

public void clear()

Removes all tags contained in this compound tag.

set

public void set(List<NBTTag> tags)

Sets the backing list of tags to be the given one.

Parameters:

tags - The tags.

_read

public void _read(io.netty.buffer.ByteBuf buf)

Specified by:

_read in class NBTTag

_write

public void _write(io.netty.buffer.ByteBuf buf)

Specified by:

_write in class NBTTag

_print

protected void _print(PrintStream stream,
                      String indent)

Specified by:

_print in class NBTTag