net.lenni0451.mcstructs.nbt.io.types

Interface INbtReader

All Known Implementing Classes:

JavaNbtReader

@ParametersAreNonnullByDefault
public interface INbtReader

Method Summary

Modifier and Type	Method and Description
default INbtTag	read(NbtType type, java.io.DataInput in, NbtReadTracker readTracker) Read a Nbt tag by its type.
ByteTag	readByte(java.io.DataInput in, NbtReadTracker readTracker) Read a byte tag.
ByteArrayTag	readByteArray(java.io.DataInput in, NbtReadTracker readTracker) Read a byte array tag.
CompoundTag	readCompound(java.io.DataInput in, NbtReadTracker readTracker) Read a compound tag.
DoubleTag	readDouble(java.io.DataInput in, NbtReadTracker readTracker) Read a double tag.
FloatTag	readFloat(java.io.DataInput in, NbtReadTracker readTracker) Read a float tag.
NbtHeader	readHeader(java.io.DataInput in, NbtReadTracker readTracker) Read the header of a Nbt tag.
IntTag	readInt(java.io.DataInput in, NbtReadTracker readTracker) Read a int tag.
IntArrayTag	readIntArray(java.io.DataInput in, NbtReadTracker readTracker) Read a int array tag.
ListTag<?>	readList(java.io.DataInput in, NbtReadTracker readTracker) Read a list tag.
LongTag	readLong(java.io.DataInput in, NbtReadTracker readTracker) Read a long tag.
LongArrayTag	readLongArray(java.io.DataInput in, NbtReadTracker readTracker) Read a long array tag.
ShortTag	readShort(java.io.DataInput in, NbtReadTracker readTracker) Read a short tag.
StringTag	readString(java.io.DataInput in, NbtReadTracker readTracker) Read a string tag.
NbtType	readType(java.io.DataInput in, NbtReadTracker readTracker) Read a Nbt type.

Method Detail

readType

@Nonnull
NbtType readType(java.io.DataInput in,
                           NbtReadTracker readTracker)
                    throws java.io.IOException

Read a Nbt type.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The type

Throws:

java.io.IOException - If an I/O error occurs

readHeader

@Nonnull
NbtHeader readHeader(java.io.DataInput in,
                               NbtReadTracker readTracker)
                        throws java.io.IOException

Read the header of a Nbt tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The header

Throws:

java.io.IOException - If an I/O error occurs

read

@Nonnull
default INbtTag read(NbtType type,
                               java.io.DataInput in,
                               NbtReadTracker readTracker)
                        throws java.io.IOException

Read a Nbt tag by its type.
Automatically calls the correct method for the tag type.

Parameters:

type - The tag type

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readByte

@Nonnull
ByteTag readByte(java.io.DataInput in,
                           NbtReadTracker readTracker)
                    throws java.io.IOException

Read a byte tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readShort

@Nonnull
ShortTag readShort(java.io.DataInput in,
                             NbtReadTracker readTracker)
                      throws java.io.IOException

Read a short tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readInt

@Nonnull
IntTag readInt(java.io.DataInput in,
                         NbtReadTracker readTracker)
                  throws java.io.IOException

Read a int tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readLong

@Nonnull
LongTag readLong(java.io.DataInput in,
                           NbtReadTracker readTracker)
                    throws java.io.IOException

Read a long tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readFloat

@Nonnull
FloatTag readFloat(java.io.DataInput in,
                             NbtReadTracker readTracker)
                      throws java.io.IOException

Read a float tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readDouble

@Nonnull
DoubleTag readDouble(java.io.DataInput in,
                               NbtReadTracker readTracker)
                        throws java.io.IOException

Read a double tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readByteArray

@Nonnull
ByteArrayTag readByteArray(java.io.DataInput in,
                                     NbtReadTracker readTracker)
                              throws java.io.IOException

Read a byte array tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readString

@Nonnull
StringTag readString(java.io.DataInput in,
                               NbtReadTracker readTracker)
                        throws java.io.IOException

Read a string tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readList

@Nonnull
ListTag<?> readList(java.io.DataInput in,
                              NbtReadTracker readTracker)
                       throws java.io.IOException

Read a list tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readCompound

@Nonnull
CompoundTag readCompound(java.io.DataInput in,
                                   NbtReadTracker readTracker)
                            throws java.io.IOException

Read a compound tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readIntArray

@Nonnull
IntArrayTag readIntArray(java.io.DataInput in,
                                   NbtReadTracker readTracker)
                            throws java.io.IOException

Read a int array tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs

readLongArray

@Nonnull
LongArrayTag readLongArray(java.io.DataInput in,
                                     NbtReadTracker readTracker)
                              throws java.io.IOException

Read a long array tag.

Parameters:

in - The data input

readTracker - The read tracker

Returns:

The tag

Throws:

java.io.IOException - If an I/O error occurs