io.github.mrblobman.nbt

Class NBTType<T>

java.lang.Object

io.github.mrblobman.nbt.NBTType<T>

public final class NBTType<T>
extends java.lang.Object

Field Summary

Fields

Modifier and Type	Field and Description
static NBTType<java.lang.Byte>	BYTE
static NBTType<byte[]>	BYTE_ARRAY
static NBTType<NBTCompoundTag>	COMPOUND
static NBTType<java.lang.Double>	DOUBLE
static NBTType<java.lang.Float>	FLOAT
int	ID
static NBTType<java.lang.Integer>	INT
static NBTType<int[]>	INT_ARRAY
static NBTType<NBTListTag>	LIST
static NBTType<java.lang.Long>	LONG
static NBTType<java.lang.Short>	SHORT
static NBTType<java.lang.String>	STRING

Method Summary

Modifier and Type	Method and Description
static java.lang.String	getName(int type)
static NBTType	getType(int type) Lookup a type based on it's id.
boolean	isArray()
boolean	isByteArray()
boolean	isCompound()
boolean	isIntArray()
boolean	isList()
boolean	isNumber()
boolean	isString()
NBTBaseTag<T>	newTag() Create a fresh tag of this type.
NBTBaseTag<T>	wrapHandle(java.lang.Object handle) Wrap the nms handle in a wrapper of the correct type

Methods inherited from class java.lang.Object

equals, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Field Detail

BYTE

public static final NBTType<java.lang.Byte> BYTE

SHORT

public static final NBTType<java.lang.Short> SHORT

INT

public static final NBTType<java.lang.Integer> INT

LONG

public static final NBTType<java.lang.Long> LONG

FLOAT

public static final NBTType<java.lang.Float> FLOAT

DOUBLE

public static final NBTType<java.lang.Double> DOUBLE

BYTE_ARRAY

public static final NBTType<byte[]> BYTE_ARRAY

STRING

public static final NBTType<java.lang.String> STRING

LIST

public static final NBTType<NBTListTag> LIST

COMPOUND

public static final NBTType<NBTCompoundTag> COMPOUND

INT_ARRAY

public static final NBTType<int[]> INT_ARRAY

ID

public final int ID

Method Detail

newTag

public NBTBaseTag<T> newTag()

Create a fresh tag of this type. For list and compound tags the tag can be safely cast to an NBTListTag or NBTCompoundTag or equivalently with a NBTBaseTag.get() call.
Ex:

     NBTCompoundTag tag = NBTType.COMPOUND.newTag().get();
 

Returns:

the newly created tag

wrapHandle

public NBTBaseTag<T> wrapHandle(java.lang.Object handle)
                         throws java.lang.ClassCastException

Wrap the nms handle in a wrapper of the correct type

Parameters:

handle - the handle to wrap

Returns:

the wrapper for the handle

Throws:

java.lang.ClassCastException - if the handle is not a tag of this tag type

getName

public static java.lang.String getName(int type)

getType

public static NBTType getType(int type)

Lookup a type based on it's id.

Parameters:

type - the type id

Returns:

the type represented by the id

Throws:

java.lang.IllegalArgumentException - if the type id does not correspond to any of the known types

isNumber

public boolean isNumber()

Returns:

true if this tag wraps a number value, false otherwise

isArray

public boolean isArray()

Returns:

true if this tag wraps a byte or int array, false otherwise

isByteArray

public boolean isByteArray()

Returns:

true if this tag wraps a byte array, false otherwise

isIntArray

public boolean isIntArray()

Returns:

true if this tag wraps an int array, false otherwise

isString

public boolean isString()

Returns:

true if this tag wraps a String, false otherwise

isList

public boolean isList()

Returns:

true if this tag is a list of NBT tags, false otherwise

isCompound

public boolean isCompound()

Returns:

true if this tag is a compound tag, false otherwise