com.mojang.serialization

Interface Encoder<A>

Type Parameters:

A - The type this Encoder serializes.

All Known Subinterfaces:

Codec<A>, PrimitiveCodec<A>

All Known Implementing Classes:

CompoundListCodec, EitherCodec, ListCodec, MapCodec.MapCodecCodec, PairCodec, UnboundedMapCodec

public interface Encoder<A>

Serializes (encodes) objects of a given type to a serialized form.

An Encoder is used to transform objects of a specific type to some serialized representation using a supplied DynamicOps. Encoders encapsulate the serialization routine for a specific type, regardless of the desired serialization form.

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

Implementation Note:

The default methods in this interface that return encoders or map 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:

Decoder, Codec

Method Summary

Modifier and Type	Method and Description
default <B> Encoder<B>	comap((? super B) -> ? extends A function) Transforms this encoder to operate on a different type using the given mapping function.
static <A> MapEncoder<A>	empty() A MapEncoder that performs no serialization.
<T> DataResult<T>	encode(A input, DynamicOps<T> ops, T prefix) Encodes an object into the specified serialized data.
default <T> DataResult<T>	encodeStart(DynamicOps<T> ops, A input) Encodes an object.
static <A> Encoder<A>	error(String error) An Encoder that performs no serialization.
default MapEncoder<A>	fieldOf(String name) Returns a MapEncoder that encodes objects in a record under a field with the given name.
default <B> Encoder<B>	flatComap((? super B) -> ? extends DataResult<? extends A> function) Transforms this encoder to operate on a different type using the given DataResult-producing mapping function.
default Encoder<A>	withLifecycle(Lifecycle lifecycle) Sets the Lifecycle for the serialized data this encoder produces.

Method Detail

encode

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

Encodes an object into the specified serialized data. If encoding fails, returns an error DataResult.

Type Parameters:

T - The type of the serialized form.

Parameters:

input - The object to serialize.

ops - The DynamicOps instance defining the serialized form.

prefix - The existing serialized data to append to.

Returns:

A DataResult wrapping the serialized form of input, appended to prefix.

encodeStart

default <T> DataResult<T> encodeStart(DynamicOps<T> ops,
                                      A input)

Encodes an object. If encoding fails, returns an error DataResult.

For merging the input into existing serialized data, use encode(Object, DynamicOps, Object).

Implementation Requirements:

The default implementation is equivalent to encode(input, ops, ops.empty()).

Type Parameters:

T - The type of the serialized form.

Parameters:

input - The object to serialize.

ops - The DynamicOps instance defining the serialized form.

Returns:

A DataResult wrapping the serialized form of input.

See Also:

encode(Object, DynamicOps, Object)

fieldOf

default MapEncoder<A> fieldOf(String name)

Returns a MapEncoder that encodes objects in a record under a field with the given name. The returned MapEncoder may be used in conjunction with a RecordBuilder to serialize many different fields, all using different encoders, to a single record.

Implementation Requirements:

The default implementation returns a FieldEncoder wrapping this encoder.

Parameters:

name - The field to encode objects into.

Returns:

A MapEncoder that performs the same encoding as this encoder, but places the serialized value in a record under the given field.

See Also:

RecordBuilder

comap

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

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

API Note:

This method implements a contravariant map for Encoder.

Implementation Requirements:

The default implementation returns another Encoder that wraps this encoder.

Type Parameters:

B - The new type of the encoder.

Parameters:

function - A function transforming the new type to the old type.

Returns:

An encoder that operates on the type B.

See Also:

Covariance and Contravariance in Subtyping

flatComap

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

Transforms this encoder to operate on a different type using the given DataResult-producing mapping function.

API Note:

This method implements a contravariant flat map for Encoder.

Implementation Requirements:

The default implementation returns another Encoder that wraps this encoder.

Type Parameters:

B - The new type of the encoder.

Parameters:

function - A function transforming the new type to the old type. Errors from this encoder and from the function are merged.

Returns:

An encoder that operates on the type B.

See Also:

comap(Function)

withLifecycle

default Encoder<A> withLifecycle(Lifecycle lifecycle)

Sets the Lifecycle for the serialized data this encoder produces.

Implementation Requirements:

The default implementation returns another Encoder that wraps this encoder.

Parameters:

lifecycle - the lifecycle to use.

Returns:

An encoder equivalent to this encoder but with the given lifecycle.

See Also:

Lifecycle

empty

static <A> MapEncoder<A> empty()

A MapEncoder that performs no serialization. Its encoding method returns the prefix unchanged and it has an empty key stream.

Type Parameters:

A - The type the returned MapEncoder operates on.

Returns:

A MapEncoder that performs no serialization.

error

static <A> Encoder<A> error(String error)

An Encoder that performs no serialization. Its encoding method always returns the given error.

Type Parameters:

A - The type the returned encoder operates on.

Parameters:

error - The error the returned encoder should produce.

Returns:

An Encoder that performs no serialization.