com.github.steveice10.opennbt.tag.builtin

Class CompoundTag

java.lang.Object

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

com.github.steveice10.opennbt.tag.builtin.CompoundTag

All Implemented Interfaces:

Cloneable, Iterable<Tag>

public class CompoundTag
extends Tag
implements Iterable<Tag>

A compound tag containing other tags.

Constructor Summary

Constructors

Constructor and Description
CompoundTag(String name) Creates a tag with the specified name.
CompoundTag(String name, Map<String,Tag> value) Creates a tag with the specified name.

Method Summary

Modifier and Type	Method and Description
void	clear() Clears all tags from this compound tag.
CompoundTag	clone()
boolean	contains(String tagName) Checks whether the compound tag contains a tag with the specified name.
void	destringify(SNBTIO.StringifiedNBTReader in) Parses this tag from stringified NBT.
<T extends Tag> T	get(String tagName) Gets the tag with the specified name.
Map<String,Tag>	getValue() Gets the value of this tag.
boolean	isEmpty() Checks whether the compound tag is empty.
Iterator<Tag>	iterator()
Set<String>	keySet() Gets a set of keys in this compound tag.
<T extends Tag> T	put(T tag) Puts the tag into this compound tag.
void	read(DataInput in) Reads this tag from an input stream.
<T extends Tag> T	remove(String tagName) Removes a tag from this compound tag.
void	setValue(Map<String,Tag> value) Sets the value of this tag.
int	size() Gets the number of tags in this compound tag.
void	stringify(SNBTIO.StringifiedNBTWriter out, boolean linebreak, int depth) Write this tag as stringified NBT.
Collection<Tag>	values() Gets a collection of tags in this compound tag.
void	write(DataOutput out) Writes this tag to an output stream.

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

equals, getName, toString

Methods inherited from class java.lang.Object

getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface java.lang.Iterable

forEach, spliterator

Constructor Detail

CompoundTag

public CompoundTag(String name)

Creates a tag with the specified name.

Parameters:

name - The name of the tag.

CompoundTag

public CompoundTag(String name,
                   Map<String,Tag> value)

Creates a tag with the specified name.

Parameters:

name - The name of the tag.

value - The value of the tag.

Method Detail

getValue

public Map<String,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(Map<String,Tag> value)

Sets the value of this tag.

Parameters:

value - New value of this tag.

isEmpty

public boolean isEmpty()

Checks whether the compound tag is empty.

Returns:

Whether the compound tag is empty.

contains

public boolean contains(String tagName)

Checks whether the compound tag contains a tag with the specified name.

Parameters:

tagName - Name of the tag to check for.

Returns:

Whether the compound tag contains a tag with the specified name.

get

public <T extends Tag> T get(String tagName)

Gets the tag with the specified name.

Type Parameters:

T - Type of tag to get.

Parameters:

tagName - Name of the tag.

Returns:

The tag with the specified name.

put

public <T extends Tag> T put(T tag)

Puts the tag into this compound tag.

Type Parameters:

T - Type of tag to put.

Parameters:

tag - Tag to put into this compound tag.

Returns:

The previous tag associated with its name, or null if there wasn't one.

remove

public <T extends Tag> T remove(String tagName)

Removes a tag from this compound tag.

Type Parameters:

T - Type of tag to remove.

Parameters:

tagName - Name of the tag to remove.

Returns:

The removed tag.

keySet

public Set<String> keySet()

Gets a set of keys in this compound tag.

Returns:

The compound tag's key set.

values

public Collection<Tag> values()

Gets a collection of tags in this compound tag.

Returns:

This compound tag's tags.

size

public int size()

Gets the number of tags in this compound tag.

Returns:

This compound tag's size.

clear

public void clear()

Clears all tags from this compound 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 read from.

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.

destringify

public void destringify(SNBTIO.StringifiedNBTReader in)
                 throws IOException

Description copied from class: Tag

Parses this tag from stringified NBT.

Specified by:

destringify in class Tag

Parameters:

in - String to parse.

Throws:

IOException

stringify

public void stringify(SNBTIO.StringifiedNBTWriter out,
                      boolean linebreak,
                      int depth)
               throws IOException

Description copied from class: Tag

Write this tag as stringified NBT.

Specified by:

stringify in class Tag

Throws:

IOException

clone

public CompoundTag clone()

Specified by:

clone in class Tag