com.linkedin.paldb.api

Interface Serializer<K>

Type Parameters:

K - class type

All Superinterfaces:

java.io.Serializable

public interface Serializer<K>
extends java.io.Serializable

Custom serializer for arbitrary Java classes.

Users should register serializers in the configuration:

 Configuration configuration = PalDB.newConfiguration();
 configuration.registerSerializer(new PointSerializer());
 

Method Summary

Modifier and Type	Method and Description
int	getWeight(K instance) Returns the estimate number of bytes used to hold instance in memory.
K	read(java.io.DataInput dataInput) Reads the data input and creates the instance.
void	write(java.io.DataOutput dataOutput, K input) Writes the instance input to the data output.

Method Detail

write

void write(java.io.DataOutput dataOutput,
           K input)
    throws java.io.IOException

Writes the instance input to the data output.

Parameters:

dataOutput - data output

input - instance

Throws:

java.io.IOException - if an io error occurs

read

K read(java.io.DataInput dataInput)
throws java.io.IOException

Reads the data input and creates the instance.

Parameters:

dataInput - data input

Returns:

new instance of type K.

Throws:

java.io.IOException - if an io error occurs

getWeight

int getWeight(K instance)

Returns the estimate number of bytes used to hold instance in memory.

This information is used by the cache so it can manages its memory usage.

Parameters:

instance - instance to get weight for

Returns:

the number of bytes the object uses in memory