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

Class EnumConfigType<T>

java.lang.Object

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

io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.derived.EnumConfigType<T>

Type Parameters:

T - The runtime type of the underlying finite string value.

public final class EnumConfigType<T>
extends ConfigType<T,String,EnumSerializableType>

A ConfigType for a finite set of values. These are often the constants of a Java enum, but are represented as strings here in order to support serialization and deserialization.

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
EnumConfigType(EnumSerializableType serializedType, Class<T> runtimeType, Function<String,T> f, Function<T,String> f0)

Method Summary

Modifier and Type	Method and Description
EnumConfigType<T>	constrain(ConstraintAnnotationProcessor<Annotation> processor, Annotation annotation, AnnotatedElement annotated) Applies the constraints defined by the given constraint annotation.
<U> EnumConfigType<U>	derive(Class<? super U> runtimeType, Function<T,U> partialDeserializer, Function<U,T> partialSerializer) Derive a ConfigType from this type object.
EnumConfigType<T>	withType(EnumSerializableType newSpec) Replace the current serialized type used for specification with the given serialized type.
EnumConfigType<T>	withValues(Set<? extends T> values) Returns a new EnumConfigType that represents the given set of values.
EnumConfigType<T>	withValues(T... values) Returns a new EnumConfigType that represents the given set of values.

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

EnumConfigType

public EnumConfigType(EnumSerializableType serializedType,
                      Class<T> runtimeType,
                      Function<String,T> f,
                      Function<T,String> f0)

Method Detail

derive

public <U> EnumConfigType<U> derive(Class<? super U> runtimeType,
                                    Function<T,U> partialDeserializer,
                                    Function<U,T> 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<T,String,EnumSerializableType>

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 EnumConfigType<T> withType(EnumSerializableType 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<T,String,EnumSerializableType>

Parameters:

newSpec - The new type specification.

Returns:

A ConfigType with the new type specification.

See Also:

SerializableType.isAssignableFrom(SerializableType)

constrain

public EnumConfigType<T> 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<T,String,EnumSerializableType>

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.

withValues

public EnumConfigType<T> withValues(Set<? extends T> values)

Returns a new EnumConfigType that represents the given set of values. The values are converted to the serialized type String before being stored as the new type's constraints.

Parameters:

values - A Set of values of the runtime type whose serialized forms are the acceptable values.

Returns:

A new EnumConfigType with the provided constraint.

See Also:

withValues(Object[])

withValues

@SafeVarargs
public final EnumConfigType<T> withValues(T... values)

Returns a new EnumConfigType that represents the given set of values. The values are converted to the serialized type String before being stored as the new type's constraints.

Parameters:

values - A Set of values of the runtime type whose serialized forms are the acceptable values.

Returns:

A new EnumConfigType with the provided constraint.

See Also:

withValues(Set)