Interface NetworkBuffer.Type<T extends @UnknownNullability Object>

Type Parameters:

T - the value type, which may be nullable

All Known Implementing Classes:

DebugSubscriptionImpl

Enclosing interface:

NetworkBuffer

public static interface NetworkBuffer.Type<T extends @UnknownNullability Object>

Reads and writes values of T in a NetworkBuffer, so that reading returns the value that was written. Unlike StructCodec, types are always written linearly into a NetworkBuffer. Prefer NetworkBufferTemplate to build types for records, which keeps both directions in sync.

Method Summary

Modifier and Type	Method	Description
default NetworkBuffer.Type<T>	lengthPrefixed(int maxLength)	Creates a type that encodes each value as a NetworkBuffer.BYTE_ARRAY, which is a NetworkBuffer.VAR_INT length followed by the bytes of the value.
default NetworkBuffer.Type<@Unmodifiable @UnknownNullability List<T>>	list()	Creates a type for an unmodifiable list of this type, accepting up to Integer.MAX_VALUE elements.
default NetworkBuffer.Type<@Unmodifiable @UnknownNullability List<T>>	list(int maxSize)	Creates a type for an unmodifiable list of this type, encoded as a NetworkBuffer.VAR_INT size followed by each element.
default <V extends @UnknownNullability Object> NetworkBuffer.Type<@Unmodifiable @UnknownNullability Map<T,V>>	mapValue(NetworkBuffer.Type<V> valueType)	Creates a type for an unmodifiable map with keys of this type, accepting up to Integer.MAX_VALUE entries.
default <V extends @UnknownNullability Object> NetworkBuffer.Type<@Unmodifiable @UnknownNullability Map<T,V>>	mapValue(NetworkBuffer.Type<V> valueType, int maxSize)	Creates a type for an unmodifiable map with keys of this type, encoded as a NetworkBuffer.VAR_INT size followed by each key and value.
default NetworkBuffer.Type<T>	maxLength(long maxLength)	Creates a type that encodes values the same way as this type, but rejects values longer than maxLength bytes.
default NetworkBuffer.Type<@Nullable T>	optional()	Creates a type that also accepts null, encoded as a NetworkBuffer.BOOLEAN that is true when a value of this type follows.
T	read(NetworkBuffer buffer)	Reads a value from buffer at its read index.
default NetworkBuffer.Type<@Unmodifiable @UnknownNullability Set<T>>	set()	Creates a type for an unmodifiable set of this type, accepting up to Integer.MAX_VALUE elements.
default NetworkBuffer.Type<@Unmodifiable @UnknownNullability Set<T>>	set(int maxSize)	Creates a type for an unmodifiable set of this type, encoded as a NetworkBuffer.VAR_INT size followed by each element.
default long	sizeOf(T value)	Returns the number of bytes that write(NetworkBuffer, Object) uses for value, without registries.
default long	sizeOf(T value, @Nullable Registries registries)	Returns the number of bytes that write(NetworkBuffer, Object) uses for value.
default <S extends @UnknownNullability Object> NetworkBuffer.Type<S>	transform(Function<? super T, ? extends S> to, Function<? super S, ? extends T> from)	Creates a type that converts between the values of this type and S.
default <R extends @UnknownNullability Object> NetworkBuffer.Type<R>	unionType(Function<? super T, NetworkBuffer.Type<? extends R>> serializers, Function<? super R, ? extends T> keyFunc)	Creates a type for the subtypes of R, such as the permitted types of a sealed interface.
void	write(NetworkBuffer buffer, T value)	Writes a value to buffer at its write index.

Method Details

write

void write(NetworkBuffer buffer,
 T value)

Writes a value to buffer at its write index.

Parameters:

buffer - the buffer to write to

value - the value

read

T read(NetworkBuffer buffer)

Reads a value from buffer at its read index.

Parameters:

buffer - the buffer to read from

Returns:

the value

sizeOf

default long sizeOf(T value,
 @Nullable
 @Nullable Registries registries)

Returns the number of bytes that write(NetworkBuffer, Object) uses for value. The value is written to a dummy buffer, which counts bytes without storing them and cannot be read. Override this method rather than sizeOf(Object), which calls it without registries.

Parameters:

value - the value to measure

registries - the registries for types that need them, or null

Returns:

the size in bytes

sizeOf

default long sizeOf(T value)

Returns the number of bytes that write(NetworkBuffer, Object) uses for value, without registries.

Parameters:

value - the value to measure

Returns:

the size in bytes

See Also:

• sizeOf(Object, Registries)

transform

default <S extends @UnknownNullability Object>
NetworkBuffer.Type<S> transform(Function<? super T, ? extends S> to,
 Function<? super S, ? extends T> from)

Creates a type that converts between the values of this type and S.

Type Parameters:

S - the converted type

Parameters:

to - the function applied to each value read by this type

from - the function applied to each value before this type writes it

Returns:

the converted type

mapValue

default <V extends @UnknownNullability Object>
NetworkBuffer.Type<@Unmodifiable @UnknownNullability Map<T,V>> mapValue(NetworkBuffer.Type<V> valueType,
 int maxSize)

Creates a type for an unmodifiable map with keys of this type, encoded as a NetworkBuffer.VAR_INT size followed by each key and value. Reading throws IllegalArgumentException when the size is negative or greater than maxSize, or a key repeats.

Type Parameters:

V - the value type

Parameters:

valueType - the type of the values

maxSize - the largest size accepted when reading

Returns:

the map type

mapValue

default <V extends @UnknownNullability Object>
NetworkBuffer.Type<@Unmodifiable @UnknownNullability Map<T,V>> mapValue(NetworkBuffer.Type<V> valueType)

Creates a type for an unmodifiable map with keys of this type, accepting up to Integer.MAX_VALUE entries. Use mapValue(Type, int) when the size has a strict upper bound.

Type Parameters:

V - the value type

Parameters:

valueType - the type of the values

Returns:

the map type

list

default NetworkBuffer.Type<@Unmodifiable @UnknownNullability List<T>> list(int maxSize)

Creates a type for an unmodifiable list of this type, encoded as a NetworkBuffer.VAR_INT size followed by each element. Writing null encodes an empty list. Reading throws IllegalArgumentException when the size is negative or greater than maxSize.

Parameters:

maxSize - the largest size accepted when reading

Returns:

the list type

list

default NetworkBuffer.Type<@Unmodifiable @UnknownNullability List<T>> list()

Creates a type for an unmodifiable list of this type, accepting up to Integer.MAX_VALUE elements. Use list(int) when the size has a strict upper bound.

Returns:

the list type

set

default NetworkBuffer.Type<@Unmodifiable @UnknownNullability Set<T>> set(int maxSize)

Creates a type for an unmodifiable set of this type, encoded as a NetworkBuffer.VAR_INT size followed by each element. Writing null encodes an empty set. Reading throws IllegalArgumentException when the size is negative or greater than maxSize, or an element repeats.

Parameters:

maxSize - the largest size accepted when reading

Returns:

the set type

set

default NetworkBuffer.Type<@Unmodifiable @UnknownNullability Set<T>> set()

Creates a type for an unmodifiable set of this type, accepting up to Integer.MAX_VALUE elements. Use set(int) when the size has a strict upper bound.

Returns:

the set type

optional

default NetworkBuffer.Type<@Nullable T> optional()

Creates a type that also accepts null, encoded as a NetworkBuffer.BOOLEAN that is true when a value of this type follows.

Returns:

the optional type

unionType

default <R extends @UnknownNullability Object>
NetworkBuffer.Type<R> unionType(Function<? super T, NetworkBuffer.Type<? extends R>> serializers,
 Function<? super R, ? extends T> keyFunc)

Creates a type for the subtypes of R, such as the permitted types of a sealed interface. Each value is encoded as its key in this type, followed by the value in the serializer for that key. Reading and writing throw UnsupportedOperationException when serializers returns null.

Type Parameters:

R - the union type

Parameters:

serializers - the serializer for the values of each key

keyFunc - the key of a value

Returns:

the union type

lengthPrefixed

default NetworkBuffer.Type<T> lengthPrefixed(int maxLength)

Creates a type that encodes each value as a NetworkBuffer.BYTE_ARRAY, which is a NetworkBuffer.VAR_INT length followed by the bytes of the value. Reading throws IllegalArgumentException when the length is greater than maxLength or the readable bytes, or the value does not use exactly that many bytes.

Parameters:

maxLength - the largest length accepted when reading

Returns:

the length prefixed type

maxLength

default NetworkBuffer.Type<T> maxLength(long maxLength)

Creates a type that encodes values the same way as this type, but rejects values longer than maxLength bytes. Both throw IllegalArgumentException for a value that is too long.

Parameters:

maxLength - the largest encoded size in bytes

Returns:

the length limited type