Package net.minestom.server.utils.nbt

Interface BinaryTagSerializer<T>

@Internal
public interface BinaryTagSerializer<T>

API Note: This class and associated types are currently considered an internal api. It is likely there will be significant changes in the future, and there will not be backwards compatibility for this. Use at your own risk.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	BinaryTagSerializer.Context
static final record	BinaryTagSerializer.ContextWithRegistries
static interface	BinaryTagSerializer.Function3<P1,P2,P3,R>
static interface	BinaryTagSerializer.Function4<P1,P2,P3,P4,R>
static interface	BinaryTagSerializer.Function5<P1,P2,P3,P4,P5,R>
static interface	BinaryTagSerializer.Function6<P1,P2,P3,P4,P5,P6,R>
static interface	BinaryTagSerializer.Function7<P1,P2,P3,P4,P5,P6,P7,R>

Field Summary

Fields

Modifier and Type	Field	Description
static final BinaryTagSerializer<Point>	BLOCK_POSITION
static final BinaryTagSerializer<Boolean>	BOOLEAN
static final BinaryTagSerializer<Byte>	BYTE
static final BinaryTagSerializer<net.kyori.adventure.nbt.CompoundBinaryTag>	COMPOUND
static final BinaryTagSerializer<net.kyori.adventure.nbt.CompoundBinaryTag>	COMPOUND_COERCED
static final BinaryTagSerializer<Float>	FLOAT
static final BinaryTagSerializer<Integer>	INT
static final BinaryTagSerializer<ItemStack>	ITEM
static final BinaryTagSerializer<Component>	JSON_COMPONENT
static final BinaryTagSerializer<Component>	NBT_COMPONENT
static final BinaryTagSerializer<Style>	NBT_COMPONENT_STYLE
static final BinaryTagSerializer<String>	STRING
static final BinaryTagSerializer<Unit>	UNIT
static final BinaryTagSerializer<UUID>	UUID
static final BinaryTagSerializer<Point>	VECTOR3D

Method Summary

Modifier and Type	Method	Description
static <T extends net.kyori.adventure.nbt.BinaryTag> @NotNull BinaryTagSerializer<T>	coerced(@NotNull net.kyori.adventure.nbt.BinaryTagType<T> type)
static <E extends Enum<E> & net.kyori.adventure.key.Keyed> @NotNull BinaryTagSerializer<E>	fromEnumKeyed(@NotNull Class<E> enumClass)
static <E extends Enum<E>> @NotNull BinaryTagSerializer<E>	fromEnumStringable(@NotNull Class<E> enumClass)
static <T> @NotNull BinaryTagSerializer<T>	lazy(@NotNull Supplier<BinaryTagSerializer<T>> self)
default BinaryTagSerializer<List<T>>	list()
default <S> BinaryTagSerializer<S>	map(@NotNull Function<T,S> to, @NotNull Function<S,T> from)
default <V> BinaryTagSerializer<Map<T,V>>	mapValue(@NotNull BinaryTagSerializer<V> valueType)
static <P1, P2, P3, P4, P5, P6, P7, R> @NotNull BinaryTagSerializer<R>	object(@NotNull String param1, @NotNull BinaryTagSerializer<P1> serializer1, @NotNull Function<R,P1> getter1, @NotNull String param2, @NotNull BinaryTagSerializer<P2> serializer2, @NotNull Function<R,P2> getter2, @NotNull String param3, @NotNull BinaryTagSerializer<P3> serializer3, @NotNull Function<R,P3> getter3, @NotNull String param4, @NotNull BinaryTagSerializer<P4> serializer4, @NotNull Function<R,P4> getter4, @NotNull String param5, @NotNull BinaryTagSerializer<P5> serializer5, @NotNull Function<R,P5> getter5, @NotNull String param6, @NotNull BinaryTagSerializer<P6> serializer6, @NotNull Function<R,P6> getter6, @NotNull String param7, @NotNull BinaryTagSerializer<P7> serializer7, @NotNull Function<R,P7> getter7, @NotNull BinaryTagSerializer.Function7<P1,P2,P3,P4,P5,P6,P7,R> constructor)
static <P1, P2, P3, P4, P5, P6, R> @NotNull BinaryTagSerializer<R>	object(@NotNull String param1, @NotNull BinaryTagSerializer<P1> serializer1, @NotNull Function<R,P1> getter1, @NotNull String param2, @NotNull BinaryTagSerializer<P2> serializer2, @NotNull Function<R,P2> getter2, @NotNull String param3, @NotNull BinaryTagSerializer<P3> serializer3, @NotNull Function<R,P3> getter3, @NotNull String param4, @NotNull BinaryTagSerializer<P4> serializer4, @NotNull Function<R,P4> getter4, @NotNull String param5, @NotNull BinaryTagSerializer<P5> serializer5, @NotNull Function<R,P5> getter5, @NotNull String param6, @NotNull BinaryTagSerializer<P6> serializer6, @NotNull Function<R,P6> getter6, @NotNull BinaryTagSerializer.Function6<P1,P2,P3,P4,P5,P6,R> constructor)
static <P1, P2, P3, P4, P5, R> @NotNull BinaryTagSerializer<R>	object(@NotNull String param1, @NotNull BinaryTagSerializer<P1> serializer1, @NotNull Function<R,P1> getter1, @NotNull String param2, @NotNull BinaryTagSerializer<P2> serializer2, @NotNull Function<R,P2> getter2, @NotNull String param3, @NotNull BinaryTagSerializer<P3> serializer3, @NotNull Function<R,P3> getter3, @NotNull String param4, @NotNull BinaryTagSerializer<P4> serializer4, @NotNull Function<R,P4> getter4, @NotNull String param5, @NotNull BinaryTagSerializer<P5> serializer5, @NotNull Function<R,P5> getter5, @NotNull BinaryTagSerializer.Function5<P1,P2,P3,P4,P5,R> constructor)
static <P1, P2, P3, P4, R> @NotNull BinaryTagSerializer<R>	object(@NotNull String param1, @NotNull BinaryTagSerializer<P1> serializer1, @NotNull Function<R,P1> getter1, @NotNull String param2, @NotNull BinaryTagSerializer<P2> serializer2, @NotNull Function<R,P2> getter2, @NotNull String param3, @NotNull BinaryTagSerializer<P3> serializer3, @NotNull Function<R,P3> getter3, @NotNull String param4, @NotNull BinaryTagSerializer<P4> serializer4, @NotNull Function<R,P4> getter4, @NotNull BinaryTagSerializer.Function4<P1,P2,P3,P4,R> constructor)
static <P1, P2, P3, R> @NotNull BinaryTagSerializer<R>	object(@NotNull String param1, @NotNull BinaryTagSerializer<P1> serializer1, @NotNull Function<R,P1> getter1, @NotNull String param2, @NotNull BinaryTagSerializer<P2> serializer2, @NotNull Function<R,P2> getter2, @NotNull String param3, @NotNull BinaryTagSerializer<P3> serializer3, @NotNull Function<R,P3> getter3, @NotNull BinaryTagSerializer.Function3<P1,P2,P3,R> constructor)
static <P1, P2, R> @NotNull BinaryTagSerializer<R>	object(@NotNull String param1, @NotNull BinaryTagSerializer<P1> serializer1, @NotNull Function<R,P1> getter1, @NotNull String param2, @NotNull BinaryTagSerializer<P2> serializer2, @NotNull Function<R,P2> getter2, @NotNull BiFunction<P1,P2,R> constructor)
static <P1, R> @NotNull BinaryTagSerializer<R>	object(@NotNull String param1, @NotNull BinaryTagSerializer<P1> serializer1, @NotNull Function<R,P1> getter1, @NotNull Function<P1,R> constructor)
default BinaryTagSerializer<@Nullable T>	optional()
default BinaryTagSerializer<@UnknownNullability T>	optional(T defaultValue)
default T	read(@NotNull net.kyori.adventure.nbt.BinaryTag tag)
default T	read(@NotNull BinaryTagSerializer.Context context, @NotNull net.kyori.adventure.nbt.BinaryTag tag)
static <T> @NotNull BinaryTagSerializer<T>	recursive(@NotNull Function<BinaryTagSerializer<T>,BinaryTagSerializer<T>> self)
static <T extends ProtocolObject> @NotNull BinaryTagSerializer<DynamicRegistry.Key<T>>	registryKey(@NotNull Function<Registries,DynamicRegistry<T>> registrySelector)
static <T> @NotNull BinaryTagSerializer<T>	registryTaggedUnion(@NotNull Function<Registries,DynamicRegistry<BinaryTagSerializer<? extends T>>> registrySelector, @NotNull Function<T,BinaryTagSerializer<? extends T>> serializerGetter, @NotNull String key)
default <R> BinaryTagSerializer<R>	unionType(@NotNull String keyField, @NotNull Function<T,BinaryTagSerializer<R>> serializers, @NotNull Function<R,T> keyFunc)
default <R> BinaryTagSerializer<R>	unionType(@NotNull Function<T,BinaryTagSerializer<R>> serializers, @NotNull Function<R,T> keyFunc)
default @NotNull net.kyori.adventure.nbt.BinaryTag	write(@NotNull BinaryTagSerializer.Context context, T value)
default @NotNull net.kyori.adventure.nbt.BinaryTag	write(T value)

Field Details

UNIT

static final BinaryTagSerializer<Unit> UNIT

BYTE

static final BinaryTagSerializer<Byte> BYTE

BOOLEAN

static final BinaryTagSerializer<Boolean> BOOLEAN

INT

static final BinaryTagSerializer<Integer> INT

FLOAT

static final BinaryTagSerializer<Float> FLOAT

STRING

static final BinaryTagSerializer<String> STRING

COMPOUND

static final BinaryTagSerializer<net.kyori.adventure.nbt.CompoundBinaryTag> COMPOUND

COMPOUND_COERCED

static final BinaryTagSerializer<net.kyori.adventure.nbt.CompoundBinaryTag> COMPOUND_COERCED

JSON_COMPONENT

static final BinaryTagSerializer<Component> JSON_COMPONENT

NBT_COMPONENT

static final BinaryTagSerializer<Component> NBT_COMPONENT

NBT_COMPONENT_STYLE

static final BinaryTagSerializer<Style> NBT_COMPONENT_STYLE

ITEM

static final BinaryTagSerializer<ItemStack> ITEM

UUID

static final BinaryTagSerializer<UUID> UUID

BLOCK_POSITION

static final BinaryTagSerializer<Point> BLOCK_POSITION

VECTOR3D

static final BinaryTagSerializer<Point> VECTOR3D

Method Details

recursive

@NotNull
static <T> @NotNull BinaryTagSerializer<T> recursive(@NotNull
 @NotNull Function<BinaryTagSerializer<T>,BinaryTagSerializer<T>> self)

lazy

@NotNull
static <T> @NotNull BinaryTagSerializer<T> lazy(@NotNull
 @NotNull Supplier<BinaryTagSerializer<T>> self)

coerced

@NotNull
static <T extends net.kyori.adventure.nbt.BinaryTag>
@NotNull BinaryTagSerializer<T> coerced(@NotNull
 @NotNull net.kyori.adventure.nbt.BinaryTagType<T> type)

fromEnumKeyed

@NotNull
static <E extends Enum<E> & net.kyori.adventure.key.Keyed>
@NotNull BinaryTagSerializer<E> fromEnumKeyed(@NotNull
 @NotNull Class<E> enumClass)

fromEnumStringable

@NotNull
static <E extends Enum<E>>
@NotNull BinaryTagSerializer<E> fromEnumStringable(@NotNull
 @NotNull Class<E> enumClass)

registryKey

@NotNull
static <T extends ProtocolObject>
@NotNull BinaryTagSerializer<DynamicRegistry.Key<T>> registryKey(@NotNull
 @NotNull Function<Registries,DynamicRegistry<T>> registrySelector)

object

@NotNull
static <P1,
R> @NotNull BinaryTagSerializer<R> object(@NotNull
 @NotNull String param1,
 @NotNull
 @NotNull BinaryTagSerializer<P1> serializer1,
 @NotNull
 @NotNull Function<R,P1> getter1,
 @NotNull
 @NotNull Function<P1,R> constructor)

object

@NotNull
static <P1,
P2,
R> @NotNull BinaryTagSerializer<R> object(@NotNull
 @NotNull String param1,
 @NotNull
 @NotNull BinaryTagSerializer<P1> serializer1,
 @NotNull
 @NotNull Function<R,P1> getter1,
 @NotNull
 @NotNull String param2,
 @NotNull
 @NotNull BinaryTagSerializer<P2> serializer2,
 @NotNull
 @NotNull Function<R,P2> getter2,
 @NotNull
 @NotNull BiFunction<P1,P2,R> constructor)

object

@NotNull
static <P1,
P2,
P3,
R>
@NotNull BinaryTagSerializer<R> object(@NotNull
 @NotNull String param1,
 @NotNull
 @NotNull BinaryTagSerializer<P1> serializer1,
 @NotNull
 @NotNull Function<R,P1> getter1,
 @NotNull
 @NotNull String param2,
 @NotNull
 @NotNull BinaryTagSerializer<P2> serializer2,
 @NotNull
 @NotNull Function<R,P2> getter2,
 @NotNull
 @NotNull String param3,
 @NotNull
 @NotNull BinaryTagSerializer<P3> serializer3,
 @NotNull
 @NotNull Function<R,P3> getter3,
 @NotNull
 @NotNull BinaryTagSerializer.Function3<P1,P2,P3,R> constructor)

object

@NotNull
static <P1,
P2,
P3,
P4,
R>
@NotNull BinaryTagSerializer<R> object(@NotNull
 @NotNull String param1,
 @NotNull
 @NotNull BinaryTagSerializer<P1> serializer1,
 @NotNull
 @NotNull Function<R,P1> getter1,
 @NotNull
 @NotNull String param2,
 @NotNull
 @NotNull BinaryTagSerializer<P2> serializer2,
 @NotNull
 @NotNull Function<R,P2> getter2,
 @NotNull
 @NotNull String param3,
 @NotNull
 @NotNull BinaryTagSerializer<P3> serializer3,
 @NotNull
 @NotNull Function<R,P3> getter3,
 @NotNull
 @NotNull String param4,
 @NotNull
 @NotNull BinaryTagSerializer<P4> serializer4,
 @NotNull
 @NotNull Function<R,P4> getter4,
 @NotNull
 @NotNull BinaryTagSerializer.Function4<P1,P2,P3,P4,R> constructor)

object

@NotNull
static <P1,
P2,
P3,
P4,
P5,
R>
@NotNull BinaryTagSerializer<R> object(@NotNull
 @NotNull String param1,
 @NotNull
 @NotNull BinaryTagSerializer<P1> serializer1,
 @NotNull
 @NotNull Function<R,P1> getter1,
 @NotNull
 @NotNull String param2,
 @NotNull
 @NotNull BinaryTagSerializer<P2> serializer2,
 @NotNull
 @NotNull Function<R,P2> getter2,
 @NotNull
 @NotNull String param3,
 @NotNull
 @NotNull BinaryTagSerializer<P3> serializer3,
 @NotNull
 @NotNull Function<R,P3> getter3,
 @NotNull
 @NotNull String param4,
 @NotNull
 @NotNull BinaryTagSerializer<P4> serializer4,
 @NotNull
 @NotNull Function<R,P4> getter4,
 @NotNull
 @NotNull String param5,
 @NotNull
 @NotNull BinaryTagSerializer<P5> serializer5,
 @NotNull
 @NotNull Function<R,P5> getter5,
 @NotNull
 @NotNull BinaryTagSerializer.Function5<P1,P2,P3,P4,P5,R> constructor)

object

@NotNull
static <P1,
P2,
P3,
P4,
P5,
P6,
R>
@NotNull BinaryTagSerializer<R> object(@NotNull
 @NotNull String param1,
 @NotNull
 @NotNull BinaryTagSerializer<P1> serializer1,
 @NotNull
 @NotNull Function<R,P1> getter1,
 @NotNull
 @NotNull String param2,
 @NotNull
 @NotNull BinaryTagSerializer<P2> serializer2,
 @NotNull
 @NotNull Function<R,P2> getter2,
 @NotNull
 @NotNull String param3,
 @NotNull
 @NotNull BinaryTagSerializer<P3> serializer3,
 @NotNull
 @NotNull Function<R,P3> getter3,
 @NotNull
 @NotNull String param4,
 @NotNull
 @NotNull BinaryTagSerializer<P4> serializer4,
 @NotNull
 @NotNull Function<R,P4> getter4,
 @NotNull
 @NotNull String param5,
 @NotNull
 @NotNull BinaryTagSerializer<P5> serializer5,
 @NotNull
 @NotNull Function<R,P5> getter5,
 @NotNull
 @NotNull String param6,
 @NotNull
 @NotNull BinaryTagSerializer<P6> serializer6,
 @NotNull
 @NotNull Function<R,P6> getter6,
 @NotNull
 @NotNull BinaryTagSerializer.Function6<P1,P2,P3,P4,P5,P6,R> constructor)

object

@NotNull
static <P1,
P2,
P3,
P4,
P5,
P6,
P7,
R>
@NotNull BinaryTagSerializer<R> object(@NotNull
 @NotNull String param1,
 @NotNull
 @NotNull BinaryTagSerializer<P1> serializer1,
 @NotNull
 @NotNull Function<R,P1> getter1,
 @NotNull
 @NotNull String param2,
 @NotNull
 @NotNull BinaryTagSerializer<P2> serializer2,
 @NotNull
 @NotNull Function<R,P2> getter2,
 @NotNull
 @NotNull String param3,
 @NotNull
 @NotNull BinaryTagSerializer<P3> serializer3,
 @NotNull
 @NotNull Function<R,P3> getter3,
 @NotNull
 @NotNull String param4,
 @NotNull
 @NotNull BinaryTagSerializer<P4> serializer4,
 @NotNull
 @NotNull Function<R,P4> getter4,
 @NotNull
 @NotNull String param5,
 @NotNull
 @NotNull BinaryTagSerializer<P5> serializer5,
 @NotNull
 @NotNull Function<R,P5> getter5,
 @NotNull
 @NotNull String param6,
 @NotNull
 @NotNull BinaryTagSerializer<P6> serializer6,
 @NotNull
 @NotNull Function<R,P6> getter6,
 @NotNull
 @NotNull String param7,
 @NotNull
 @NotNull BinaryTagSerializer<P7> serializer7,
 @NotNull
 @NotNull Function<R,P7> getter7,
 @NotNull
 @NotNull BinaryTagSerializer.Function7<P1,P2,P3,P4,P5,P6,P7,R> constructor)

registryTaggedUnion

@NotNull
static <T> @NotNull BinaryTagSerializer<T> registryTaggedUnion(@NotNull
 @NotNull Function<Registries,DynamicRegistry<BinaryTagSerializer<? extends T>>> registrySelector,
 @NotNull
 @NotNull Function<T,BinaryTagSerializer<? extends T>> serializerGetter,
 @NotNull
 @NotNull String key)

write

@NotNull
default @NotNull net.kyori.adventure.nbt.BinaryTag write(@NotNull
 @NotNull BinaryTagSerializer.Context context,
 @NotNull
 T value)

read

@NotNull
default T read(@NotNull
 @NotNull BinaryTagSerializer.Context context,
 @NotNull
 @NotNull net.kyori.adventure.nbt.BinaryTag tag)

write

@NotNull
default @NotNull net.kyori.adventure.nbt.BinaryTag write(@NotNull
 T value)

read

@NotNull
default T read(@NotNull
 @NotNull net.kyori.adventure.nbt.BinaryTag tag)

optional

default BinaryTagSerializer<@Nullable T> optional()

optional

default BinaryTagSerializer<@UnknownNullability T> optional(@Nullable
 T defaultValue)

map

default <S> BinaryTagSerializer<S> map(@NotNull
 @NotNull Function<T,S> to,
 @NotNull
 @NotNull Function<S,T> from)

list

default BinaryTagSerializer<List<T>> list()

mapValue

default <V> BinaryTagSerializer<Map<T,V>> mapValue(@NotNull
 @NotNull BinaryTagSerializer<V> valueType)

unionType

default <R> BinaryTagSerializer<R> unionType(@NotNull
 @NotNull Function<T,BinaryTagSerializer<R>> serializers,
 @NotNull
 @NotNull Function<R,T> keyFunc)

unionType

default <R> BinaryTagSerializer<R> unionType(@NotNull
 @NotNull String keyField,
 @NotNull
 @NotNull Function<T,BinaryTagSerializer<R>> serializers,
 @NotNull
 @NotNull Function<R,T> keyFunc)