Package net.kyori.adventure.nbt

Class BinaryTagIO

java.lang.Object

net.kyori.adventure.nbt.BinaryTagIO

public final class BinaryTagIO
extends Object

Serialization operations for binary tags.

Since:

4.0.0

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	BinaryTagIO.Compression	Compression types.
static interface	BinaryTagIO.Reader	CompoundBinaryTag reader.
static interface	BinaryTagIO.Writer	CompoundBinaryTag writer.

Method Summary

Modifier and Type	Method	Description
static @NotNull CompoundBinaryTag	readCompressedInputStream(@NotNull InputStream input)	Deprecated. since 4.4.0, use reader()
static @NotNull CompoundBinaryTag	readCompressedPath(@NotNull Path path)	Deprecated. since 4.4.0, use reader()
static @NotNull CompoundBinaryTag	readDataInput(@NotNull DataInput input)	Deprecated. since 4.4.0, use reader()
static @NotNull BinaryTagIO.Reader	reader()	Returns BinaryTagIO.Reader, used to read binary tags.
static @NotNull BinaryTagIO.Reader	reader(long sizeLimitBytes)	Returns BinaryTagIO.Reader, used to read binary tags.
static @NotNull CompoundBinaryTag	readInputStream(@NotNull InputStream input)	Deprecated. since 4.4.0, use reader()
static @NotNull CompoundBinaryTag	readPath(@NotNull Path path)	Deprecated. since 4.4.0, use reader()
static @NotNull BinaryTagIO.Reader	unlimitedReader()	Returns BinaryTagIO.Reader, used to read binary tags.
static void	writeCompressedOutputStream(@NotNull CompoundBinaryTag tag, @NotNull OutputStream output)	Deprecated. since 4.4.0, use writer()
static void	writeCompressedPath(@NotNull CompoundBinaryTag tag, @NotNull Path path)	Deprecated. since 4.4.0, use writer()
static void	writeDataOutput(@NotNull CompoundBinaryTag tag, @NotNull DataOutput output)	Deprecated. since 4.4.0, use writer()
static void	writeOutputStream(@NotNull CompoundBinaryTag tag, @NotNull OutputStream output)	Deprecated. since 4.4.0, use writer()
static void	writePath(@NotNull CompoundBinaryTag tag, @NotNull Path path)	Deprecated. since 4.4.0, use writer()
static @NotNull BinaryTagIO.Writer	writer()	Returns BinaryTagIO.Writer, used to write binary tags.

Methods inherited from class java.lang.Object

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

Method Detail

unlimitedReader

@NotNull
public static @NotNull BinaryTagIO.Reader unlimitedReader()

Returns BinaryTagIO.Reader, used to read binary tags.

There is a maximum depth of 512 nested tags allowed, but no limit for the amount of contained data.

Returns:

binary tag reader

Since:

4.4.0

reader

@NotNull
public static @NotNull BinaryTagIO.Reader reader()

Returns BinaryTagIO.Reader, used to read binary tags.

This reader has a size limit for the estimated number of data bytes for a tag.

Returns:

binary tag reader

Since:

4.4.0

reader

@NotNull
public static @NotNull BinaryTagIO.Reader reader(long sizeLimitBytes)

Returns BinaryTagIO.Reader, used to read binary tags.

This reader will limit the number of bytes read to the approximate size limit indicated.

Parameters:

sizeLimitBytes - the maximum (approximate) size of uncompressed data, must be greater than 0

Returns:

binary tag reader

Since:

4.4.0

writer

@NotNull
public static @NotNull BinaryTagIO.Writer writer()

Returns BinaryTagIO.Writer, used to write binary tags.

Returns:

binary tag writer

Since:

4.4.0

readPath

@Deprecated
@NotNull
public static @NotNull CompoundBinaryTag readPath(@NotNull
                                                  @NotNull Path path)
                                           throws IOException

Deprecated.

since 4.4.0, use reader()

Reads a compound tag from path.

Parameters:

path - the path

Returns:

the compound tag

Throws:

IOException - if an exception was encountered while reading a compound tag

Since:

4.0.0

readInputStream

@Deprecated
@NotNull
public static @NotNull CompoundBinaryTag readInputStream(@NotNull
                                                         @NotNull InputStream input)
                                                  throws IOException

Deprecated.

since 4.4.0, use reader()

Reads a compound tag from an input stream. The stream is not closed afterwards.

Parameters:

input - the input stream

Returns:

the compound tag

Throws:

IOException - if an exception was encountered while reading a compound tag

Since:

4.0.0

readCompressedPath

@Deprecated
@NotNull
public static @NotNull CompoundBinaryTag readCompressedPath(@NotNull
                                                            @NotNull Path path)
                                                     throws IOException

Deprecated.

since 4.4.0, use reader()

Reads a compound tag from path using GZIP decompression.

Parameters:

path - the path

Returns:

the compound tag

Throws:

IOException - if an exception was encountered while reading a compound tag

Since:

4.0.0

readCompressedInputStream

@Deprecated
@NotNull
public static @NotNull CompoundBinaryTag readCompressedInputStream(@NotNull
                                                                   @NotNull InputStream input)
                                                            throws IOException

Deprecated.

since 4.4.0, use reader()

Reads a compound tag from an input stream using GZIP decompression. The stream is not closed afterwards.

Parameters:

input - the input stream

Returns:

the compound tag

Throws:

IOException - if an exception was encountered while reading a compound tag

Since:

4.0.0

readDataInput

@Deprecated
@NotNull
public static @NotNull CompoundBinaryTag readDataInput(@NotNull
                                                       @NotNull DataInput input)
                                                throws IOException

Deprecated.

since 4.4.0, use reader()

Reads a compound tag from input.

Parameters:

input - the input

Returns:

the compound tag

Throws:

IOException - if an exception was encountered while reading a compound tag

Since:

4.0.0

writePath

@Deprecated
public static void writePath(@NotNull
                             @NotNull CompoundBinaryTag tag,
                             @NotNull
                             @NotNull Path path)
                      throws IOException

Deprecated.

since 4.4.0, use writer()

Writes a compound tag to path.

Parameters:

tag - the compound tag

path - the path

Throws:

IOException - if an exception was encountered while writing the compound tag

Since:

4.0.0

writeOutputStream

@Deprecated
public static void writeOutputStream(@NotNull
                                     @NotNull CompoundBinaryTag tag,
                                     @NotNull
                                     @NotNull OutputStream output)
                              throws IOException

Deprecated.

since 4.4.0, use writer()

Writes a compound tag to an output stream. The output stream will not be closed.

Parameters:

tag - the compound tag

output - the output stream

Throws:

IOException - if an exception was encountered while writing the compound tag

Since:

4.0.0

writeCompressedPath

@Deprecated
public static void writeCompressedPath(@NotNull
                                       @NotNull CompoundBinaryTag tag,
                                       @NotNull
                                       @NotNull Path path)
                                throws IOException

Deprecated.

since 4.4.0, use writer()

Writes a compound tag to path using GZIP compression.

Parameters:

tag - the compound tag

path - the path

Throws:

IOException - if an exception was encountered while writing the compound tag

Since:

4.0.0

writeCompressedOutputStream

@Deprecated
public static void writeCompressedOutputStream(@NotNull
                                               @NotNull CompoundBinaryTag tag,
                                               @NotNull
                                               @NotNull OutputStream output)
                                        throws IOException

Deprecated.

since 4.4.0, use writer()

Writes a compound tag to an output stream using GZIP compression. The output stream is not closed afterwards.

Parameters:

tag - the compound tag

output - the output stream

Throws:

IOException - if an exception was encountered while writing the compound tag

Since:

4.0.0

writeDataOutput

@Deprecated
public static void writeDataOutput(@NotNull
                                   @NotNull CompoundBinaryTag tag,
                                   @NotNull
                                   @NotNull DataOutput output)
                            throws IOException

Deprecated.

since 4.4.0, use writer()

Writes a compound tag to output.

Parameters:

tag - the compound tag

output - the output

Throws:

IOException - if an exception was encountered while writing the compound tag

Since:

4.0.0