com.github.steveice10.opennbt.tag.builtin

Class ListTag

java.lang.Object

com.github.steveice10.opennbt.tag.builtin.Tag

com.github.steveice10.opennbt.tag.builtin.ListTag

All Implemented Interfaces:

Cloneable, Iterable<Tag>

public class ListTag
extends Tag
implements Iterable<Tag>

A tag containing a list of tags.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID

Constructor Summary

Constructors

Constructor and Description
ListTag() Creates an empty list tag and no defined type.
ListTag(@Nullable Class<? extends Tag> type) Creates an empty list tag and type.
ListTag(List<Tag> value) Creates a list tag and value.

Method Summary

Modifier and Type	Method and Description
boolean	add(Tag tag) Adds a tag to this list tag.
ListTag	clone()
boolean	equals(Object o)
<T extends Tag> T	get(int index) Gets the tag at the given index of this list tag.
Class<? extends Tag>	getElementType() Gets the element type of the ListTag.
int	getTagId() Returns the NBT tag id of this tag type, used in I/O.
List<Tag>	getValue() Gets the value of this tag.
int	hashCode()
Iterator<Tag>	iterator()
void	read(DataInput in) Reads this tag from an input stream.
boolean	remove(Tag tag) Removes a tag from this list tag.
void	setValue(List<Tag> value) Sets the value of this tag.
int	size() Gets the number of tags in this list tag.
void	write(DataOutput out) Writes this tag to an output stream.

Methods inherited from class com.github.steveice10.opennbt.tag.builtin.Tag

toString

Methods inherited from class java.lang.Object

getClass, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Field Detail

ID

public static final int ID

See Also:

Constant Field Values

Constructor Detail

ListTag

public ListTag()

Creates an empty list tag and no defined type.

ListTag

public ListTag(@Nullable
               @Nullable Class<? extends Tag> type)

Creates an empty list tag and type.

Parameters:

type - Tag type of the list.

ListTag

public ListTag(List<Tag> value)
        throws IllegalArgumentException

Creates a list tag and value. The list tag's type will be set to that of the first tag being added, or null if the given list is empty.

Parameters:

value - The value of the tag.

Throws:

IllegalArgumentException - If all tags in the list are not of the same type.

Method Detail

getValue

public List<Tag> getValue()

Description copied from class: Tag

Gets the value of this tag.

Specified by:

getValue in class Tag

Returns:

The value of this tag.

setValue

public void setValue(List<Tag> value)
              throws IllegalArgumentException

Sets the value of this tag. The list tag's type will be set to that of the first tag being added, or null if the given list is empty.

Parameters:

value - New value of this tag.

Throws:

IllegalArgumentException - If all tags in the list are not of the same type.

getElementType

public Class<? extends Tag> getElementType()

Gets the element type of the ListTag.

Returns:

The ListTag's element type, or null if the list does not yet have a defined type.

add

public boolean add(Tag tag)
            throws IllegalArgumentException

Adds a tag to this list tag. If the list does not yet have a type, it will be set to the type of the tag being added.

Parameters:

tag - Tag to add. Should not be null.

Returns:

If the list was changed as a result.

Throws:

IllegalArgumentException - If the tag's type differs from the list tag's type.

remove

public boolean remove(Tag tag)

Removes a tag from this list tag.

Parameters:

tag - Tag to remove.

Returns:

If the list contained the tag.

get

public <T extends Tag> T get(int index)

Gets the tag at the given index of this list tag.

Type Parameters:

T - Type of tag to get

Parameters:

index - Index of the tag.

Returns:

The tag at the given index.

size

public int size()

Gets the number of tags in this list tag.

Returns:

The size of this list tag.

iterator

public Iterator<Tag> iterator()

Specified by:

iterator in interface Iterable<Tag>

read

public void read(DataInput in)
          throws IOException

Description copied from class: Tag

Reads this tag from an input stream.

Specified by:

read in class Tag

Parameters:

in - Stream to write to.

Throws:

IOException - If an I/O error occurs.

write

public void write(DataOutput out)
           throws IOException

Description copied from class: Tag

Writes this tag to an output stream.

Specified by:

write in class Tag

Parameters:

out - Stream to write to.

Throws:

IOException - If an I/O error occurs.

clone

public final ListTag clone()

Specified by:

clone in class Tag

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

getTagId

public int getTagId()

Description copied from class: Tag

Returns the NBT tag id of this tag type, used in I/O.

Specified by:

getTagId in class Tag

Returns:

Id of the tag this class represents