com.mojang.serialization

Interface MapEncoder<A>

Type Parameters:

A - The type that this MapEncoder serializes.

All Superinterfaces:

Keyable

All Known Implementing Classes:

EitherMapCodec, FieldEncoder, KeyDispatchCodec, MapCodec, MapEncoder.Implementation, OptionalFieldCodec, PairMapCodec, SimpleMapCodec

public interface MapEncoder<A>
extends Keyable

Serializes (encodes) a fixed set of record fields to a serialized form.

A MapEncoder is a specialization of a Encoder that operates on some defined set of record keys. While a MapEncoder does not implement Encoder, any MapEncoder may be turned into a Encoder by calling the encoder() method.

Implementations of MapEncoder are immutable once created. The methods defined in this interface never mutate the decoder in a way visible to the outside.

Implementation Note:

The default methods in this interface that return map encoders or encoders wrap this encoder without adding any debugging context. These methods should be overridden if deeply nested encoders are undesirable or additional debugging context is desired.

See Also:

Encoder, MapCodec

Nested Class Summary

Nested Classes

Modifier and Type	Interface and Description
static class	MapEncoder.Implementation<A> A class that implements both MapEncoder and Compressable.

Method Summary

Modifier and Type	Method and Description
default <B> MapEncoder<B>	comap((? super B) -> ? extends A function) Transforms this map encoder to operate on a different type using the given mapping function.
default <T> RecordBuilder<T>	compressedBuilder(DynamicOps<T> ops) Creates a new, empty RecordBuilder that accepts values of the given serialized type.
<T> KeyCompressor<T>	compressor(DynamicOps<T> ops) Returns the KeyCompressor this map encoder uses to associate valid record keys with indices.
<T> RecordBuilder<T>	encode(A input, DynamicOps<T> ops, RecordBuilder<T> prefix) Encodes the input into a set of record fields that are added to the given builder.
default Encoder<A>	encoder() Returns the Encoder that implements the operations defined in this MapEncoder.
default <B> MapEncoder<B>	flatComap((? super B) -> ? extends DataResult<? extends A> function) Transforms this map encoder to operate on a different type using the given partial mapping function.
static <T> RecordBuilder<T>	makeCompressedBuilder(DynamicOps<T> ops, KeyCompressor<T> compressor) Creates a RecordBuilder that serializes a fixed set of keys defined by the KeyCompressor.
default MapEncoder<A>	withLifecycle(Lifecycle lifecycle) Sets the Lifecycle of the results this map encoder serializes.

Methods inherited from interface com.mojang.serialization.Keyable

forStrings, keys

Method Detail

encode

<T> RecordBuilder<T> encode(A input,
                            DynamicOps<T> ops,
                            RecordBuilder<T> prefix)

Encodes the input into a set of record fields that are added to the given builder. If a record field cannot be serialized, it is not added to the builder.

Type Parameters:

T - The type of the serialized form.

Parameters:

input - The value to serialize.

ops - The DynamicOps instance defining the serialized form.

prefix - A RecordBuilder to add the serialized fields to.

Returns:

The builder, with the serialized fields added.

compressedBuilder

default <T> RecordBuilder<T> compressedBuilder(DynamicOps<T> ops)

Creates a new, empty RecordBuilder that accepts values of the given serialized type. The returned builder will used compressed keys if and only if the serialized type uses compressed keys.

Implementation Requirements:

The default implementation returns makeCompressedBuilder(DynamicOps, KeyCompressor) if the given DynamicOps prefers compressed keys, and returns DynamicOps.mapBuilder() otherwise.

Type Parameters:

T - The type of the serialized form.

Parameters:

ops - The DynamicOps instance defining the serialized form.

Returns:

An empty RecordBuilder.

See Also:

DynamicOps.compressMaps()

compressor

<T> KeyCompressor<T> compressor(DynamicOps<T> ops)

Returns the KeyCompressor this map encoder uses to associate valid record keys with indices.

Type Parameters:

T - The type of the serialized form.

Parameters:

ops - The DynamicOps instance defining the serialized form.

Returns:

The KeyCompressor for this map encoder.

comap

default <B> MapEncoder<B> comap((? super B) -> ? extends A function)

Transforms this map encoder to operate on a different type using the given mapping function.

Implementation Requirements:

The default implementation returns a MapEncoder.Implementation that wraps this map encoder.

Type Parameters:

B - The new type.

Parameters:

function - A function from the new type to the current type.

Returns:

A map encoder that first transforms the input using the mapping function, then encodes the result using this map encoder.

flatComap

default <B> MapEncoder<B> flatComap((? super B) -> ? extends DataResult<? extends A> function)

Transforms this map encoder to operate on a different type using the given partial mapping function. Any errors the mapping function returns prevent further serialization.

Implementation Requirements:

The default implementation returns a MapEncoder.Implementation that wraps this map encoder.

Type Parameters:

B - The new type.

Parameters:

function - A function from the new type to the current type.

Returns:

A map encoder that first transforms the input using the mapping function, then encodes the result using this map encoder.

encoder

default Encoder<A> encoder()

Returns the Encoder that implements the operations defined in this MapEncoder.

Implementation Note:

The default implementation returns a Encoder that implements the Encoder.encode(Object, DynamicOps, Object) method to call encode(Object, DynamicOps, RecordBuilder).

withLifecycle

default MapEncoder<A> withLifecycle(Lifecycle lifecycle)

Sets the Lifecycle of the results this map encoder serializes.

Implementation Requirements:

The default implementation returns a MapEncoder.Implementation that wraps this map decoder.

Parameters:

lifecycle - The lifecycle to use.

Returns:

A map encoder equivalent to this map encoder, but using the given lifecycle for the serialized results.

makeCompressedBuilder

static <T> RecordBuilder<T> makeCompressedBuilder(DynamicOps<T> ops,
                                                  KeyCompressor<T> compressor)

Creates a RecordBuilder that serializes a fixed set of keys defined by the KeyCompressor.

Type Parameters:

T - The type of the serialized form.

Parameters:

ops - The DynamicOps instance defining the serialized form.

compressor - A KeyCompressor the returned builder uses to compress valid keys.

Returns:

A RecordBuilder that uses the given compressor to serialize compressed keys.