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

Class ConfigType<R,S,T extends SerializableType<S>>

java.lang.Object

io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.derived.ConfigType<R,S,T>

Type Parameters:

R - the runtime type used by the client application

S - the serialized type used by config trees and serializers

T - the representation of the serialized type

Direct Known Subclasses:

BooleanConfigType, EnumConfigType, ListConfigType, MapConfigType, NumberConfigType, RecordConfigType, StringConfigType

public abstract class ConfigType<R,S,T extends SerializableType<S>>
extends Object

A ConfigType contains serializable information describing a data type as well as the information necessary to convert a serialized value of that type to a friendlier runtime type.

See Also:

SerializableType, BooleanConfigType, EnumConfigType, ListConfigType, MapConfigType, NumberConfigType, RecordConfigType, StringConfigType

Field Summary

Fields

Modifier and Type	Field and Description
protected Function<S,R>	deserializer
protected Function<R,S>	serializer

Method Summary

Modifier and Type	Method and Description
abstract ConfigType<R,S,T>	constrain(ConstraintAnnotationProcessor<Annotation> processor, Annotation annotation, AnnotatedElement annotated) Applies the constraints defined by the given constraint annotation.
abstract <U> ConfigType<U,S,T>	derive(Class<? super U> runtimeType, Function<R,U> partialDeserializer, Function<U,R> partialSerializer) Derive a ConfigType from this type object.
Class<R>	getRuntimeType() The runtime type of values.
T	getSerializedType() The underlying serialized type of values.
S	toPlatformType(R runtimeValue) Converts directly a runtime value from a client application to an equivalent value in the serializable platform type.
R	toRuntimeType(S serializedValue) Converts a serialized value to this ConfigType's runtime type.
S	toSerializedType(R runtimeValue) Converts a runtime value from a client application to this ConfigType's serialized type.
String	toString()
abstract ConfigType<R,S,T>	withType(T newSpec) Replace the current serialized type used for specification with the given serialized type.

Methods inherited from class java.lang.Object

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

Field Detail

deserializer

protected final Function<S,R> deserializer

serializer

protected final Function<R,S> serializer

Method Detail

derive

public abstract <U> ConfigType<U,S,T> derive(Class<? super U> runtimeType,
                                             Function<R,U> partialDeserializer,
                                             Function<U,R> partialSerializer)

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)).

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 abstract ConfigType<R,S,T> withType(T newSpec)

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.

Parameters:

newSpec - The new type specification.

Returns:

A ConfigType with the new type specification.

See Also:

SerializableType.isAssignableFrom(SerializableType)

toSerializedType

public S toSerializedType(R runtimeValue)
                   throws FiberConversionException

Converts a runtime value from a client application to this ConfigType's serialized type.

Parameters:

runtimeValue - the value to convert to serializable form

Returns:

a serializable equivalent of the runtime value

Throws:

FiberConversionException - if the value does not fit this converter's constraint

See Also:

SerializableType.accepts(Object), toPlatformType(Object)

toPlatformType

public S toPlatformType(R runtimeValue)

Converts directly a runtime value from a client application to an equivalent value in the serializable platform type. This method gives no guarantees regarding the conformance of the returned value to the serialized type's constraints.

Parameters:

runtimeValue - the value to convert to serializable form

Returns:

an unchecked serializable equivalent of the runtime value

See Also:

SerializableType.getGenericPlatformType(), toSerializedType(Object)

toRuntimeType

public R toRuntimeType(S serializedValue)
                throws FiberConversionException

Converts a serialized value to this ConfigType's runtime type.

Parameters:

serializedValue - the value to convert to runtime form

Returns:

a runtime equivalent of the serialized value

Throws:

FiberConversionException - if the serialized value does not fit this converter's constraints

getRuntimeType

public Class<R> getRuntimeType()

The runtime type of values.

getSerializedType

public T getSerializedType()

The underlying serialized type of values.

toString

public String toString()

Overrides:

toString in class Object

constrain

public abstract ConfigType<R,S,T> constrain(ConstraintAnnotationProcessor<Annotation> processor,
                                            Annotation annotation,
                                            AnnotatedElement annotated)

Applies the constraints defined by the given constraint annotation.

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.