Module net.minestom.server

Package net.minestom.server.codec

Interface Codec<T>

Type Parameters:

T - The type to be represented by this codec

All Superinterfaces:

Decoder<T>, Encoder<T>

All Known Subinterfaces:

DataComponent<T>, StructCodec<R>

@Experimental
public interface Codec<T>
extends Encoder<T>, Decoder<T>

A Codec represents a combined Encoder and Decoder for a value.

Heavily inspired by Mojang/DataFixerUpper, licensed under the MIT license.

Nested Class Summary

Nested Classes

Modifier and Type	Interface	Description
static interface	Codec.RawValue

Field Summary

Fields

Modifier and Type	Field	Description
static final Codec<Point>	BLOCK_POSITION
static final Codec<Boolean>	BOOLEAN
static final Codec<Byte>	BYTE
static final Codec<byte[]>	BYTE_ARRAY
static final Codec<Component>	COMPONENT
static final Codec<Style>	COMPONENT_STYLE
static final Codec<Double>	DOUBLE
static final Codec<Float>	FLOAT
static final Codec<Integer>	INT
static final Codec<int[]>	INT_ARRAY
static final Codec<net.kyori.adventure.key.Key>	KEY
static final Codec<Long>	LONG
static final Codec<long[]>	LONG_ARRAY
static final Codec<net.kyori.adventure.nbt.BinaryTag>	NBT
static final Codec<net.kyori.adventure.nbt.CompoundBinaryTag>	NBT_COMPOUND
static final Codec<Codec.RawValue>	RAW_VALUE
static final Codec<Short>	SHORT
static final Codec<String>	STRING
static final Codec<Unit>	UNIT
static final Codec<UUID>	UUID
static final Codec<UUID>	UUID_COERCED
static final Codec<UUID>	UUID_STRING
static final Codec<Point>	VECTOR3D

Method Summary

Modifier and Type	Method	Description
static <L, R> Codec<Either<L,R>>	Either(Codec<L> leftCodec, Codec<R> rightCodec)
static <E extends Enum<E>> Codec<E>	Enum(Class<E> enumClass)
static <T> Codec<T>	ForwardRef(Supplier<Codec<T>> func)
default Codec<List<T>>	list()
default Codec<List<T>>	list(int maxSize)
default Codec<List<T>>	listOrSingle()
default Codec<List<T>>	listOrSingle(int maxSize)
default <V> Codec<Map<T,V>>	mapValue(Codec<V> valueCodec)
default <V> Codec<Map<T,V>>	mapValue(Codec<V> valueCodec, int maxSize)
default Codec<@Nullable T>	optional()
default Codec<T>	optional(T defaultValue)
default Codec<T>	orElse(Codec<T> other)
static <T> Codec<T>	Recursive(Function<Codec<T>,Codec<T>> func)
static <T> StructCodec<T>	RegistryTaggedUnion(Registries.Selector<StructCodec<? extends T>> registrySelector, Function<T,StructCodec<? extends T>> serializerGetter, String key)
static <T> StructCodec<T>	RegistryTaggedUnion(Registry<StructCodec<? extends T>> registry, Function<T,StructCodec<? extends T>> serializerGetter, String key)
default Codec<Set<T>>	set()
default Codec<Set<T>>	set(int maxSize)
default <S> Codec<S>	transform(ThrowingFunction<T,S> to, ThrowingFunction<S,T> from)
default <R, T1 extends T, TR extends R> StructCodec<R>	unionType(String keyField, Function<T,StructCodec<TR>> serializers, Function<R,T1> keyFunc)
default <R, T1 extends T, TR extends R> StructCodec<R>	unionType(Function<T,StructCodec<TR>> serializers, Function<R,T1> keyFunc)

Methods inherited from interface net.minestom.server.codec.Decoder

decode

Methods inherited from interface net.minestom.server.codec.Encoder

encode

Field Details

RAW_VALUE

static final Codec<Codec.RawValue> RAW_VALUE

UNIT

static final Codec<Unit> UNIT

BOOLEAN

static final Codec<Boolean> BOOLEAN

BYTE

static final Codec<Byte> BYTE

SHORT

static final Codec<Short> SHORT

INT

static final Codec<Integer> INT

LONG

static final Codec<Long> LONG

FLOAT

static final Codec<Float> FLOAT

DOUBLE

static final Codec<Double> DOUBLE

STRING

static final Codec<String> STRING

KEY

static final Codec<net.kyori.adventure.key.Key> KEY

BYTE_ARRAY

static final Codec<byte[]> BYTE_ARRAY

INT_ARRAY

static final Codec<int[]> INT_ARRAY

LONG_ARRAY

static final Codec<long[]> LONG_ARRAY

UUID

static final Codec<UUID> UUID

UUID_STRING

static final Codec<UUID> UUID_STRING

UUID_COERCED

static final Codec<UUID> UUID_COERCED

COMPONENT

static final Codec<Component> COMPONENT

COMPONENT_STYLE

static final Codec<Style> COMPONENT_STYLE

BLOCK_POSITION

static final Codec<Point> BLOCK_POSITION

VECTOR3D

static final Codec<Point> VECTOR3D

NBT

static final Codec<net.kyori.adventure.nbt.BinaryTag> NBT

NBT_COMPOUND

static final Codec<net.kyori.adventure.nbt.CompoundBinaryTag> NBT_COMPOUND

Method Details

Enum

static <E extends Enum<E>> Codec<E> Enum(Class<E> enumClass)

Recursive

static <T> Codec<T> Recursive(Function<Codec<T>,Codec<T>> func)

ForwardRef

static <T> Codec<T> ForwardRef(Supplier<Codec<T>> func)

RegistryTaggedUnion

static <T> StructCodec<T> RegistryTaggedUnion(Registry<StructCodec<? extends T>> registry,
 Function<T,StructCodec<? extends T>> serializerGetter,
 String key)

RegistryTaggedUnion

static <T> StructCodec<T> RegistryTaggedUnion(Registries.Selector<StructCodec<? extends T>> registrySelector,
 Function<T,StructCodec<? extends T>> serializerGetter,
 String key)

Either

static <L,
R> Codec<Either<L,R>> Either(Codec<L> leftCodec,
 Codec<R> rightCodec)

optional

default Codec<@Nullable T> optional()

optional

default Codec<T> optional(T defaultValue)

transform

default <S> Codec<S> transform(ThrowingFunction<T,S> to,
 ThrowingFunction<S,T> from)

list

default Codec<List<T>> list(int maxSize)

list

default Codec<List<T>> list()

listOrSingle

default Codec<List<T>> listOrSingle(int maxSize)

listOrSingle

default Codec<List<T>> listOrSingle()

set

default Codec<Set<T>> set(int maxSize)

set

default Codec<Set<T>> set()

mapValue

default <V> Codec<Map<T,V>> mapValue(Codec<V> valueCodec,
 int maxSize)

mapValue

default <V> Codec<Map<T,V>> mapValue(Codec<V> valueCodec)

unionType

default <R,
T1 extends T,
TR extends R>
StructCodec<R> unionType(Function<T,StructCodec<TR>> serializers,
 Function<R,T1> keyFunc)

unionType

default <R,
T1 extends T,
TR extends R>
StructCodec<R> unionType(String keyField,
 Function<T,StructCodec<TR>> serializers,
 Function<R,T1> keyFunc)

orElse

default Codec<T> orElse(Codec<T> other)