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<Map.Entry<String,Tag>>

public class CompoundTag
extends Tag
implements Iterable<Map.Entry<String,Tag>>

A compound tag containing other tags.

Field Summary

Fields

Modifier and Type	Field and Description
static int	ID

Constructor Summary

Constructors

Constructor and Description
CompoundTag() Creates a tag.
CompoundTag(LinkedHashMap<String,Tag> value) Creates a tag without wrapping the map.
CompoundTag(Map<String,Tag> value) Creates a tag.

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.
Set<Map.Entry<String,Tag>>	entrySet() Gets the entry set of this compound tag.
boolean	equals(Object o)
<T extends Tag> T	get(String tagName) Gets the tag.
int	getTagId() Returns the NBT tag id of this tag type, used in I/O.
Map<String,Tag>	getValue() Gets the value of this tag.
int	hashCode()
boolean	isEmpty() Checks whether the compound tag is empty.
Iterator<Map.Entry<String,Tag>>	iterator()
Set<String>	keySet() Gets a set of keys in this compound tag.
<T extends Tag> T	put(String tagName, 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(LinkedHashMap<String,Tag> value) Sets the value of this tag without wrapping the map.
void	setValue(Map<String,Tag> value) Sets the value of this tag.
int	size() Gets the number of tags in this compound tag.
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

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

CompoundTag

public CompoundTag()

Creates a tag.

CompoundTag

public CompoundTag(Map<String,Tag> value)

Creates a tag.

Parameters:

value - The value of the tag.

CompoundTag

public CompoundTag(LinkedHashMap<String,Tag> value)

Creates a tag without wrapping the map.

Parameters:

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.

setValue

public void setValue(LinkedHashMap<String,Tag> value)

Sets the value of this tag without wrapping the map.

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.

Parameters:

tagName - Name of the tag to check for.

Returns:

Whether the compound tag contains a tag.

get

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

Gets the tag.

Type Parameters:

T - Type of tag to get.

Parameters:

tagName - Name of the tag.

Returns:

The tag.

put

@Nullable
public <T extends Tag> T put(String tagName,
                                       T tag)

Puts the tag into this compound tag.

Type Parameters:

T - Type of tag to put.

Parameters:

tagName - Name of the tag.

tag - Tag to put into this compound tag.

Returns:

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

remove

@Nullable
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.

entrySet

public Set<Map.Entry<String,Tag>> entrySet()

Gets the entry set of this compound tag.

Returns:

The compound tag's entry set.

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<Map.Entry<String,Tag>> iterator()

Specified by:

iterator in interface Iterable<Map.Entry<String,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.

equals

public boolean equals(Object o)

Overrides:

equals in class Object

hashCode

public int hashCode()

Overrides:

hashCode in class Object

clone

public final CompoundTag clone()

Specified by:

clone in class Tag

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