Package com.mojang.serialization

Class MapCodec<A>

java.lang.Object

com.mojang.serialization.CompressorHolder

com.mojang.serialization.MapCodec<A>

Type Parameters:

A - The type to convert

All Implemented Interfaces:

Compressable, Keyable, MapDecoder<A>, MapEncoder<A>

Direct Known Subclasses:

EitherMapCodec, KeyDispatchCodec, OptionalFieldCodec, PairMapCodec, SimpleMapCodec

public abstract class MapCodec<A>
extends CompressorHolder
implements MapDecoder<A>, MapEncoder<A>

A combined MapEncoder and MapDecoder which can convert objects to and from a series of fields. A MapCodec consists of a fixed set of optional fields, can read those fields from a MapLike object, and can write those fields to a RecordBuilder object. A MapCodec can be used to create a Codec by calling codec(); this codec will encode the map's fields to a map created by a DynamicOps instance. unless the ops have DynamicOps.compressMaps(), in which case the map will be encoded in a "compressed" map - in other words, as a list of values, where the index of the value in the list corresponds to the index of the (potentially optional) key in the stream returned by keys(DynamicOps). Codecs created by codec() are occasionally treated specially by other codec constructions.

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static final class	MapCodec.MapCodecCodec<A>	A Codec that encodes and decodes a MapCodec.
static interface	MapCodec.ResultFunction<A>

Nested classes/interfaces inherited from interface com.mojang.serialization.MapDecoder

MapDecoder.Implementation<A>

Nested classes/interfaces inherited from interface com.mojang.serialization.MapEncoder

MapEncoder.Implementation<A>

Constructor Summary

Constructors

Constructor	Description
MapCodec()

Method Summary

Modifier and Type	Method	Description
Codec<A>	codec()
<E> MapCodec<A>	dependent(MapCodec<E> initialInstance, Function<A,Pair<E,MapCodec<E>>> splitter, BiFunction<A,E,A> combiner)
MapCodec<A>	deprecated(int since)
MapCodec<A>	fieldOf(String name)
<S> MapCodec<S>	flatXmap(Function<? super A,? extends DataResult<? extends S>> to, Function<? super S,? extends DataResult<? extends A>> from)
final <O> RecordCodecBuilder<O,A>	forGetter(Function<O,A> getter)
abstract <T> Stream<T>	keys(DynamicOps<T> ops)	Returns a stream of keys this map codec may write or read.
MapCodec<A>	mapResult(MapCodec.ResultFunction<A> function)
static <A> MapCodec<A>	of(MapEncoder<A> encoder, MapDecoder<A> decoder)
static <A> MapCodec<A>	of(MapEncoder<A> encoder, MapDecoder<A> decoder, Supplier<String> name)
MapCodec<A>	orElse(A value)
MapCodec<A>	orElse(Consumer<String> onError, A value)
MapCodec<A>	orElse(UnaryOperator<String> onError, A value)
MapCodec<A>	orElseGet(Consumer<String> onError, Supplier<? extends A> value)
MapCodec<A>	orElseGet(Supplier<? extends A> value)
MapCodec<A>	orElseGet(UnaryOperator<String> onError, Supplier<? extends A> value)
MapCodec<A>	setPartial(Supplier<A> value)
MapCodec<A>	stable()
static <A> MapCodec<A>	unit(A defaultValue)
static <A> MapCodec<A>	unit(Supplier<A> defaultValue)
MapCodec<A>	withLifecycle(Lifecycle lifecycle)
<S> MapCodec<S>	xmap(Function<? super A,? extends S> to, Function<? super S,? extends A> from)

Methods inherited from class com.mojang.serialization.CompressorHolder

compressor

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Methods inherited from interface com.mojang.serialization.MapDecoder

ap, compressedDecode, compressor, decode, decoder, flatMap, map

Methods inherited from interface com.mojang.serialization.MapEncoder

comap, compressedBuilder, compressor, encode, encoder, flatComap

Constructor Details

MapCodec

public MapCodec()

Method Details

forGetter

public final <O> RecordCodecBuilder<O,A> forGetter(Function<O,A> getter)

of

public static <A> MapCodec<A> of(MapEncoder<A> encoder,
 MapDecoder<A> decoder)

of

public static <A> MapCodec<A> of(MapEncoder<A> encoder,
 MapDecoder<A> decoder,
 Supplier<String> name)

fieldOf

public MapCodec<A> fieldOf(String name)

withLifecycle

public MapCodec<A> withLifecycle(Lifecycle lifecycle)

Specified by:

withLifecycle in interface MapDecoder<A>

Specified by:

withLifecycle in interface MapEncoder<A>

codec

public Codec<A> codec()

stable

public MapCodec<A> stable()

deprecated

public MapCodec<A> deprecated(int since)

xmap

public <S> MapCodec<S> xmap(Function<? super A,? extends S> to,
 Function<? super S,? extends A> from)

flatXmap

public <S> MapCodec<S> flatXmap(Function<? super A,? extends DataResult<? extends S>> to,
 Function<? super S,? extends DataResult<? extends A>> from)

dependent

public <E> MapCodec<A> dependent(MapCodec<E> initialInstance,
 Function<A,Pair<E,MapCodec<E>>> splitter,
 BiFunction<A,E,A> combiner)

keys

public abstract <T> Stream<T> keys(DynamicOps<T> ops)

Returns a stream of keys this map codec may write or read. This stream should contain any key that may be written or read, even ones that are optional. The codec need not read or write all of these keys on any given occasion, but all keys that might be read or written should be included, as this stream is used to form the number-based indexing used with DynamicOps.compressMaps().

Note: if a map codec writes a key that is not returned by this method, it will not work correctly with a DynamicOps that has DynamicOps.compressMaps().

Specified by:

keys in interface Keyable

Type Parameters:

T - the data type to encode keys to or decode keys from

Parameters:

ops - the dynamic ops instance

Returns:

a stream of keys this map codec may write or read

mapResult

public MapCodec<A> mapResult(MapCodec.ResultFunction<A> function)

orElse

public MapCodec<A> orElse(Consumer<String> onError,
 A value)

orElse

public MapCodec<A> orElse(UnaryOperator<String> onError,
 A value)

orElseGet

public MapCodec<A> orElseGet(Consumer<String> onError,
 Supplier<? extends A> value)

orElseGet

public MapCodec<A> orElseGet(UnaryOperator<String> onError,
 Supplier<? extends A> value)

orElse

public MapCodec<A> orElse(A value)

orElseGet

public MapCodec<A> orElseGet(Supplier<? extends A> value)

setPartial

public MapCodec<A> setPartial(Supplier<A> value)

unit

public static <A> MapCodec<A> unit(A defaultValue)

unit

public static <A> MapCodec<A> unit(Supplier<A> defaultValue)