NBTTag (xyz.nickr:nbt 1.1.0 API)

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

Direct Known Subclasses:

ByteArrayTag, CompoundTag, EndTag, IntArrayTag, ListTag, NumberTag, StringTag
```
public abstract class NBTTag
extends Object
```
The building blocks of NBT, an NBTTag is a container for data.

Author:

Nick Robson

Nested Class Summary

Nested Classes
Modifier and Type Class and Description

static interface NBTTag.NBTTagType

Nested Classes
Modifier and Type	Class and Description
`static interface`	`NBTTag.NBTTagType`

Constructor Summary

Constructors
Constructor and Description

NBTTag()

Constructors
Constructor and Description
`NBTTag()`

Method Summary

All Methods Static Methods Instance Methods Abstract Methods Concrete Methods
Modifier and Type	Method and Description
`protected abstract void`	`_print(PrintStream stream, String indent)`
`protected abstract void`	`_read(io.netty.buffer.ByteBuf buf, ByteOrder order)`
`protected abstract void`	`_write(io.netty.buffer.ByteBuf buf, ByteOrder order)`
`byte[]`	`getAsByteArray()` Attempts to get this tag as a byte array.
`ByteArrayTag`	`getAsByteArrayTag()` Attempts to get this tag as a ByteArrayTag.
`CompoundTag`	`getAsCompoundTag()` Attempts to get this tag as a compound tag.
`int[]`	`getAsIntArray()` Attempts to get this tag as an int array.
`IntArrayTag`	`getAsIntArrayTag()` Attempts to get this tag as a IntArrayTag.
`ListTag`	`getAsListTag()` Attempts to get this tag as a list tag.
`Number`	`getAsNumber()` Attempts to get this tag as a Number.
`NumberTag`	`getAsNumberTag()` Attempts to get this tag as a NumberTag.
`String`	`getAsString()` Attempts to get this tag as a string.
`StringTag`	`getAsStringTag()` Attempts to get this tag as a StringTag.
`Optional<String>`	`getName()` Gets this tag's name.
`byte`	`getTypeId()` Gets this tag's type ID.
`protected String`	`indent(String indent)`
`boolean`	`isByteArray()` Checks whether or not this tag represents a byte array.
`boolean`	`isCompoundTag()` Checks whether or not this tag represents a compound tag.
`boolean`	`isIntArray()` Checks whether or not this tag represents an int array.
`boolean`	`isListTag()` Checks whether or not this tag represents a list tag.
`boolean`	`isNumber()` Checks whether or not this tag represents a number.
`boolean`	`isString()` Checks whether or not this tag represents a String.
`protected String`	`name()`
`void`	`print(PrintStream stream)` Prints this tag to the given print stream.
`<T extends NBTTag> T`	`read(io.netty.buffer.ByteBuf buf, ByteOrder order)` Reads data into this tag from the given buffer with the given byte order.
`static String`	`readString(io.netty.buffer.ByteBuf buf, ByteOrder order)` Reads a string.
`protected void`	`setHasName(boolean hasName)`
`<T extends NBTTag> T`	`setName(String name)` Sets this tag's name.
`protected void`	`setWriteType(boolean writeType)`
`String`	`toString()`
`<T extends NBTTag> T`	`write(io.netty.buffer.ByteBuf buf, ByteOrder order)` Writes data from this tag into the given buffer with the given byte order.
`static void`	`writeString(io.netty.buffer.ByteBuf buf, ByteOrder order, String string)` Writes a string.

Methods inherited from class java.lang.Object
clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

- Constructor Detail
  - NBTTag
```
public NBTTag()
```
- Method Detail
  - getTypeId
```
public final byte getTypeId()
```
    Gets this tag's type ID.
    
    Returns:
    
    The type ID.
  - getName
```
public final Optional<String> getName()
```
    Gets this tag's name.
    
    Returns:
    
    The name.
  - setName
```
public final <T extends NBTTag> T setName(String name)
```
    Sets this tag's name.
    
    Type Parameters:
    
    T - The type of NBT tag.
    
    Parameters:
    
    name - The name.
    
    Returns:
    
    This tag.
  - read
```
public final <T extends NBTTag> T read(io.netty.buffer.ByteBuf buf,
                                       ByteOrder order)
```
    Reads data into this tag from the given buffer with the given byte order.
    
    Type Parameters:
    
    T - The type of NBT tag.
    
    Parameters:
    
    buf - The buffer to read from.
    
    Returns:
    
    This tag.
  - write
```
public final <T extends NBTTag> T write(io.netty.buffer.ByteBuf buf,
                                        ByteOrder order)
```
    Writes data from this tag into the given buffer with the given byte order.
    
    Type Parameters:
    
    T - The type of NBT tag.
    
    Parameters:
    
    buf - The buffer to write to.
    
    Returns:
    
    This tag.
  - print
```
public final void print(PrintStream stream)
```
    Prints this tag to the given print stream.
    
    Parameters:
    
    stream - The stream to print to.
  - isNumber
```
public boolean isNumber()
```
    Checks whether or not this tag represents a number.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsNumber
```
public Number getAsNumber()
```
    Attempts to get this tag as a Number. A ClassCastException is thrown if it is not one.
    
    Returns:
    
    This tag as a Number.
  - getAsNumberTag
```
public NumberTag getAsNumberTag()
```
    Attempts to get this tag as a NumberTag. A ClassCastException is thrown if it is not one.
    
    Returns:
    
    This tag as a NumberTag.
  - isString
```
public boolean isString()
```
    Checks whether or not this tag represents a String.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsString
```
public String getAsString()
```
    Attempts to get this tag as a string. A ClassCastException is thrown if it is not one.
    
    Returns:
    
    This tag as a string.
  - getAsStringTag
```
public StringTag getAsStringTag()
```
    Attempts to get this tag as a StringTag. A ClassCastException is thrown if it is not one.
    
    Returns:
    
    This tag as a StringTag.
  - isByteArray
```
public boolean isByteArray()
```
    Checks whether or not this tag represents a byte array.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsByteArray
```
public byte[] getAsByteArray()
```
    Attempts to get this tag as a byte array. A ClassCastException is thrown if it is not one.
    
    Returns:
    
    This tag as a byte array.
  - getAsByteArrayTag
```
public ByteArrayTag getAsByteArrayTag()
```
    Attempts to get this tag as a ByteArrayTag. A ClassCastException is thrown if it is not one.
    
    Returns:
    
    This tag as a ByteArrayTag.
  - isIntArray
```
public boolean isIntArray()
```
    Checks whether or not this tag represents an int array.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsIntArray
```
public int[] getAsIntArray()
```
    Attempts to get this tag as an int array. A ClassCastException is thrown if it is not one.
    
    Returns:
    
    This tag as an int array.
  - getAsIntArrayTag
```
public IntArrayTag getAsIntArrayTag()
```
    Attempts to get this tag as a IntArrayTag. A ClassCastException is thrown if it is not one.
    
    Returns:
    
    This tag as a IntArrayTag.
  - isListTag
```
public boolean isListTag()
```
    Checks whether or not this tag represents a list tag.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsListTag
```
public ListTag getAsListTag()
```
    Attempts to get this tag as a list tag. A ClassCastException is thrown if it is not one.
    
    Returns:
    
    This tag as a list tag.
  - isCompoundTag
```
public boolean isCompoundTag()
```
    Checks whether or not this tag represents a compound tag.
    
    Returns:
    
    True if it does, false otherwise.
  - getAsCompoundTag
```
public CompoundTag getAsCompoundTag()
```
    Attempts to get this tag as a compound tag. A ClassCastException is thrown if it is not one.
    
    Returns:
    
    This tag as a compound tag.
  - _print
```
protected abstract void _print(PrintStream stream,
                               String indent)
```
  - _read
```
protected abstract void _read(io.netty.buffer.ByteBuf buf,
                              ByteOrder order)
```
  - _write
```
protected abstract void _write(io.netty.buffer.ByteBuf buf,
                               ByteOrder order)
```
  - readString
```
public static String readString(io.netty.buffer.ByteBuf buf,
                                ByteOrder order)
```
    Reads a string.
    
    Parameters:
    
    buf - The buffer to read from.
    
    Returns:
    
    The string.
  - writeString
```
public static void writeString(io.netty.buffer.ByteBuf buf,
                               ByteOrder order,
                               String string)
```
    Writes a string.
    
    Parameters:
    
    buf - The buffer to write to.
    
    string - The string.
  - setHasName
```
protected void setHasName(boolean hasName)
```
  - setWriteType
```
protected void setWriteType(boolean writeType)
```
  - name
```
protected String name()
```
  - indent
```
protected String indent(String indent)
```
  - toString
```
public String toString()
```
    Overrides:
    
    toString in class Object

Class NBTTag

Nested Class Summary

Constructor Summary

Method Summary

Methods inherited from class java.lang.Object

Constructor Detail

NBTTag

Method Detail

getTypeId

getName

setName

read

write

print

isNumber

getAsNumber

getAsNumberTag

isString

getAsString

getAsStringTag

isByteArray

getAsByteArray

getAsByteArrayTag

isIntArray

getAsIntArray

getAsIntArrayTag

isListTag

getAsListTag

isCompoundTag

getAsCompoundTag

_print

_read

_write

readString

writeString

setHasName

setWriteType

name

indent

toString