com.mojang.serialization

Interface MapDecoder<A>

Type Parameters:

A - The type that this MapDecoder deserializes.

All Superinterfaces:

Keyable

All Known Implementing Classes:

EitherMapCodec, FieldDecoder, KeyDispatchCodec, MapCodec, MapDecoder.Implementation, OptionalFieldCodec, PairMapCodec, SimpleMapCodec

public interface MapDecoder<A>
extends Keyable

Deserializes (decodes) a fixed set of record fields from a serialized form.

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

Implementations of MapDecoder 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 decoders or decoders wrap this decoder without adding any debugging context. These methods should be overridden if deeply nested decoders are undesirable or additional debugging context is desired.

See Also:

Decoder, MapCodec

Nested Class Summary

Nested Classes

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

Method Summary

Modifier and Type	Method and Description
default <E> MapDecoder<E>	ap(MapDecoder<(? super A) -> ? extends E> decoder) Applies a transformation decoded from the given map decoder to decoded values.
default <T> DataResult<A>	compressedDecode(DynamicOps<T> ops, T input) Decodes an object from the given serialized form.
<T> KeyCompressor<T>	compressor(DynamicOps<T> ops) Returns the KeyCompressor used to associate record keys with indices.
<T> DataResult<A>	decode(DynamicOps<T> ops, MapLike<T> input) Decodes an object from the given map of serialized entries.
default Decoder<A>	decoder() Returns a Decoder that implements the operations defined in this map decoder.
default <B> MapDecoder<B>	flatMap((? super A) -> ? extends DataResult<? extends B> function) Transforms this map decoder to operate on a different type using the given partial mapping function.
default <B> MapDecoder<B>	map((? super A) -> ? extends B function) Transforms this map decoder to operate on a different type using the given mapping function.
default MapDecoder<A>	withLifecycle(Lifecycle lifecycle) Sets the Lifecycle of the results this map decoder deserializes.

Methods inherited from interface com.mojang.serialization.Keyable

forStrings, keys

Method Detail

decode

<T> DataResult<A> decode(DynamicOps<T> ops,
                         MapLike<T> input)

Decodes an object from the given map of serialized entries. If decoding fails (for example, if a key is absent or has an incompatible value), returns an error DataResult.

Type Parameters:

T - The type of the serialized form.

Parameters:

ops - The DynamicOps instance defining the serialized form.

input - A map or maplike object containing the serialized entries.

Returns:

A DataResult containing the decoded object, or an error if no object could be decoded.

See Also:

compressedDecode(DynamicOps, Object)

compressedDecode

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

Decodes an object from the given serialized form. If the DynamicOps uses compressed keys, the input should also contain compressed keys. Likewise, if the DynamicOps does not use compressed keys, the input should also not contain compressed keys.

Implementation Requirements:

The default implementation determines whether the serialized keys are compressed. Then, it deserializes the input into a MapLike that is then passed to decode(DynamicOps, MapLike).

Type Parameters:

T - The type of the serialized form.

Parameters:

ops - The DynamicOps instance defining the serialized form.

input - The serialized value that contains the record data to deserialize.

Returns:

A DataResult containing the decoded object, or an error if no object could be decoded.

compressor

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

Returns the KeyCompressor used to associate 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 decoder.

decoder

default Decoder<A> decoder()

Returns a Decoder that implements the operations defined in this map decoder.

Implementation Note:

The default implementation returns a Decoder that implements the Decoder.decode(DynamicOps, Object) method to call decode(DynamicOps, MapLike).

flatMap

default <B> MapDecoder<B> flatMap((? super A) -> ? extends DataResult<? extends B> function)

Transforms this map decoder to operate on a different type using the given partial mapping function. Any errors the mapping function returns are merged with errors from deserialization.

Implementation Requirements:

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

Type Parameters:

B - The new type.

Parameters:

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

Returns:

A map decoder that decodes using this map decoder, then transforms the output using the mapping function.

map

default <B> MapDecoder<B> map((? super A) -> ? extends B function)

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

Implementation Requirements:

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

Type Parameters:

B - The new type.

Parameters:

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

Returns:

A map decoder that decodes using this map decoder, then transforms the output using the mapping function.

ap

default <E> MapDecoder<E> ap(MapDecoder<(? super A) -> ? extends E> decoder)

Applies a transformation decoded from the given map decoder to decoded values. Errors from the transformation decoder are merged with errors from this decoder.

API Note:

This method implements the applicative operator for MapDecoder.

Implementation Requirements:

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

Type Parameters:

E - The new type.

Parameters:

decoder - A decoder that deserializes mapping functions.

Returns:

A map decoder that deserializes a value, then applies a transformation deserialized from the given map decoder.

See Also:

map(Function), Applicative

withLifecycle

default MapDecoder<A> withLifecycle(Lifecycle lifecycle)

Sets the Lifecycle of the results this map decoder deserializes.

Implementation Requirements:

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

Parameters:

lifecycle - The lifecycle to use.

Returns:

A map decoder equivalent to this map decoder, but using the given lifecycle for the deserialized results.