com.mojang.serialization.codecs

Class RecordCodecBuilder<O,F>

java.lang.Object

com.mojang.serialization.codecs.RecordCodecBuilder<O,F>

Type Parameters:

O - The type of the complete object.

F - The type of the field or collection of fields handled by this builder.

All Implemented Interfaces:

RecordCodecBuilder<O,F>

public final class RecordCodecBuilder<O,F>
extends Object

An class that enables the aggregation of many map codecs into a single codec for some complete type. This allows for building a single codec out of the codecs for many independent fields.

Typically, RecordCodecBuilder is used to create a codec for a record like the following.

 public class SomeRecord {
     private int intValue;
     private String stringValue;
     private List<String> stringValues;

     public SomeRecord(int i, String s, List<String> ls) {
         this.intValue = i;
         this.stringValue = s;
         this.stringValues = ls;
     }

     // methods elided
 }

A codec for this type may be created like so.

 public static final Codec<SomeRecord> CODEC = RecordCodecBuilder.create(inst -> inst.group(
     Codec.INT.fieldOf("IntValue").forGetter(r -> r.intValue),
     Codec.STRING.fieldOf("StringValue").forGetter(r -> r.stringValue),
     Codec.STRING.listOf().fieldOf("StringValues").forGetter(r -> r.stringValues)
 ).apply(inst, SomeRecord::new));

Each independent record field is added to the builder using Codec.fieldOf(String) (which specifies which field in the record the codec is for) and MapCodec.forGetter(Function) (which specifies how to get the field value out of the record). These record field codecs are then aggregated and a combining function (typically a constructor or factory method) combines the fields into an instance of the complete record.

Note that the "record" in RecordCodecBuilder does not refer to the Java concept of a record, but rather to any object that can be logically serialized as a set of fields.

See Also:

create(Function), RecordCodecBuilder.Instance, Products, Codec.fieldOf(String), MapCodec.forGetter(Function)

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
static class	RecordCodecBuilder.Instance<O> The Applicative instance for RecordCodecBuilder.
static class	RecordCodecBuilder.Mu<O> The witness type of a RecordCodecBuilder.

Method Summary

Modifier and Type	Method and Description
static <O> MapCodec<O>	build(RecordCodecBuilder<O,O> builderBox) Builds a MapCodec that operates on the fields defined using the given RecordCodecBuilder.
static <O> Codec<O>	create((instance RecordCodecBuilder<O,_>) -> ? extends RecordCodecBuilder<O,O> builder) Creates a Codec using the fields provided via the given function.
<E> RecordCodecBuilder<O,E>	dependent((O) -> E getter, MapEncoder<E> encoder, (? super F) -> ? extends MapDecoder<E> decoderGetter)
static <O,F> RecordCodecBuilder<O,F>	deprecated(F instance, int since) Creates a builder for a deprecated singleton value.
static <O> instance RecordCodecBuilder<O,_>	instance() Returns the applicative type class instance for RecordCodecBuilder.
static <O> MapCodec<O>	mapCodec((instance RecordCodecBuilder<O,_>) -> ? extends RecordCodecBuilder<O,O> builder) Creates a MapCodec using the fields provided via the given function.
static <O,F> RecordCodecBuilder<O,F>	of((O) -> F getter, MapCodec<F> codec) Creates a builder for a field or collection of fields in some object, given a map codec for the fields.
static <O,F> RecordCodecBuilder<O,F>	of((O) -> F getter, String name, Codec<F> fieldCodec) Creates a builder for a single field in some object, given a field name and a Codec for that field.
static <O,F> RecordCodecBuilder<O,F>	point(F instance) Creates a builder for an experimental singleton field value.
static <O,F> RecordCodecBuilder<O,F>	point(F instance, Lifecycle lifecycle) Creates a builder for a singleton value with the given lifecycle.
static <O,F> RecordCodecBuilder<O,F>	stable(F instance) Creates a builder for a stable singleton value.
static <O,F> RecordCodecBuilder<O,F>	unbox(RecordCodecBuilder<O,F> box) Thunk method that casts an applied RecordCodecBuilder.Mu to a RecordCodecBuilder.

Methods inherited from class java.lang.Object

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

Method Detail

unbox

public static <O,F> RecordCodecBuilder<O,F> unbox(RecordCodecBuilder<O,F> box)

Thunk method that casts an applied RecordCodecBuilder.Mu to a RecordCodecBuilder.

Type Parameters:

O - The type of the complete object.

F - The type of the field or collection of fields handled by the builder.

Parameters:

box - The boxed builder.

Returns:

The unboxed builder.

instance

public static <O> instance RecordCodecBuilder<O,_> instance()

Returns the applicative type class instance for RecordCodecBuilder.

Type Parameters:

O - The type of the complete object.

Returns:

The applicative type class instance for RecordCodecBuilder.

See Also:

Applicative

of

public static <O,F> RecordCodecBuilder<O,F> of((O) -> F getter,
                                               String name,
                                               Codec<F> fieldCodec)

Creates a builder for a single field in some object, given a field name and a Codec for that field.

Type Parameters:

O - The type of the complete object.

F - The type of the field.

Parameters:

getter - A function that extracts the value of the field from a complete object.

name - The name the field is serialized under.

fieldCodec - A Codec for the field.

Returns:

A builder for a single field in some object.

of

public static <O,F> RecordCodecBuilder<O,F> of((O) -> F getter,
                                               MapCodec<F> codec)

Creates a builder for a field or collection of fields in some object, given a map codec for the fields.

Type Parameters:

O - The type of the complete object.

F - The type of the field or collection of fields.

Parameters:

getter - A function that extracts the fields from a complete object.

codec - A MapCodec for the fields.

Returns:

A builder for the fields.

point

public static <O,F> RecordCodecBuilder<O,F> point(F instance)

Creates a builder for an experimental singleton field value. This is equivalent to point(Object, Lifecycle) invoked with Lifecycle.experimental().

Type Parameters:

O - The type of the complete object.

F - The type of the field.

Parameters:

instance - The singleton value.

Returns:

A builder for a singleton field value.

See Also:

Codec.unit(Object)

stable

public static <O,F> RecordCodecBuilder<O,F> stable(F instance)

Creates a builder for a stable singleton value. This method is equivalent to point(Object, Lifecycle) invoked with Lifecycle.stable().

Type Parameters:

O - The type of the complete object.

F - The type of the field.

Parameters:

instance - The singleton value.

Returns:

A builder for the singleton field value.

deprecated

public static <O,F> RecordCodecBuilder<O,F> deprecated(F instance,
                                                       int since)

Creates a builder for a deprecated singleton value. This method is equivalent to point(Object, Lifecycle) invoked with Lifecycle.deprecated(int).

Type Parameters:

O - The type of the complete object.

F - The type of the field.

Parameters:

instance - The singleton value.

since - The deprecation version.

Returns:

A builder for the singleton field value.

point

public static <O,F> RecordCodecBuilder<O,F> point(F instance,
                                                  Lifecycle lifecycle)

Creates a builder for a singleton value with the given lifecycle.

Type Parameters:

O - The type of the complete object.

F - The type of the field.

Parameters:

instance - The singleton value.

lifecycle - The lifecycle of the given field value.

Returns:

A builder for the singleton field value.

create

public static <O> Codec<O> create((instance RecordCodecBuilder<O,_>) -> ? extends RecordCodecBuilder<O,O> builder)

Creates a Codec using the fields provided via the given function. The builder function is expected to create a RecordCodecBuilder for a complete object with some set of fields.

Type Parameters:

O - The type of the complete object.

Parameters:

builder - A function that produces a builder for some set of fields.

Returns:

A Codec for the complete object type.

See Also:

RecordCodecBuilder

mapCodec

public static <O> MapCodec<O> mapCodec((instance RecordCodecBuilder<O,_>) -> ? extends RecordCodecBuilder<O,O> builder)

Creates a MapCodec using the fields provided via the given function. The builder function is expected to create a RecordCodecBuilder for a complete object with some set of fields.

Type Parameters:

O - The type of the complete object.

Parameters:

builder - A function that produces a builder for some set of fields.

Returns:

A Codec for the complete object type.

See Also:

create(Function)

dependent

public <E> RecordCodecBuilder<O,E> dependent((O) -> E getter,
                                             MapEncoder<E> encoder,
                                             (? super F) -> ? extends MapDecoder<E> decoderGetter)

build

public static <O> MapCodec<O> build(RecordCodecBuilder<O,O> builderBox)

Builds a MapCodec that operates on the fields defined using the given RecordCodecBuilder.

Type Parameters:

O - The type of the complete object.

Parameters:

builderBox - The builder.

Returns:

A MapCodec created from the given builder.