Class RecordCodec<T>

java.lang.Object

com.hypixel.hytale.codec.record.RecordCodec<T>

Type Parameters:

T - the type this codec can encode and decode.

All Implemented Interfaces:

Codec<T>, RawJsonCodec<T>, SchemaConvertable<T>, ValidatableCodec<T>

public final class RecordCodec<T>
extends Object
implements Codec<T>, ValidatableCodec<T>

A Codec for immutable types such as record classes.

Unlike BuilderCodec, this codec never mutates the target instance. Each field is decoded into a constructor argument array in the order the fields were appended, then the type is built once by invoking the supplied constructor. The same fields are read back through their accessors when encoding.

Build one with builder(Class); each append refines the builder type so the final build is checked against the constructor, for example .build(Point::new). Append order must match the constructor parameter order. Pass a Validator to append to attach a single field validator, or a RecordField.Options consumer for multiple validators, documentation, or metadata. Records with more than eight components continue with RecordCodec.RawBuilder and finish with RecordCodec.AbstractBuilder.buildRaw(Function).

Nested Class Summary

Nested Classes

Modifier and Type	Class	Description
static class	RecordCodec.AbstractBuilder<T>	A step in the typed builder chain for a RecordCodec.
static final class	RecordCodec.Builder0<T>
static final class	RecordCodec.Builder1<T,A>
static final class	RecordCodec.Builder2<T,A,B>
static final class	RecordCodec.Builder3<T,A,B,C>
static final class	RecordCodec.Builder4<T,A,B,C,D>
static final class	RecordCodec.Builder5<T,A,B,C,D,E>
static final class	RecordCodec.Builder6<T,A,B,C,D,E,F>
static final class	RecordCodec.Builder7<T,A,B,C,D,E,F,G>
static final class	RecordCodec.Builder8<T,A,B,C,D,E,F,G,H>
static final class	RecordCodec.RawBuilder<T>	The untyped tail of the builder chain, used once a record has more components than the typed Builder0 through Builder8 steps cover.

Field Summary

Fields inherited from interface Codec

BASE64_PATTERN, BOOLEAN, BSON_DOCUMENT, BYTE, BYTE_ARRAY, DOUBLE, DOUBLE_ARRAY, DURATION, DURATION_SECONDS, FLOAT, FLOAT_ARRAY, INSTANT, INT_ARRAY, INTEGER, LOG_LEVEL, LONG, LONG_ARRAY, NULLABLE_BOOLEAN, PATH, SHORT, STRING, STRING_ARRAY, UUID_BINARY, UUID_STRING

Method Summary

Modifier and Type	Method	Description
static <T> RecordCodec.Builder0<T>	builder(Class<T> type)	Creates a typed builder for a RecordCodec.
T	decode(org.bson.BsonValue bsonValue, ExtraInfo extraInfo)
T	decodeJson(RawJsonReader reader, ExtraInfo extraInfo)
org.bson.BsonDocument	encode(T t, ExtraInfo extraInfo)
String	getDocumentation()
Class<T>	getType()
static <T> RecordCodec.RawBuilder<T>	rawBuilder(Class<T> type)	Starts an untyped builder for records with more components than the typed chain supports.
Schema	toSchema(SchemaContext context)	Returns a schema object that represents this codec as JSON Schema.
String	toString()
void	validate(T t, ExtraInfo extraInfo)
void	validateDefaults(ExtraInfo extraInfo, Set<Codec<?>> tested)

Methods inherited from class Object

equals, getClass, hashCode, notify, notifyAll, wait, wait, wait

Methods inherited from interface Codec

decode, encode

Methods inherited from interface RawJsonCodec

decodeJson

Methods inherited from interface SchemaConvertable

toSchema

Method Details

getType

@Nonnull
public Class<T> getType()

getDocumentation

@Nonnull
public String getDocumentation()

decode

public T decode(@Nonnull
 org.bson.BsonValue bsonValue,
 @Nonnull
 ExtraInfo extraInfo)

Specified by:

decode in interface Codec<T>

encode

@Nonnull
public org.bson.BsonDocument encode(T t,
 @Nonnull
 ExtraInfo extraInfo)

Specified by:

encode in interface Codec<T>

decodeJson

public T decodeJson(@Nonnull
 RawJsonReader reader,
 @Nonnull
 ExtraInfo extraInfo)
             throws IOException

Specified by:

decodeJson in interface Codec<T>

Specified by:

decodeJson in interface RawJsonCodec<T>

Throws:

IOException

validate

public void validate(T t,
 @Nonnull
 ExtraInfo extraInfo)

Specified by:

validate in interface ValidatableCodec<T>

validateDefaults

public void validateDefaults(@Nonnull
 ExtraInfo extraInfo,
 @Nonnull
 Set<Codec<?>> tested)

Specified by:

validateDefaults in interface ValidatableCodec<T>

toSchema

@Nonnull
public Schema toSchema(@Nonnull
 SchemaContext context)

Description copied from interface: SchemaConvertable

Returns a schema object that represents this codec as JSON Schema.

Specified by:

toSchema in interface SchemaConvertable<T>

Parameters:

context - A context to use to assist with creating the schema.

Returns:

the generated schema.

toString

@Nonnull
public String toString()

Overrides:

toString in class Object

builder

@Nonnull
public static <T> RecordCodec.Builder0<T> builder(@Nonnull
 Class<T> type)

Creates a typed builder for a RecordCodec. Append fields with RecordCodec.Builder0.append(KeyedCodec, Function) in constructor parameter order, then finish with the matching build overload (for example .build(Point::new)). For records with more than eight components, use rawBuilder(Class).

Parameters:

type - the class of the record type.

Returns:

a fresh builder with no fields appended yet.

rawBuilder

@Nonnull
public static <T> RecordCodec.RawBuilder<T> rawBuilder(@Nonnull
 Class<T> type)

Starts an untyped builder for records with more components than the typed chain supports. Finish with RecordCodec.AbstractBuilder.buildRaw(Function). Prefer builder(Class) for records with eight or fewer components to keep compile-time constructor arity checking.

Parameters:

type - the class of the record type.

Returns:

a fresh untyped builder with no fields appended yet.