Class CollectionObjectSerializer

java.lang.Object

eu.cloudnetservice.driver.network.rpc.defaults.object.serializers.CollectionObjectSerializer

All Implemented Interfaces:

ObjectSerializer<Collection<?>>

public final class CollectionObjectSerializer
extends Object
implements ObjectSerializer<Collection<?>>

An object serializer which can read and write any type of collection to/from a buffer.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private final IntFunction<Collection<Object>>	collectionFactory

Constructor Summary

Constructors

Modifier	Constructor	Description
private	CollectionObjectSerializer(@NonNull IntFunction<Collection<Object>> collectionFactory)	Constructs a new collection object serializer instance.

Method Summary

Modifier and Type	Method	Description
static @NonNull CollectionObjectSerializer	of(@NonNull IntFunction<Collection<Object>> collectionFactory)	Constructs a new collection object serializer instance.
@Nullable Collection<?>	read(@NonNull DataBuf source, @NonNull Type type, @NonNull ObjectMapper caller)	Reads the object from the buffer.
void	write(DataBuf.Mutable dataBuf, @NonNull Collection<?> object, @NonNull Type type, @NonNull ObjectMapper caller)	Writes the given object into the given buffer for network transfer and later deserialization.

Methods inherited from class java.lang.Object

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

Methods inherited from interface eu.cloudnetservice.driver.network.rpc.object.ObjectSerializer

preReadCheckAccepts, preWriteCheckAccepts

Field Details

collectionFactory

private final IntFunction<Collection<Object>> collectionFactory

Constructor Details

CollectionObjectSerializer

private CollectionObjectSerializer(@NonNull
 @NonNull IntFunction<Collection<Object>> collectionFactory)

Constructs a new collection object serializer instance.

Parameters:

collectionFactory - the factory to create the underlying collection instance.

Throws:

NullPointerException - if the given factory is null.

Method Details

of

@NonNull
public static @NonNull CollectionObjectSerializer of(@NonNull
 @NonNull IntFunction<Collection<Object>> collectionFactory)

Constructs a new collection object serializer instance.

Parameters:

collectionFactory - the factory to create the collection instance, receiving the site as parameter.

Returns:

the collection factory instance.

Throws:

NullPointerException - if the given factory is null.

read

@Nullable
public @Nullable Collection<?> read(@NonNull
 @NonNull DataBuf source,
 @NonNull
 @NonNull Type type,
 @NonNull
 @NonNull ObjectMapper caller)

Reads the object from the buffer. This method should only read the content from the buffer which was written to it previously, never more as the given buffer is not a slice of the buffer representing the object being read. Although this method returns an object, the returned object must always match the given type during object construction. The object return type is just a helper, but the return value will be cast to the given type resulting in errors if provided with the wrong type of object.

Specified by:

read in interface ObjectSerializer<Collection<?>>

Parameters:

source - the buffer to read the object from.

type - the type of the object to read.

caller - the mapper to which this serializer is registered and from which the deserialize request call came.

Returns:

the deserialized object of the serializer type T, or null if not readable.

write

public void write(@NonNull
 DataBuf.Mutable dataBuf,
 @NonNull
 @NonNull Collection<?> object,
 @NonNull
 @NonNull Type type,
 @NonNull
 @NonNull ObjectMapper caller)

Writes the given object into the given buffer for network transfer and later deserialization.

Specified by:

write in interface ObjectSerializer<Collection<?>>

Parameters:

dataBuf - the buffer to write the data to.

object - the object to serialize.

type - the raw type of the object.

caller - the object mapper to which this serializer belongs and which requested the serialisation.