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

Class RecordSerializableType

java.lang.Object

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

io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.ParameterizedSerializableType<Map<String,Object>>

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

public final class RecordSerializableType
extends ParameterizedSerializableType<Map<String,Object>>

The SerializableType for fixed heterogeneous records.

Constructor Summary

Constructors

Constructor and Description
RecordSerializableType(Map<String,SerializableType<?>> fields)

Method Summary

Modifier and Type	Method and Description
Map<String,Object>	cast(Object value) Casts an object to the type represented by this type.
<S> Map<String,Object>	deserializeValue(S elem, ValueSerializer<S,?> serializer) Deserializes a config primitive from a serialized form.
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.
Map<String,SerializableType<?>>	getFields()
ParameterizedType	getParameterizedType() The ParameterizedType used to represent values of this type.
int	hashCode()
<S> void	serialize(TypeSerializer<S> serializer, S target) Serializes this type to a persistent format using the given TypeSerializer.
<S> S	serializeValue(Map<String,Object> value, ValueSerializer<S,?> serializer) Serializes a config primitive to a serialized form.
String	toString()

Methods inherited from class io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.ParameterizedSerializableType

getGenericPlatformType

Methods inherited from class io.github.fablabsmc.fablabs.api.fiber.v1.schema.type.SerializableType

accepts, getErasedPlatformType, isAssignableFrom, test

Methods inherited from class java.lang.Object

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

Constructor Detail

RecordSerializableType

public RecordSerializableType(Map<String,SerializableType<?>> fields)

Method Detail

getFields

public Map<String,SerializableType<?>> getFields()

getParameterizedType

public ParameterizedType getParameterizedType()

Description copied from class: ParameterizedSerializableType

The ParameterizedType used to represent values of this type.

Specified by:

getParameterizedType in class ParameterizedSerializableType<Map<String,Object>>

cast

public Map<String,Object> cast(@Nonnull
                               Object value)

Description copied from class: SerializableType

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.

Specified by:

cast in class SerializableType<Map<String,Object>>

Parameters:

value - The value.

Returns:

The value, casted to the platform type.

serialize

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

Description copied from class: SerializableType

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

Specified by:

serialize in class SerializableType<Map<String,Object>>

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 <S> S serializeValue(Map<String,Object> value,
                            ValueSerializer<S,?> serializer)

Description copied from class: SerializableType

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

Specified by:

serializeValue in class SerializableType<Map<String,Object>>

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 <S> Map<String,Object> deserializeValue(S elem,
                                               ValueSerializer<S,?> serializer)
                                        throws ValueDeserializationException

Description copied from class: SerializableType

Deserializes a config primitive from a serialized form.

Specified by:

deserializeValue in class SerializableType<Map<String,Object>>

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 String toString()

Specified by:

toString in class SerializableType<Map<String,Object>>

equals

public boolean equals(Object o)

Description copied from class: SerializableType

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

Specified by:

equals in class SerializableType<Map<String,Object>>

hashCode

public int hashCode()

Specified by:

hashCode in class SerializableType<Map<String,Object>>