net.lenni0451.mcstructs.nbt.io.internal

Interface NbtReadWrapper

All Known Implementing Classes:

NbtIO

@ParametersAreNonnullByDefault
public interface NbtReadWrapper

A wrapper class containing methods to read Nbt tags from different sources.

Method Summary

Modifier and Type	Method	Description
NbtReader	getReader()
default NbtTag	read(java.io.DataInput in, NbtReadTracker readTracker)	Read a Nbt tag from a DataInput.
default NbtTag	read(java.io.InputStream is, boolean compressed, NbtReadTracker readTracker)	Read a Nbt tag from an input stream.
default NbtTag	readCompressedFile(java.io.File f, NbtReadTracker readTracker)	Read a compressed Nbt tag from a file.
default NbtTag	readFile(java.io.File f, boolean compressed, NbtReadTracker readTracker)	Read a Nbt tag from a file.
default NbtTag	readFile(java.io.File f, NbtReadTracker readTracker)	Read an uncompressed Nbt tag from a file.
default NamedTag	readNamed(java.io.DataInput in, NbtReadTracker readTracker)	Read a named Nbt tag from a DataInput.
default NbtTag	readUnnamed(java.io.DataInput in, NbtReadTracker readTracker)	Read an unnamed Nbt tag from a DataInput.

Method Detail

getReader

NbtReader getReader()

readFile

@Nullable
default NbtTag readFile(java.io.File f,
                                   NbtReadTracker readTracker)
                            throws java.io.IOException

Read an uncompressed Nbt tag from a file.

Parameters:

f - The file to read from

readTracker - The read tracker to use

Returns:

The read tag (null if an end tag was read)

Throws:

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

readCompressedFile

@Nullable
default NbtTag readCompressedFile(java.io.File f,
                                             NbtReadTracker readTracker)
                                      throws java.io.IOException

Read a compressed Nbt tag from a file.

Parameters:

f - The file to read from

readTracker - The read tracker to use

Returns:

The read tag (null if an end tag was read)

Throws:

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

readFile

@Nullable
default NbtTag readFile(java.io.File f,
                                   boolean compressed,
                                   NbtReadTracker readTracker)
                            throws java.io.IOException

Read a Nbt tag from a file.

Parameters:

f - The file to read from

compressed - Whether the file is compressed or not

readTracker - The read tracker to use

Returns:

The read tag (null if an end tag was read)

Throws:

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

read

@Nullable
 @WillNotClose
default NbtTag read(java.io.InputStream is,
                                               boolean compressed,
                                               NbtReadTracker readTracker)
                                        throws java.io.IOException

Read a Nbt tag from an input stream.

Parameters:

is - The input stream to read from

compressed - Whether the input stream is compressed or not

readTracker - The read tracker to use

Returns:

The read tag (null if an end tag was read)

Throws:

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

read

@Nullable
 @WillNotClose
default NbtTag read(java.io.DataInput in,
                                               NbtReadTracker readTracker)
                                        throws java.io.IOException

Read a Nbt tag from a DataInput.

Parameters:

in - The data input to read from

readTracker - The read tracker to use

Returns:

The read tag (null if an end tag was read)

Throws:

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

readNamed

@Nullable
default NamedTag readNamed(java.io.DataInput in,
                                      NbtReadTracker readTracker)
                               throws java.io.IOException

Read a named Nbt tag from a DataInput.

Parameters:

in - The data input to read from

readTracker - The read tracker to use

Returns:

The read tag (null if an end tag was read)

Throws:

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

readUnnamed

@Nullable
default NbtTag readUnnamed(java.io.DataInput in,
                                      NbtReadTracker readTracker)
                               throws java.io.IOException

Read an unnamed Nbt tag from a DataInput.
Unnamed tags are a network only feature of Minecraft 1.20.2+!
You probably need to use read(DataInput, NbtReadTracker) instead!

Parameters:

in - The data input to read from

readTracker - The read tracker to use

Returns:

The read tag (null if an end tag was read)

Throws:

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