CompoundTag (xyz.nickr:nbt 1.1.0 API)

java.lang.Object
- xyz.nickr.nbt.tags.NBTTag
- - xyz.nickr.nbt.tags.CompoundTag

All Implemented Interfaces:

Iterable<NBTTag>
```
public class CompoundTag
extends NBTTag
implements Iterable<NBTTag>
```
Represents a NBTTag containing multiple named tags short.

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

CompoundTag(NBTTag... tags)
Creates a CompoundTag containing the given NBTTags.

Constructors
Constructor and Description
`CompoundTag(NBTTag... tags)` Creates a CompoundTag containing the given `NBTTag`s.

Method Summary

All Methods Instance Methods Concrete Methods
Modifier and Type	Method and Description
`protected void`	`_print(PrintStream stream, String indent)`
`void`	`_read(io.netty.buffer.ByteBuf buf, ByteOrder order)`
`void`	`_write(io.netty.buffer.ByteBuf buf, ByteOrder order)`
`void`	`add(NBTTag tag)` Adds a tag to this compound tag.
`void`	`clear()` Removes all tags contained in this compound tag.
`Optional<NBTTag>`	`get(String name)` Gets the tag contained in this compound tag with a given name.
`byte[]`	`getAsByteArray(String name)` Attempts to get the given tag as a byte array.
`ByteArrayTag`	`getAsByteArrayTag(String name)` Attempts to get the given tag as a ByteArrayTag.
`CompoundTag`	`getAsCompoundTag(String name)` Attempts to get the given tag as a compound tag.
`int[]`	`getAsIntArray(String name)` Attempts to get the given tag as an int array.
`IntArrayTag`	`getAsIntArrayTag(String name)` Attempts to get the given tag as a IntArrayTag.
`ListTag`	`getAsListTag(String name)` Attempts to get the given tag as a list tag.
`Number`	`getAsNumber(String name)` Attempts to get the given tag as a Number.
`NumberTag`	`getAsNumberTag(String name)` Attempts to get the given tag as a NumberTag.
`String`	`getAsString(String name)` Attempts to get the given tag as a string.
`StringTag`	`getAsStringTag(String name)` Attempts to get the given tag as a StringTag.
`boolean`	`has(String name)` Gets whether or not there exists a tag in this compound tag with a given name.
`boolean`	`isByteArray(String name)` Checks whether or not the given tag represents a byte array.
`boolean`	`isCompoundTag(String name)` Checks whether or not the given tag represents a compound tag.
`boolean`	`isIntArray(String name)` Checks whether or not the given tag represents an int array.
`boolean`	`isListTag(String name)` Checks whether or not the given tag represents a list tag.
`boolean`	`isNumber(String name)` Checks whether or not the given tag represents a number.
`boolean`	`isString(String name)` Checks whether or not the given tag represents a String.
`Iterator<NBTTag>`	`iterator()`
`Map<String,NBTTag>`	`map()` Gets this compound tag as a map of Strings to `NBTTag`s.
`void`	`remove(String name)` Removes the tag with the given name from the compound tag.
`void`	`set(Map<String,NBTTag> tags)` Sets the backing list of tags to be the given one.
`int`	`size()` Gets the number of tags added to this compound tag.
`Spliterator<NBTTag>`	`spliterator()`
`Collection<NBTTag>`	`values()` Gets this compound tag as a collection of `NBTTag`s.

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
  - CompoundTag
```
public CompoundTag(NBTTag... tags)
```
    Creates a CompoundTag 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>
  - values
```
public Collection<NBTTag> values()
```
    Gets this compound tag as a collection of NBTTags.
    
    Returns:
    
    A collection representation of this compound tag.
  - map
```
public Map<String,NBTTag> map()
```
    Gets this compound tag as a map of Strings to NBTTags.
    
    Returns:
    
    A map representation of this compound tag.
  - get
```
public Optional<NBTTag> get(String name)
```
    Gets the tag contained in this compound tag with a given name.
    
    Parameters:
    
    name - The name.
    
    Returns:
    
    The tag, or null if no such tag.
  - has
```
public boolean has(String name)
```
    Gets whether or not there exists a tag in this compound tag with a given name.
    
    Parameters:
    
    name - The name.
    
    Returns:
    
    True if there exists one, false otherwise.
  - isNumber
```
public boolean isNumber(String name)
```
    Checks whether or not the given tag represents a number.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsNumber
```
public Number getAsNumber(String name)
```
    Attempts to get the given tag as a Number. A ClassCastException is thrown if it is not one.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    The given tag as a Number.
  - getAsNumberTag
```
public NumberTag getAsNumberTag(String name)
```
    Attempts to get the given tag as a NumberTag. A ClassCastException is thrown if it is not one.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    The given tag as a NumberTag.
  - isString
```
public boolean isString(String name)
```
    Checks whether or not the given tag represents a String.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsString
```
public String getAsString(String name)
```
    Attempts to get the given tag as a string. A ClassCastException is thrown if it is not one.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    The given tag as a string.
  - getAsStringTag
```
public StringTag getAsStringTag(String name)
```
    Attempts to get the given tag as a StringTag. A ClassCastException is thrown if it is not one.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    The given tag as a StringTag.
  - isByteArray
```
public boolean isByteArray(String name)
```
    Checks whether or not the given tag represents a byte array.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsByteArray
```
public byte[] getAsByteArray(String name)
```
    Attempts to get the given tag as a byte array. A ClassCastException is thrown if it is not one.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    The given tag as a byte array.
  - getAsByteArrayTag
```
public ByteArrayTag getAsByteArrayTag(String name)
```
    Attempts to get the given tag as a ByteArrayTag. A ClassCastException is thrown if it is not one.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    The given tag as a ByteArrayTag.
  - isIntArray
```
public boolean isIntArray(String name)
```
    Checks whether or not the given tag represents an int array.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsIntArray
```
public int[] getAsIntArray(String name)
```
    Attempts to get the given tag as an int array. A ClassCastException is thrown if it is not one.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    The given tag as an int array.
  - getAsIntArrayTag
```
public IntArrayTag getAsIntArrayTag(String name)
```
    Attempts to get the given tag as a IntArrayTag. A ClassCastException is thrown if it is not one.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    The given tag as a IntArrayTag.
  - isListTag
```
public boolean isListTag(String name)
```
    Checks whether or not the given tag represents a list tag.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsListTag
```
public ListTag getAsListTag(String name)
```
    Attempts to get the given tag as a list tag. A ClassCastException is thrown if it is not one.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    The given tag as a list tag.
  - isCompoundTag
```
public boolean isCompoundTag(String name)
```
    Checks whether or not the given tag represents a compound tag.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsCompoundTag
```
public CompoundTag getAsCompoundTag(String name)
```
    Attempts to get the given tag as a compound tag. A ClassCastException is thrown if it is not one.
    
    Parameters:
    
    name - The name of the tag.
    
    Returns:
    
    The given tag as a compound tag.
  - size
```
public int size()
```
    Gets the number of tags added to this compound 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(String name)
```
    Removes the tag with the given name from the compound tag.
    
    Parameters:
    
    name - The name of the tag.
  - clear
```
public void clear()
```
    Removes all tags contained in this compound tag.
  - set
```
public void set(Map<String,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,
                  ByteOrder order)
```
    Specified by:
    
    _read in class NBTTag
  - _write
```
public void _write(io.netty.buffer.ByteBuf buf,
                   ByteOrder order)
```
    Specified by:
    
    _write in class NBTTag
  - _print
```
protected void _print(PrintStream stream,
                      String indent)
```
    Specified by:
    
    _print in class NBTTag

Class CompoundTag

Nested Class Summary

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

Constructor Summary

Method Summary

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

Methods inherited from class java.lang.Object

Methods inherited from interface java.lang.Iterable

Constructor Detail

CompoundTag

Method Detail

iterator

spliterator

values

map

get

has

isNumber

getAsNumber

getAsNumberTag

isString

getAsString

getAsStringTag

isByteArray

getAsByteArray

getAsByteArrayTag

isIntArray

getAsIntArray

getAsIntArrayTag

isListTag

getAsListTag

isCompoundTag

getAsCompoundTag

size

add

remove

clear

set

_read

_write

_print