com.comphenix.protocol.wrappers.nbt

Interface NbtList<TType>

Type Parameters:

TType - - the value type of each NBT tag.

All Superinterfaces:

java.lang.Iterable<TType>, NbtBase<java.util.List<NbtBase<TType>>>

public interface NbtList<TType>
extends NbtBase<java.util.List<NbtBase<TType>>>, java.lang.Iterable<TType>

Represents a list of NBT tags of the same type without names.

Use NbtFactory to load or create an instance.

The NbtBase.getValue() method returns a List that will correctly return the content of this NBT list, but may throw an UnsupportedOperationException for any of the write operations.

Author:

Kristian

Field Summary

Fields

Modifier and Type	Field and Description
static java.lang.String	EMPTY_NAME The name of every NBT tag in a list.

Method Summary

Methods

Modifier and Type	Method and Description
void	add(byte value) Add a new byte element to the list.
void	add(byte[] value) Add a new byte array element to the list.
void	add(double value) Add a new double element to the list.
void	add(int value) Add a new integer element to the list.
void	add(int[] value) Add a new int array element to the list.
void	add(long value) Add a new long element to the list.
void	add(NbtBase<TType> element) Add a NBT list or NBT compound to the list.
void	add(short value) Add a new short element to the list.
void	add(java.lang.String value) Add a new string element to the list.
void	addClosest(java.lang.Object value) Add a value to a typed list by attempting to convert it to the nearest value.
java.util.Collection<NbtBase<TType>>	asCollection() Retrieve each NBT tag in this list.
NbtType	getElementType() Get the type of each element.
TType	getValue(int index) Retrieve an element by index.
java.util.Iterator<TType>	iterator() Iterate over all the elements in this list.
void	remove(java.lang.Object remove) Remove a given object from the list.
void	setElementType(NbtType type) Set the type of each element.
int	size() Retrieve the number of elements in this list.

Methods inherited from interface com.comphenix.protocol.wrappers.nbt.NbtBase

accept, deepClone, getName, getType, getValue, setName, setValue

Field Detail

EMPTY_NAME

static final java.lang.String EMPTY_NAME

The name of every NBT tag in a list.

See Also:

Constant Field Values

Method Detail

getElementType

NbtType getElementType()

Get the type of each element.

This will be TAG_END if the NBT list has just been created.

Returns:

Element type.

setElementType

void setElementType(NbtType type)

Set the type of each element.

Parameters:

type - - type of each element.

addClosest

void addClosest(java.lang.Object value)

Add a value to a typed list by attempting to convert it to the nearest value.

Note that the list must be typed by setting setElementType(NbtType) before calling this function.

Parameters:

value - - the value to add.

add

void add(NbtBase<TType> element)

Add a NBT list or NBT compound to the list.

Parameters:

element -

add

void add(java.lang.String value)

Add a new string element to the list.

Parameters:

value - - the string element to add.

Throws:

java.lang.IllegalArgumentException - If this is not a list of strings.

add

void add(byte value)

Add a new byte element to the list.

Parameters:

value - - the byte element to add.

Throws:

java.lang.IllegalArgumentException - If this is not a list of bytes.

add

void add(short value)

Add a new short element to the list.

Parameters:

value - - the short element to add.

Throws:

java.lang.IllegalArgumentException - If this is not a list of shorts.

add

void add(int value)

Add a new integer element to the list.

Parameters:

value - - the string element to add.

Throws:

java.lang.IllegalArgumentException - If this is not a list of integers.

add

void add(long value)

Add a new long element to the list.

Parameters:

value - - the string element to add.

Throws:

java.lang.IllegalArgumentException - If this is not a list of longs.

add

void add(double value)

Add a new double element to the list.

Parameters:

value - - the double element to add.

Throws:

java.lang.IllegalArgumentException - If this is not a list of doubles.

add

void add(byte[] value)

Add a new byte array element to the list.

Parameters:

value - - the byte array element to add.

Throws:

java.lang.IllegalArgumentException - If this is not a list of byte arrays.

add

void add(int[] value)

Add a new int array element to the list.

Parameters:

value - - the int array element to add.

Throws:

java.lang.IllegalArgumentException - If this is not a list of int arrays.

remove

void remove(java.lang.Object remove)

Remove a given object from the list.

Parameters:

remove - - the object to remove.

getValue

TType getValue(int index)

Retrieve an element by index.

Parameters:

index - - index of the element to retrieve.

Returns:

The element to retrieve.

Throws:

java.lang.IndexOutOfBoundsException - If the index is out of range (index < 0 || index >= size())

size

int size()

Retrieve the number of elements in this list.

Returns:

The number of elements in this list.

asCollection

java.util.Collection<NbtBase<TType>> asCollection()

Retrieve each NBT tag in this list.

Returns:

A view of NBT tag in this list.

iterator

java.util.Iterator<TType> iterator()

Iterate over all the elements in this list.

Specified by:

iterator in interface java.lang.Iterable<TType>