Module net.kyori.adventure.nbt

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 BinaryTagIO.Reader	reader()	Returns BinaryTagIO.Reader, used to read binary tags.
static BinaryTagIO.Reader	reader(long sizeLimitBytes)	Returns BinaryTagIO.Reader, used to read binary tags.
static BinaryTagIO.Reader	unlimitedReader()	Returns BinaryTagIO.Reader, used to read binary tags.
static 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 Details

unlimitedReader

public static 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

public static 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

public static 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

public static BinaryTagIO.Writer writer()

Returns BinaryTagIO.Writer, used to write binary tags.

Returns:

binary tag writer

Since:

4.4.0