io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.derived

Class RecordConfigType<R>

java.lang.Object

io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.derived.ConfigType<R,Map<String,Object>,RecordSerializableType>

io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.derived.RecordConfigType<R>

Type Parameters:

R - The runtime type of the underlying ConfigBranch value.

public final class RecordConfigType<R>
extends ConfigType<R,Map<String,Object>,RecordSerializableType>

A ConfigType for fixed heterogeneous records. This is typically used to store POJOs or tuples, but may be used for any parametric serialized form.

Field Summary

Fields inherited from class io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.derived.ConfigType

deserializer, serializer

Constructor Summary

Constructors

Constructor and Description
RecordConfigType(RecordSerializableType serializedType, Class<? super R> runtimeType, Function<Map<String,Object>,R> f, Function<R,Map<String,Object>> f0)

Method Summary

Modifier and Type	Method and Description
RecordConfigType<R>	constrain(ConstraintAnnotationProcessor<Annotation> processor, Annotation annotation, AnnotatedElement annotated) Applies the constraints defined by the given constraint annotation.
<U> RecordConfigType<U>	derive(Class<? super U> runtimeType, Function<R,U> partialDeserializer, Function<U,R> partialSerializer) Derive a ConfigType from this type object.
String	toString()
RecordConfigType<R>	withType(RecordSerializableType newSpec) Replace the current serialized type used for specification with the given serialized type.

Methods inherited from class io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.derived.ConfigType

getRuntimeType, getSerializedType, toPlatformType, toRuntimeType, toSerializedType

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordConfigType

public RecordConfigType(RecordSerializableType serializedType,
                        Class<? super R> runtimeType,
                        Function<Map<String,Object>,R> f,
                        Function<R,Map<String,Object>> f0)

Method Detail

derive

public <U> RecordConfigType<U> derive(Class<? super U> runtimeType,
                                      Function<R,U> partialDeserializer,
                                      Function<U,R> partialSerializer)

Description copied from class: ConfigType

Derive a ConfigType from this type object.

The new ConfigType will have the same serialized type (with the same constraints), but a different runtime type. Values will be converted between the two types using composed functions: toSerializedType(x) = this.toSerializedType(partialSerializer(x)) and toRuntimeType(y) = partialDeserializer(this.toRuntimeType(y)).

Specified by:

derive in class ConfigType<R,Map<String,Object>,RecordSerializableType>

Type Parameters:

U - the runtime type of the new ConfigType

Parameters:

runtimeType - a class object representing the runtime type of the new ConfigType

partialDeserializer - a partial deserialization function

partialSerializer - a partial serialization function

Returns:

a derived ConfigType with the given runtimeType

withType

public RecordConfigType<R> withType(RecordSerializableType newSpec)

Description copied from class: ConfigType

Replace the current serialized type used for specification with the given serialized type. The given serialized type must be the same or more constrained than the current serialized type.

Specified by:

withType in class ConfigType<R,Map<String,Object>,RecordSerializableType>

Parameters:

newSpec - The new type specification.

Returns:

A ConfigType with the new type specification.

See Also:

SerializableType.isAssignableFrom(SerializableType)

constrain

public RecordConfigType<R> constrain(ConstraintAnnotationProcessor<Annotation> processor,
                                     Annotation annotation,
                                     AnnotatedElement annotated)

Description copied from class: ConfigType

Applies the constraints defined by the given constraint annotation.

Specified by:

constrain in class ConfigType<R,Map<String,Object>,RecordSerializableType>

Parameters:

processor - The processor for constraints of this type.

annotation - The annotation from which to extract constraints.

annotated - The annotated element. For example, a field in a POJO.

Returns:

a ConfigType representing this type, but constrained by the given constraint annotation.

toString

public String toString()

Overrides:

toString in class ConfigType<R,Map<String,Object>,RecordSerializableType>