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

Class SerializableType<T>

java.lang.Object

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

Type Parameters:

T - the actual platform type used to store the serializable data

Direct Known Subclasses:

ParameterizedSerializableType, PlainSerializableType

public abstract class SerializableType<T>
extends Object

A data type that is convertible to a config primitive.

A SerializableType constrains the range of possible values through additional properties. This means that for each kind of SerializableType there may be an arbitrary amount of different sets of valid values, all being mapped to the same platform type. For example, Integer and Double are both represented as DecimalSerializableTypes and stored as BigDecimals, but with different constraints.

See Also:

ConfigType, BooleanSerializableType, EnumSerializableType, ListSerializableType, MapSerializableType, DecimalSerializableType, RecordSerializableType, StringSerializableType

Method Summary

Modifier and Type	Method and Description
boolean	accepts(T serializedValue) Returns whether this type's constraints accept the given value.
abstract T	cast(Object value) Casts an object to the type represented by this type.
abstract <S> T	deserializeValue(S elem, ValueSerializer<S,?> serializer) Deserializes a config primitive from a serialized form.
abstract boolean	equals(Object o) Two serialized types are equal if and only if they are of the same kind and both have the same constraints.
Class<? super T>	getErasedPlatformType() The (erased) Java platform type used to represent values of this type.
abstract Type	getGenericPlatformType() The generic Java platform type used to represent values of this type, with parameterized type information preserved.
abstract int	hashCode()
boolean	isAssignableFrom(SerializableType<?> type) Determines if the data type represented by this SerializableType object is either the same as, or is a more general description of, the data type represented by the specified type parameter.
abstract <S> void	serialize(TypeSerializer<S> serializer, S target) Serializes this type to a persistent format using the given TypeSerializer.
abstract <S> S	serializeValue(T value, ValueSerializer<S,?> serializer) Serializes a config primitive to a serialized form.
TypeCheckResult<T>	test(T serializedValue) Tests the given value against this type's constraints.
abstract String	toString()

Methods inherited from class java.lang.Object

clone, finalize, getClass, notify, notifyAll, wait, wait, wait

Method Detail

getErasedPlatformType

public Class<? super T> getErasedPlatformType()

The (erased) Java platform type used to represent values of this type.

getGenericPlatformType

public abstract Type getGenericPlatformType()

The generic Java platform type used to represent values of this type, with parameterized type information preserved.

cast

public abstract T cast(@Nonnull
                       Object value)

Casts an object to the type represented by this type.

This method does not check the value against this type's constraints. For parameterized types, this method may inspect the object and thus not run in constant time.

Parameters:

value - The value.

Returns:

The value, casted to the platform type.

Throws:

ClassCastException - If the value is not of the platform type.

isAssignableFrom

public final boolean isAssignableFrom(SerializableType<?> type)

Determines if the data type represented by this SerializableType object is either the same as, or is a more general description of, the data type represented by the specified type parameter.

Specifically, this checks whether every value assignable to type can also be assigned to this SerializableType.

forall x, type.accepts(x) => this.accepts(x)

Parameters:

type - the type to be checked

Returns:

true if properties of this type are assignable from values of type.

accepts

public final boolean accepts(T serializedValue)

Returns whether this type's constraints accept the given value.

See Also:

test(Object)

test

public final TypeCheckResult<T> test(T serializedValue)

Tests the given value against this type's constraints.

See Also:

accepts(Object), TypeCheckResult

serialize

public abstract <S> void serialize(TypeSerializer<S> serializer,
                                   S target)

Serializes this type to a persistent format using the given TypeSerializer.

Type Parameters:

S - The type to serialize to.

Parameters:

serializer - The type serializer to use.

target - The place to which this type is serialized.

See Also:

TypeSerializer

serializeValue

public abstract <S> S serializeValue(T value,
                                     ValueSerializer<S,?> serializer)

Serializes a config primitive to a serialized form. The value given must be compatible with the platform type as given by cast(Object) and additionally satisfy this type's particular constraints.

Type Parameters:

S - The type of the serialized form.

Parameters:

value - The value to serialize.

serializer - A ValueSerializer defining the serialized form.

Returns:

The serialized form of value.

deserializeValue

public abstract <S> T deserializeValue(S elem,
                                       ValueSerializer<S,?> serializer)
                                throws ValueDeserializationException

Deserializes a config primitive from a serialized form.

Type Parameters:

S - The type of the serialized form.

Parameters:

elem - The serialized form of the value.

serializer - A ValueSerializer defining the serialized form.

Returns:

The deserialized value.

Throws:

ValueDeserializationException - If a value cannot be deserialized.

toString

public abstract String toString()

Overrides:

toString in class Object

equals

public abstract boolean equals(Object o)

Two serialized types are equal if and only if they are of the same kind and both have the same constraints.

Overrides:

equals in class Object

hashCode

public abstract int hashCode()

Overrides:

hashCode in class Object