Package net.kyori.adventure.nbt

Interface BinaryTagIO.Reader

Enclosing class:

BinaryTagIO

public static interface BinaryTagIO.Reader

CompoundBinaryTag reader.

Since:

4.4.0

Method Summary

Modifier and Type	Method	Description
@NonNull CompoundBinaryTag	read(@NonNull DataInput input)	Reads a binary tag from input.
default @NonNull CompoundBinaryTag	read(@NonNull InputStream input)	Reads a binary tag from input.
@NonNull CompoundBinaryTag	read(@NonNull InputStream input, @NonNull BinaryTagIO.Compression compression)	Reads a binary tag from input with a compression type.
default @NonNull CompoundBinaryTag	read(@NonNull Path path)	Reads a binary tag from path.
@NonNull CompoundBinaryTag	read(@NonNull Path path, @NonNull BinaryTagIO.Compression compression)	Reads a binary tag from path with a compression type.
@NonNull Map.Entry<String,CompoundBinaryTag>	readNamed(@NonNull DataInput input)	Reads a binary tag, with a name, from input.
default @NonNull Map.Entry<String,CompoundBinaryTag>	readNamed(@NonNull InputStream input)	Reads a binary tag, with a name, from input.
@NonNull Map.Entry<String,CompoundBinaryTag>	readNamed(@NonNull InputStream input, @NonNull BinaryTagIO.Compression compression)	Reads a binary tag, with a name, from input.
default @NonNull Map.Entry<String,CompoundBinaryTag>	readNamed(@NonNull Path path)	Reads a binary tag, with a name, from path.
@NonNull Map.Entry<String,CompoundBinaryTag>	readNamed(@NonNull Path path, @NonNull BinaryTagIO.Compression compression)	Reads a binary tag, with a name, from path.

Method Details

read

default @NonNull CompoundBinaryTag read(@NonNull Path path)
                                 throws IOException

Reads a binary tag from path.

This is the equivalent of passing Compression#NONE as the second parameter to read(Path, Compression).

Parameters:

path - the path

Returns:

a binary tag

Throws:

IOException - if an exception was encountered while reading the tag

Since:

4.4.0

read

@NonNull CompoundBinaryTag read(@NonNull Path path,
@NonNull BinaryTagIO.Compression compression)
                         throws IOException

Reads a binary tag from path with a compression type.

Parameters:

path - the path

compression - the compression type

Returns:

a binary tag

Throws:

IOException - if an exception was encountered while reading the tag

Since:

4.4.0

read

default @NonNull CompoundBinaryTag read(@NonNull InputStream input)
                                 throws IOException

Reads a binary tag from input.

This is the equivalent of passing Compression#NONE as the second parameter to read(InputStream, Compression).

Parameters:

input - the input stream

Returns:

a binary tag

Throws:

IOException - if an exception was encountered while reading the tag

Since:

4.4.0

read

@NonNull CompoundBinaryTag read(@NonNull InputStream input,
@NonNull BinaryTagIO.Compression compression)
                         throws IOException

Reads a binary tag from input with a compression type.

Parameters:

input - the input stream

compression - the compression type

Returns:

a binary tag

Throws:

IOException - if an exception was encountered while reading the tag

Since:

4.4.0

read

@NonNull CompoundBinaryTag read(@NonNull DataInput input)
                         throws IOException

Reads a binary tag from input.

Parameters:

input - the input stream

Returns:

a binary tag

Throws:

IOException - if an exception was encountered while reading the tag

Since:

4.4.0

readNamed

default @NonNull Map.Entry<String,CompoundBinaryTag> readNamed(@NonNull Path path)
                                                        throws IOException

Reads a binary tag, with a name, from path.

This is the equivalent of passing Compression#NONE as the second parameter to readNamed(Path, Compression).

Parameters:

path - the path

Returns:

a binary tag

Throws:

IOException - if an exception was encountered while reading the tag

Since:

4.4.0

readNamed

@NonNull Map.Entry<String,CompoundBinaryTag> readNamed(@NonNull Path path,
@NonNull BinaryTagIO.Compression compression)
                                                throws IOException

Reads a binary tag, with a name, from path.

Parameters:

path - the path

compression - the compression type

Returns:

a binary tag

Throws:

IOException - if an exception was encountered while reading the tag

Since:

4.4.0

readNamed

default @NonNull Map.Entry<String,CompoundBinaryTag> readNamed(@NonNull InputStream input)
                                                        throws IOException

Reads a binary tag, with a name, from input.

This is the equivalent of passing Compression#NONE as the second parameter to readNamed(InputStream, Compression).

Parameters:

input - the input stream

Returns:

a binary tag

Throws:

IOException - if an exception was encountered while reading the tag

Since:

4.4.0

readNamed

@NonNull Map.Entry<String,CompoundBinaryTag> readNamed(@NonNull InputStream input,
@NonNull BinaryTagIO.Compression compression)
                                                throws IOException

Reads a binary tag, with a name, from input.

Parameters:

input - the input stream

compression - the compression type

Returns:

a binary tag

Throws:

IOException - if an exception was encountered while reading the tag

Since:

4.4.0

readNamed

@NonNull Map.Entry<String,CompoundBinaryTag> readNamed(@NonNull DataInput input)
                                                throws IOException

Reads a binary tag, with a name, from input.

Parameters:

input - the input

Returns:

a binary tag

Throws:

IOException - if an exception was encountered while reading the tag

Since:

4.4.0