Class DocumentObjectSerializer

java.lang.Object

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

All Implemented Interfaces:

ObjectSerializer<Document>

public final class DocumentObjectSerializer
extends Object
implements ObjectSerializer<Document>

An object serializer which can write and read a json document to/from the buffer.

Since:

4.0

Field Summary

Fields

Modifier and Type	Field	Description
private DocumentFactoryRegistry	documentFactoryRegistry

Constructor Summary

Constructors

Constructor	Description
DocumentObjectSerializer()

Method Summary

Modifier and Type	Method	Description
private @NonNull DocumentFactoryRegistry	documentFactoryRegistry()	Lazy initializes the document factory registry field if not done previously, returning the initialized field value.
@NonNull Object	read(@NonNull DataBuf source, @NonNull Type type, @NonNull ObjectMapper caller)	Reads the object from the buffer.
void	write(DataBuf.Mutable dataBuf, @NonNull Document 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

documentFactoryRegistry

private DocumentFactoryRegistry documentFactoryRegistry

Constructor Details

DocumentObjectSerializer

public DocumentObjectSerializer()

Method Details

read

@NonNull
public @NonNull Object 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<Document>

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 Document 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<Document>

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.

documentFactoryRegistry

@NonNull
private @NonNull DocumentFactoryRegistry documentFactoryRegistry()

Lazy initializes the document factory registry field if not done previously, returning the initialized field value. Note that the obtaining of the document factory cannot be done in the constructor due to it being called before all bindings were set up.

Returns:

the initialized document factory registry field.