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

Class MapConfigType<R,V>

java.lang.Object

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

io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.derived.MapConfigType<R,V>

Type Parameters:

R - The runtime type of the underlying Map value.

V - The value type stored in the underlying Map value.

public final class MapConfigType<R,V>
extends ConfigType<R,Map<String,V>,MapSerializableType<V>>

A ConfigType for mappings between a key type and a value type.

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
MapConfigType(MapSerializableType<V> serializedType, Class<? super R> runtimeType, Function<Map<String,V>,R> f, Function<R,Map<String,V>> f0)

Method Summary

Modifier and Type	Method and Description
MapConfigType<R,V>	constrain(ConstraintAnnotationProcessor<Annotation> processor, Annotation annotation, AnnotatedElement annotated) Applies the constraints defined by the given constraint annotation.
<U> MapConfigType<U,V>	derive(Class<? super U> runtimeType, Function<R,U> partialDeserializer, Function<U,R> partialSerializer) Derive a ConfigType from this type object.
MapConfigType<R,V>	withMaxSize(int max) Creates a new MapConfigType with a maximum size constraint.
MapConfigType<R,V>	withMinSize(int min) Creates a new MapConfigType with a minimum size constraint.
MapConfigType<R,V>	withType(MapSerializableType<V> 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, toString

Methods inherited from class java.lang.Object

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

Constructor Detail

MapConfigType

public MapConfigType(MapSerializableType<V> serializedType,
                     Class<? super R> runtimeType,
                     Function<Map<String,V>,R> f,
                     Function<R,Map<String,V>> f0)

Method Detail

derive

public <U> MapConfigType<U,V> 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,V>,MapSerializableType<V>>

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 MapConfigType<R,V> withType(MapSerializableType<V> 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,V>,MapSerializableType<V>>

Parameters:

newSpec - The new type specification.

Returns:

A ConfigType with the new type specification.

See Also:

SerializableType.isAssignableFrom(SerializableType)

withMinSize

public MapConfigType<R,V> withMinSize(int min)

Creates a new MapConfigType with a minimum size constraint.

withMaxSize

public MapConfigType<R,V> withMaxSize(int max)

Creates a new MapConfigType with a maximum size constraint.

constrain

public MapConfigType<R,V> 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,V>,MapSerializableType<V>>

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.