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

Class NumberConfigType<T>

java.lang.Object

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

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

Type Parameters:

T - The runtime type of the underlying BigDecimal value.

public final class NumberConfigType<T>
extends ConfigType<T,BigDecimal,DecimalSerializableType>

A ConfigType for numeric ranges.

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
NumberConfigType(DecimalSerializableType serializedType, Class<T> runtimeType, Function<BigDecimal,T> f, Function<T,BigDecimal> f0)

Method Summary

Modifier and Type	Method and Description
NumberConfigType<T>	constrain(ConstraintAnnotationProcessor<Annotation> processor, Annotation annotation, AnnotatedElement annotated) Applies the constraints defined by the given constraint annotation.
<U> NumberConfigType<U>	derive(Class<? super U> runtimeType, Function<T,U> partialDeserializer, Function<U,T> partialSerializer) Derive a ConfigType from this type object.
NumberConfigType<T>	withIncrement(T step) Returns a NumberConfigType with the given step.
NumberConfigType<T>	withMaximum(T max) Returns a NumberConfigType with the given maximum value.
NumberConfigType<T>	withMinimum(T min) Returns a NumberConfigType with the given minimum value.
NumberConfigType<T>	withType(DecimalSerializableType newSpec) Replace the current serialized type used for specification with the given serialized type.
NumberConfigType<T>	withValidRange(T min, T max, T step) Returns a NumberConfigType with the given range.

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

NumberConfigType

public NumberConfigType(DecimalSerializableType serializedType,
                        Class<T> runtimeType,
                        Function<BigDecimal,T> f,
                        Function<T,BigDecimal> f0)

Method Detail

derive

public <U> NumberConfigType<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,BigDecimal,DecimalSerializableType>

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 NumberConfigType<T> withType(DecimalSerializableType 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,BigDecimal,DecimalSerializableType>

Parameters:

newSpec - The new type specification.

Returns:

A ConfigType with the new type specification.

See Also:

SerializableType.isAssignableFrom(SerializableType)

constrain

public NumberConfigType<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,BigDecimal,DecimalSerializableType>

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.

withMinimum

public NumberConfigType<T> withMinimum(T min)

Returns a NumberConfigType with the given minimum value.

withMaximum

public NumberConfigType<T> withMaximum(T max)

Returns a NumberConfigType with the given maximum value.

withIncrement

public NumberConfigType<T> withIncrement(T step)

Returns a NumberConfigType with the given step.

withValidRange

public NumberConfigType<T> withValidRange(T min,
                                          T max,
                                          T step)

Returns a NumberConfigType with the given range.