xyz.nickr.nbt

Class NBTCodec

java.lang.Object

xyz.nickr.nbt.NBTCodec

public class NBTCodec
extends Object

The main controlling class for the NBT API.
This class creates, encodes, and decodes NBTTags.

Author:

Nick Robson

Constructor Summary

Constructors

Constructor and Description
NBTCodec(ByteOrder order) Creates a NBTCodec object with a given byte order.

Method Summary

Modifier and Type	Method and Description
static NBTTag	createTag(byte id) Attempts to create an NBTTag given a type ID.
NBTTag	decode(io.netty.buffer.ByteBuf buf, NBTCompression compression) Decodes a NBTTag from a given ByteBuf, using a specified NBTCompression method.
NBTTag	decode(InputStream in, NBTCompression compression) Decodes a NBTTag from a given InputStream, using a specified NBTCompression method.
void	encode(io.netty.buffer.ByteBuf buf, NBTTag tag, NBTCompression compression) Encodes an NBTTag to a given ByteBuf, using a specified NBTCompression method.
void	encode(OutputStream out, NBTTag tag, NBTCompression compression) Encodes an NBTTag to a given OutputStream, using a specified NBTCompression method.
static byte[]	toByteArray(io.netty.buffer.ByteBuf buf) Gets a byte array representing the contents of a given ByteBuf.

Methods inherited from class java.lang.Object

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

Constructor Detail

NBTCodec

public NBTCodec(ByteOrder order)

Creates a NBTCodec object with a given byte order.

Parameters:

order - The byte order.

Method Detail

createTag

public static NBTTag createTag(byte id)

Attempts to create an NBTTag given a type ID.

Parameters:

id - The type ID.

Returns:

A newly constructed NBTTag.

decode

public NBTTag decode(io.netty.buffer.ByteBuf buf,
                     NBTCompression compression)

Decodes a NBTTag from a given ByteBuf, using a specified NBTCompression method.

Parameters:

buf - The buffer to decode from.

compression - The compression method used.

Returns:

The decoded NBTTag.

decode

public NBTTag decode(InputStream in,
                     NBTCompression compression)

Decodes a NBTTag from a given InputStream, using a specified NBTCompression method.

Parameters:

in - The input stream to decode from.

compression - The compression method used.

Returns:

The decoded NBTTag.

encode

public void encode(io.netty.buffer.ByteBuf buf,
                   NBTTag tag,
                   NBTCompression compression)

Encodes an NBTTag to a given ByteBuf, using a specified NBTCompression method.

Parameters:

buf - The buffer to encode to.

tag - The tag to be encoded.

compression - The compression method to be used.

encode

public void encode(OutputStream out,
                   NBTTag tag,
                   NBTCompression compression)

Encodes an NBTTag to a given OutputStream, using a specified NBTCompression method.

Parameters:

out - The output stream to encode to.

tag - The tag to be encoded.

compression - The compression method to be used.

toByteArray

public static byte[] toByteArray(io.netty.buffer.ByteBuf buf)

Gets a byte array representing the contents of a given ByteBuf.

Parameters:

buf - The ByteBuf.

Returns:

The byte array.